mirror of
https://github.com/KevinMidboe/vue-js-modal.git
synced 2025-12-08 20:48:46 +00:00
Update README.md
This commit is contained in:
30
README.md
30
README.md
@@ -1,8 +1,8 @@
|
||||
##Vue.js modal
|
||||
<h1>Vue.js modal</h1>
|
||||
|
||||
####Simple to use vue.js modal
|
||||
<h5>Simple to use vue.js modal plgin without any external dependencies</h5>
|
||||
|
||||
####Install:
|
||||
<h3>How to:</h3>
|
||||
|
||||
Include plugin in your main.js file.
|
||||
```javsacript
|
||||
@@ -18,15 +18,29 @@ Create modal
|
||||
Call it from anywhere in the app
|
||||
```javascript
|
||||
methods: {
|
||||
this.$modal.show('hello-word');
|
||||
show() {
|
||||
this.$modal.show('hello-word');
|
||||
},
|
||||
hide () {
|
||||
this.$modal.hide('hello-world');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
####Props:
|
||||
<h3>Properties</h3>
|
||||
|
||||
//todo
|
||||
|
||||
####Screenshot:
|
||||
| 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 |
|
||||
|
||||

|
||||
|
||||
|
||||
Reference in New Issue
Block a user