Skip to content

Commit e36cd9b

Browse files
committed
update docs
1 parent a575ca1 commit e36cd9b

File tree

2 files changed

+27
-6
lines changed

2 files changed

+27
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -300,15 +300,15 @@ toggle modal by name.
300300
301301
### `@before-open`
302302

303-
- Emits while modal is still invisible, but before transition starting.
303+
- Emits while modal is still invisible, but before transition starting. Further opening of the modal can be blocked from this event listener by calling `event.stop()` .
304304

305305
### `@opened`
306306

307307
- Emits after modal became visible and transition ended.
308308

309309
### `@before-close`
310310

311-
- Emits before modal is going to be closed.
311+
- Emits before modal is going to be closed. Further closing of the modal can be blocked from this event listener by calling `event.stop()` .
312312

313313
### `@closed`
314314

docs/content/en/index.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Introduction
33
description: 'Vue Final Modal is a renderless, stackable, detachable and lightweight modal component.'
44
position: 0
55
category: Getting Start
6-
version: 0.19
6+
version: 0.20
77
features:
88
- Support Vue 3 and Vue 2
99
- Tailwind CSS friendly
@@ -489,20 +489,41 @@ If prop `clickToClose` is `false`, the event will still be emitted.
489489

490490
### `@before-open`
491491

492-
- Emits while modal is still invisible, but before transition starting.
492+
- Emits while modal is still invisible, but before transition starting. Further opening of the modal can be blocked from this event listener by calling `event.stop()` .
493493

494494
### `@opened`
495495

496496
- Emits after modal became visible and transition ended.
497497

498498
### `@before-close`
499499

500-
- Emits before modal is going to be closed.
500+
- Emits before modal is going to be closed. Further closing of the modal can be blocked from this event listener by calling `event.stop()` .
501+
502+
#
501503

502504
### `@closed`
503505

504506
- Emits right before modal is destroyed.
505507

506508
## Contribution
507509

508-
👋 Hi I'm Hunter. Author of `vue-final-modal`. There is no perfect library even the `final` of vue modal. 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).
510+
👋 Hi I'm Hunter, the author of `vue-final-modal`.
511+
512+
To develop vue-final-modal, I learn a lot from these awesome libraries:
513+
514+
- [Vuetify](https://vuetifyjs.com/en/)
515+
- attach
516+
- [Element UI](https://element.eleme.io/)
517+
- stackable modal
518+
- zIndex
519+
- zIndexBase
520+
- [vue-js-modal](https://github.com/euvl/vue-js-modal)
521+
- dynamic modal
522+
- transition
523+
- focusTrap for A11y
524+
- [Bootstrap Vue](https://bootstrap-vue.org/)
525+
- lockScroll
526+
527+
> There is no perfect library even the `final` of vue modal.
528+
529+
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

Comments
 (0)