mirror of
https://github.com/KevinMidboe/vue-js-modal.git
synced 2025-10-29 18:00:20 +00:00
66 lines
2.4 KiB
Markdown
66 lines
2.4 KiB
Markdown
<h1>Vue.js modal</h1>
|
|
|
|
<h5>Simple to use vue.js modal plgin without any external dependencies</h5>
|
|
|
|
p.s. if you find any bugs, have any suggestions or just want to discuss Trump's policies, feel free to create an issue :D
|
|
|
|
<h3>How to use</h3>
|
|
|
|
Include plugin in your main.js file.
|
|
```javsacript
|
|
import 'vue-js-modal';
|
|
```
|
|
|
|
Create modal
|
|
```html
|
|
<modal name="hello-world">
|
|
hello, world!
|
|
</modal>
|
|
```
|
|
Call it from anywhere in the app
|
|
```javascript
|
|
methods: {
|
|
show() {
|
|
this.$modal.show('hello-word');
|
|
},
|
|
hide () {
|
|
this.$modal.hide('hello-world');
|
|
}
|
|
}
|
|
```
|
|
|
|
<h3>Properties</h3>
|
|
|
|
| Name | Required | Type | Default | Description |
|
|
| --- | --- | --- | --- | --- |
|
|
| name | true | [String, Number] | | Name of the modal |
|
|
| delay | false | Number | 0 | Delay between showing overlay and actual modal box |
|
|
| resizable | false | Boolean | false | If true, allows to resize modal window, keeping it in the center of the screen. |
|
|
| adaptive | false | Boolean | false | If true, modal box will try to adapt to the window size |
|
|
| transition| false | String | | Transition name |
|
|
| classes | false | [String, Array] | 'nice-modal'| Classes that will eb applied to the actual modal box, if specified not specified, the default 'nice-modal' class will eb applied |
|
|
| width | false | Number | 600 | |
|
|
| height | false | Number | 300 | |
|
|
| minWidth | false | Number | 0 | The minimum width to which modal can be resized |
|
|
| minHeight | false | Number | 0 | The minimum height to which modal can be resized |
|
|
|
|
<h3>Events</h3>
|
|
|
|
| Name | Description |
|
|
| --- | --- |
|
|
| before-open | Emits while modal is still invisible, but was added to the DOM |
|
|
| open | Emits after modal became visible or started transition |
|
|
| before-close | Emits before modal is going to be closed. Can be stopped from the event listener calling `event.stop()` (example: you are creating a text editor, and want to stop closisng and ask user to correct mistakes if text is not valid)
|
|
| close | Emits right before modal is destoyed |
|
|
|
|
<h3>Screenshots</h3>
|
|
|
|
|
|
|
|
|
|
Example:
|
|
```
|
|
npm run examples
|
|
```
|
|
Will be served at http://localhost:8000/examples
|