Skip to content

Commit 7e3c902

Browse files
committed
更新README
1 parent 9af33f9 commit 7e3c902

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,19 @@ const windowParams = {
124124
enhanceWindow(document.querySelector('.demo-window'), windowParams);
125125
```
126126

127-
## Ready for More?
128-
At this point, you already install `vue-directive-window` and create a Hello World case. If you are interested in `vue-directive-window` and want to know more about it, you may refer to chapter [examples](/examples.md) and [params](/params.md).
127+
# Parameters
128+
129+
Parameter | Description | Type | Accepted Values | Default
130+
---|---|---|---|---
131+
minWidth | window's minimum width(px) | Number | —— | 100
132+
maxWidth | window's maximum width(px) | Number | —— | ——
133+
minHeight | window's minimum height(px) | Number | —— | 100
134+
maxHeight | window's maximum height(px) | Number | —— | ——
135+
movable | is drag feature available | Boolean | —— | true
136+
resizable | is resize feature available; when it is `true`, it means you could resize the window from every eight directions; when it is an Array value which contain String value, like `['left', 'left-top']` you could resize the window only from targeted directions. | Boolean / Array | `left-top`/`left-bottom`/`left`/`right-top`/`right-bottom`/`right`/`top`/`bottom` | true
137+
customMoveHandler | custom drag handler. When it is `null`, you could move the window by dragging every inch of this window. Otherwise, when it is a String value, `vue-directive-window` will use `document.querySelector(customMoveHandler)` to get the handler's Element; in that case, you could move the window only by dragging the handler. | String / Element | —— | ——
138+
customMaximizeHandler | maximize feature's handler. When it is a String value, `vue-directive-window` will use `document.querySelector(customMoveHandler)` to get the handler. | String / Element | —— | ——
139+
maximizeCallback | window maximizeCallback function; there is one parameter, which means if it is current maximize(Boolean) | Function | —— | ——
129140

130141
## Author
131142

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vue-directive-window",
3-
"version": "0.7.1",
3+
"version": "0.7.2",
44
"description": "Vue.js directive that enhance your Modal Window, support drag, resize and maximize.",
55
"author": "Array Huang",
66
"license": "MIT",

0 commit comments

Comments
 (0)