alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:17:33 +08:00
committed by neverland
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/popup/README.md
+35 -44
View File
@@ -22,15 +22,15 @@ Vue.use(Popup);
export default {
data() {
return {
show: false
}
show: false,
};
},
methods: {
showPopup() {
this.show = true;
}
}
},
},
};
```
@@ -39,11 +39,7 @@ export default {
Use `position` prop to set popup display position
```html
<van-popup
v-model="show"
position="top"
:style="{ height: '30%' }"
/>
<van-popup v-model="show" position="top" :style="{ height: '30%' }" />
```
### Close Icon
@@ -76,12 +72,7 @@ Use `position` prop to set popup display position
### Round Corner
```html
<van-popup
v-model="show"
round
position="bottom"
:style="{ height: '30%' }"
/>
<van-popup v-model="show" round position="bottom" :style="{ height: '30%' }" />
```
### Get Container
@@ -104,9 +95,9 @@ export default {
methods: {
getContainer() {
return document.querySelector('.my-container');
}
}
}
},
},
};
```
> Tips: The get-container prop cannot be used on the root node
@@ -116,32 +107,32 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model (value) | Whether to show popup | *boolean* | `false` |
| overlay | Whether to show overlay | *boolean* | `true` |
| position | Can be set to `top` `bottom` `right` `left` | *string* | `center` |
| overlay-class | Custom overlay class | *string* | - |
| overlay-style | Custom overlay style | *object* | - |
| duration | Transition duration, unit second | *number \| string* | `0.3` |
| round `v2.0.7` | Whether to show round corner | *boolean* | `false` |
| lock-scroll | Whether to lock background scroll | *boolean* | `true` |
| lazy-render | Whether to lazy render util appeared | *boolean* | `true` |
| close-on-popstate `v2.2.10` | Whether to close when popstate | *boolean* | `false` |
| close-on-click-overlay | Whether to close when click overlay | *boolean* | `true` |
| closeable `v2.2.0` | Whether to show close icon | *boolean* | `false` |
| close-icon `v2.2.0` | Close icon name | *string* | `cross` |
| close-icon-position `v2.2.2` | Close Icon Position，can be set to `top-left` `bottom-left` `bottom-right` | *string* | `top-right` |
| transition | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | *string* | - |
| get-container | Return the mount node for Popup | *string \| () => Element* | - |
| safe-area-inset-bottom `v2.2.1` | Whether to enable bottom safe area adaptation | *boolean* | `false` |
| --- | --- | --- | --- |
| v-model (value) | Whether to show popup | _boolean_ | `false` |
| overlay | Whether to show overlay | _boolean_ | `true` |
| position | Can be set to `top` `bottom` `right` `left` | _string_ | `center` |
| overlay-class | Custom overlay class | _string_ | - |
| overlay-style | Custom overlay style | _object_ | - |
| duration | Transition duration, unit second | _number \| string_ | `0.3` |
| round `v2.0.7` | Whether to show round corner | _boolean_ | `false` |
| lock-scroll | Whether to lock background scroll | _boolean_ | `true` |
| lazy-render | Whether to lazy render util appeared | _boolean_ | `true` |
| close-on-popstate `v2.2.10` | Whether to close when popstate | _boolean_ | `false` |
| close-on-click-overlay | Whether to close when click overlay | _boolean_ | `true` |
| closeable `v2.2.0` | Whether to show close icon | _boolean_ | `false` |
| close-icon `v2.2.0` | Close icon name | _string_ | `cross` |
| close-icon-position `v2.2.2` | Close Icon Position，can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| transition | Transition, equivalent to `name` prop of [transtion](https://vuejs.org/v2/api/#transition) | _string_ | - |
| get-container | Return the mount node for Popup | _string \| () => Element_ | - |
| safe-area-inset-bottom `v2.2.1` | Whether to enable bottom safe area adaptation | _boolean_ | `false` |
### Events
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when click Popup | *event: Event* |
| open | Triggered when open Popup | - |
| close | Triggered when close Popup | - |
| opened | Triggered when opened Popup | - |
| closed | Triggered when closed Popup | - |
| click-overlay | Triggered when click overlay | - |
| Event | Description | Arguments |
| ------------- | ---------------------------- | -------------- |
| click | Triggered when click Popup | _event: Event_ |
| open | Triggered when open Popup | - |
| close | Triggered when close Popup | - |
| opened | Triggered when opened Popup | - |
| closed | Triggered when closed Popup | - |
| click-overlay | Triggered when click overlay | - |
src/popup/README.zh-CN.md
+35 -44
View File
@@ -28,15 +28,15 @@ Vue.use(Popup);
export default {
data() {
return {
show: false
}
show: false,
};
},
methods: {
showPopup() {
this.show = true;
}
}
},
},
};
```
@@ -45,11 +45,7 @@ export default {
通过`position`属性设置弹出位置，默认居中弹出，可以设置为`top`、`bottom`、`left`、`right`
```html
<van-popup
v-model="show"
position="top"
:style="{ height: '30%' }"
/>
<van-popup v-model="show" position="top" :style="{ height: '30%' }" />
```
### 关闭图标
@@ -86,12 +82,7 @@ export default {
设置`round`属性后，弹窗会根据弹出位置添加不同的圆角样式
```html
<van-popup
v-model="show"
round
position="bottom"
:style="{ height: '30%' }"
/>
<van-popup v-model="show" round position="bottom" :style="{ height: '30%' }" />
```
### 指定挂载位置
@@ -115,9 +106,9 @@ export default {
// 返回一个特定的 DOM 节点，作为挂载的父节点
getContainer() {
return document.querySelector('.my-container');
}
}
}
},
},
};
```
> 注意：使用 get-container 属性的组件不能为根节点
@@ -127,32 +118,32 @@ export default {
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model (value) | 是否显示弹出层 | *boolean* | `false` |
| overlay | 是否显示遮罩层 | *boolean* | `true` |
| position | 弹出位置，可选值为 `top` `bottom` `right` `left` | *string* | `center` |
| overlay-class | 自定义遮罩层类名 | *string* | - |
| overlay-style | 自定义遮罩层样式 | *object* | - |
| duration | 动画时长，单位秒 | *number \| string* | `0.3` |
| round `v2.0.7` | 是否显示圆角 | *boolean* | `false` |
| lock-scroll | 是否锁定背景滚动 | *boolean* | `true` |
| lazy-render | 是否在显示弹层时才渲染节点 | *boolean* | `true` |
| close-on-popstate `v2.2.10` | 是否在页面回退时自动关闭 | *boolean* | `false` |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` |
| closeable `v2.2.0` | 是否显示关闭图标 | *boolean* | `false` |
| close-icon `v2.2.0` | 关闭图标名称或图片链接 | *string* | `cross` |
| close-icon-position `v2.2.2` | 关闭图标位置，可选值为`top-left`<br>`bottom-left` `bottom-right` | *string* | `top-right` |
| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | *string* | - |
| get-container | 指定挂载的节点 | *string \| () => Element* | - |
| safe-area-inset-bottom `v2.2.1` | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | *boolean* | `false` |
| --- | --- | --- | --- |
| v-model (value) | 是否显示弹出层 | _boolean_ | `false` |
| overlay | 是否显示遮罩层 | _boolean_ | `true` |
| position | 弹出位置，可选值为 `top` `bottom` `right` `left` | _string_ | `center` |
| overlay-class | 自定义遮罩层类名 | _string_ | - |
| overlay-style | 自定义遮罩层样式 | _object_ | - |
| duration | 动画时长，单位秒 | _number \| string_ | `0.3` |
| round `v2.0.7` | 是否显示圆角 | _boolean_ | `false` |
| lock-scroll | 是否锁定背景滚动 | _boolean_ | `true` |
| lazy-render | 是否在显示弹层时才渲染节点 | _boolean_ | `true` |
| close-on-popstate `v2.2.10` | 是否在页面回退时自动关闭 | _boolean_ | `false` |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | _boolean_ | `true` |
| closeable `v2.2.0` | 是否显示关闭图标 | _boolean_ | `false` |
| close-icon `v2.2.0` | 关闭图标名称或图片链接 | _string_ | `cross` |
| close-icon-position `v2.2.2` | 关闭图标位置，可选值为`top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| transition | 动画类名，等价于 [transtion](https://cn.vuejs.org/v2/api/index.html#transition) 的`name`属性 | _string_ | - |
| get-container | 指定挂载的节点 | _string \| () => Element_ | - |
| safe-area-inset-bottom `v2.2.1` | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | _boolean_ | `false` |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击弹出层时触发 | *event: Event* |
| open | 打开弹出层时触发 | - |
| close | 关闭弹出层时触发 | - |
| opened | 打开弹出层且动画结束后触发 | - |
| closed | 关闭弹出层且动画结束后触发 | - |
| click-overlay | 点击遮罩层时触发 | - |
| 事件名 | 说明 | 回调参数 |
| ------------- | -------------------------- | -------------- |
| click | 点击弹出层时触发 | _event: Event_ |
| open | 打开弹出层时触发 | - |
| close | 关闭弹出层时触发 | - |
| opened | 打开弹出层且动画结束后触发 | - |
| closed | 关闭弹出层且动画结束后触发 | - |
| click-overlay | 点击遮罩层时触发 | - |