You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -36,9 +36,9 @@ Looking for a Vue 3 version? [It's over here](https://github.com/hunterliu1003/v
36
36
37
37
You can create a [higher-order component](https://vue-final-modal.org/examples/recommended-use) easily and can customize `template`, `script` and `style` based on your needs.
Configuration options can be passed as a second argument to `Vue.use`.
167
-
168
-
```js
169
-
importVueFinalModalfrom'vue-final-modal'
170
-
171
-
Vue.use(VueFinalModal(), { ... })
172
-
```
173
-
174
-
-`componentName`
175
-
-`key`
176
-
-`dynamicContainerName`
177
-
178
-
## **API**
179
-
180
-
- In Options API:
181
-
182
-
Plugin API can be called within any component through `this.$vfm`.
183
-
184
-
- In Composition API (Vue 3 only):
185
-
186
-
```js
187
-
import { inject } from'vue'
188
-
189
-
exportdefault {
190
-
setup() {
191
-
const$vfm=inject('$vfm')
192
-
}
193
-
}
194
-
```
195
-
196
-
-`$vfm.show(name, params)`
197
-
-`$vfm.hide([names])`
198
-
-`$vfm.hideAll()`
199
-
-`$vfm.toggle(name, show, params)`
200
-
-`$vfm.get([names])`
201
-
-`$vfm.dynamicModals`
202
-
-`$vfm.openedModals`
203
-
-`$vfm.modals`
204
-
205
-
## **Props**
206
-
207
-
-`value`
208
-
-`name`
209
-
-`ssr`
210
-
-`classes`
211
-
-`overlayClass`
212
-
-`contentClass`
213
-
-`styles`
214
-
-`overlayStyle`
215
-
-`contentStyle`
216
-
-`lockScroll`
217
-
-`hideOverlay`
218
-
-`clickToClose`
219
-
-`escToClose`
220
-
-`preventClick`
221
-
-`attach`
222
-
-`transition`
223
-
-`overlayTransition`
224
-
-`zIndexAuto`
225
-
-`zIndexBase`
226
-
-`zIndex`
227
-
-`focusRetain`
228
-
-`focusTrap`
229
-
230
-
## **Events**
231
-
232
-
-`@click-outside`
233
-
-`@before-open`
234
-
-`@opened`
235
-
-`@before-close`
236
-
-`@closed`
237
-
238
-
## **Slots**
239
-
240
-
If you open a modal though API `show(name, params)`, You can use scoped-slot to get `params` in template:
241
-
242
-
```html
243
-
<templatev-slot="{ params }">
244
-
<!-- modal content -->
245
-
</template>
246
-
```
247
-
248
-
Or get `params` on `@beforeOpen` event:
249
-
250
-
```html
251
-
<vue-final-modal@beforeOpen="e => e.ref.params">
252
-
<!-- modal content -->
253
-
</vue-final-modal>
254
-
```
80
+
## **Contribution**
255
81
256
-
> `parmas` will be reset to `{}` automatically after `closed` event. You can avoid the modal to reset the `params`to empty object by calling `event.stop()`.
82
+
Thank you to all the people who already contributed to `vue-final-modal`!
Made with [contributors-img](https://contrib.rocks).
261
89
262
-
To develop vue-final-modal, I learn a lot from these awesome libraries:
90
+
To develop `vue-final-modal`, I learn a lot from these awesome libraries:
263
91
264
92
-[Vuetify](https://vuetifyjs.com/en/)
265
93
- attach
@@ -276,4 +104,4 @@ To develop vue-final-modal, I learn a lot from these awesome libraries:
276
104
277
105
> There is no perfect library even the `final` of vue modal.
278
106
279
-
If you have any ideas for optimization of `vue-final-modal`, feel free to open [issues](https://github.com/hunterliu1003/vue-final-modal/issues) or [pull requests](https://github.com/hunterliu1003/vue-final-modal/pulls).
107
+
🚀 If you have any ideas for optimization of `vue-final-modal`, feel free to open [issues](https://github.com/hunterliu1003/vue-final-modal/issues) or [pull requests](https://github.com/hunterliu1003/vue-final-modal/pulls).
0 commit comments