Package Exports
- vue-js-modal
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-js-modal) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Vue.js 2.0+ modal
Simple to use, highly customizable, mobile friendly Vue.js 2.0+ modal. http://vue-js-modal.yev.io/
Demo: http://vue-js-modal.yev.io/
How to use
Include plugin in your main.js file.
import vmodal from 'vue-js-modal'
Vue.use(vmodal)
Create modal
<modal name="hello-world">
hello, world!
</modal>
Call it from anywhere in the app
methods: {
show () {
this.$modal.show('hello-word');
},
hide () {
this.$modal.hide('hello-world');
}
}
Properties
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 |
pivotX | false | Number (0 - 1.0) | 0.5 | Horizontal position in %, default is 0.5 (meaning that modal box will be in the middle (50% from top) of the window |
pivotY | false | Number (0 - 1.0) | 0.5 |
Events
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 |
Screenshots
Example:
cd demo
npm run dev