mirror of
https://github.com/KevinMidboe/vue-js-modal.git
synced 2025-10-29 18:00:20 +00:00
253 lines
6.6 KiB
Markdown
253 lines
6.6 KiB
Markdown
[](https://badge.fury.io/js/vue-js-modal)
|
||
[]()
|
||
|
||
# Vue.js modal
|
||
|
||
##### Simple to use, highly customizable, mobile friendly Vue.js 2.0+ modal. http://vue-js-modal.yev.io/
|
||
##### (now works with SSR)
|
||
<p align="center">
|
||
<img src="https://media.giphy.com/media/3oKIPco1eNxAA1rD4Q/giphy.gif">
|
||
</p>
|
||
|
||
Demo: http://vue-js-modal.yev.io/
|
||
|
||
### Install
|
||
|
||
```bash
|
||
npm install vue-js-modal --save
|
||
```
|
||
|
||
### How to use
|
||
|
||
Include plugin in your `main.js` file.
|
||
|
||
```javascript
|
||
import vmodal from 'vue-js-modal'
|
||
|
||
Vue.use(vmodal)
|
||
```
|
||
|
||
Create modal:
|
||
|
||
```html
|
||
<modal name="hello-world">
|
||
hello, world!
|
||
</modal>
|
||
```
|
||
Call it from anywhere in the app:
|
||
|
||
```javascript
|
||
methods: {
|
||
show () {
|
||
this.$modal.show('hello-world');
|
||
},
|
||
hide () {
|
||
this.$modal.hide('hello-world');
|
||
}
|
||
}
|
||
```
|
||
|
||
### SSR
|
||
|
||
Include plugin in your `nuxt.config.js` file:
|
||
|
||
```javascript
|
||
module.exports = {
|
||
plugins: ['~plugins/vue-js-modal']
|
||
}
|
||
```
|
||
|
||
And your `plugins/vue-js-modal.js` will look like:
|
||
|
||
```javascript
|
||
import Vue from 'vue'
|
||
import VModal from 'vue-js-modal/dist/ssr.index'
|
||
|
||
Vue.use(VModal)
|
||
```
|
||
|
||
For full demo please look at `demo/server_side_rendering`
|
||
|
||
### 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 |
|
||
| draggable | false | [Boolean, String]| false | If true, modal box will be draggable. |
|
||
| scrollable | false | Boolean | false | If `height` property is `auto` and the modal height exceeds window height - you will be able to scroll modal |
|
||
| reset | false | Boolean | false | Resets position and size before showing modal |
|
||
| clickToClose | false | Boolean | true | If set to `false`, it will not be possible to close modal by clicking on the background |
|
||
| transition| false | String | | Transition name |
|
||
| classes | false | [String, Array] | 'vue--modal'| Classes that will be applied to the actual modal box, if not specified, the default 'vue--modal' class will be applied |
|
||
| width | false | [String, Number] | 600 | Width in pixels or percents (e.g. 50 or "50px", "50%") |
|
||
| height | false | [String, Number] | 300 | Height in pixels or percents (e.g. 50 or "50px", "50%") or `"auto"` |
|
||
| 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 | Vertical position in %, default is 0.5 (meaning that modal box will be in the middle (50% from left) of the window |
|
||
|
||
### Events
|
||
|
||
| Name | Description |
|
||
| --- | --- |
|
||
| before-open | Emits while modal is still invisible, but was added to the DOM |
|
||
| opened | 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)
|
||
| closed | Emits right before modal is destoyed |
|
||
|
||
Example:
|
||
```vue
|
||
<template>
|
||
<modal name="example"
|
||
:width="300"
|
||
:height="300"
|
||
@before-open="beforeOpen"
|
||
@before-close="beforeClose">
|
||
<b>{{time}}</b>
|
||
</modal>
|
||
</template>
|
||
<script>
|
||
export default {
|
||
name: 'ExampleModal',
|
||
data () {
|
||
return {
|
||
time: 0,
|
||
duration: 5000
|
||
}
|
||
},
|
||
methods: {
|
||
beforeOpen (event) {
|
||
console.log(event)
|
||
// Set the opening time of the modal
|
||
this.time = Date.now()
|
||
},
|
||
beforeClose (event) {
|
||
console.log(event)
|
||
// If modal was open less then 5000 ms - prevent closing it
|
||
if (this.time + this.duration < Date.now()) {
|
||
event.stop()
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
|
||
This example, initializes `time` variable every time the modal is being opened.
|
||
And then forbits closing it for the next 5000 ms
|
||
|
||
### Other
|
||
|
||
#### Height: "auto"
|
||
|
||
From `v1.2.6` height can be set to "auto". If you want to be able to scroll modal in case it's height exceeds window height - you can set flag `scrollable="true"`.
|
||
|
||
p.s. `scrollable` will only work with `height="auto"`.
|
||
|
||
Example:
|
||
|
||
```vue
|
||
<modal name="foo" height="auto" :scrollable="true">...</modal>
|
||
```
|
||
|
||
Auto height:
|
||
|
||
<p align="center">
|
||
<img src="https://media.giphy.com/media/xUPGGpEV00RDDDeiuk/giphy.gif">
|
||
</p>
|
||
|
||
Scrollable content & auto height:
|
||
|
||
<p align="center">
|
||
<img src="https://media.giphy.com/media/xUn3CfwfH3ISuf4mxq/giphy.gif">
|
||
</p>
|
||
|
||
|
||
#### Close button
|
||
|
||
If you want to have a Close (x) button in the top-right corner, you can use "top-right" slot for it. There is deliberately no predefined Close button style - you will have to implement/use your own button.
|
||
|
||
Example:
|
||
```vue
|
||
<template>
|
||
<modal name="foo">
|
||
|
||
<div slot="top-right">
|
||
<button @click="$modal.hide('foo')">
|
||
❌
|
||
</button>
|
||
</div>
|
||
|
||
Hello, ☀️!
|
||
|
||
</modal>
|
||
</template>
|
||
```
|
||
|
||
|
||
#### Draggable handler
|
||
|
||
Draggable property can accept not only `Boolean` but also `String` paramenters. With `String` value, you can specify a CSS selector to the element which will be a "handler" for dragging.
|
||
|
||
Example:
|
||
|
||
```vue
|
||
<modal name="bar" draggable=".window-header">
|
||
<div class="window-header">DRAG ME HERE</div>
|
||
<div>
|
||
Hello, 🌎!
|
||
</div>
|
||
</modal>
|
||
```
|
||
|
||
#### Background color
|
||
|
||
If you want to change overflow background color, you can easily do it using css.
|
||
|
||
For all modals:
|
||
|
||
```css
|
||
.v--modal-overlay {
|
||
background: red;
|
||
}
|
||
```
|
||
|
||
For specific modal:
|
||
|
||
```css
|
||
.v--modal-overlay[data-modal="my_modal_name"] {
|
||
background: cyan;
|
||
}
|
||
```
|
||
|
||
#### Fullscreen
|
||
|
||
```vue
|
||
<modal name="fs" :adaptive="true" width="100%" height="100%">
|
||
</modal>
|
||
```
|
||
|
||
### Developers
|
||
|
||
To run an example:
|
||
```sh
|
||
# Clone repo
|
||
|
||
git clone https://github.com/euvl/vue-js-modal.git
|
||
|
||
# Build main library
|
||
|
||
cd vue-js-modal
|
||
npm install
|
||
npm run build
|
||
|
||
# Build and run demo
|
||
|
||
cd demo
|
||
npm install
|
||
npm run dev
|
||
```
|