[Doc] unify terminology of overlay

This commit is contained in:
陈嘉涵 2019-05-07 20:47:54 +08:00
parent 6832fd8640
commit 02bcc66414
7 changed files with 17 additions and 17 deletions

View File

@ -298,7 +298,7 @@
- 修复函数式组件未继承标签属性的问题 [\#2706](https://github.com/youzan/vant/pull/2706) - 修复函数式组件未继承标签属性的问题 [\#2706](https://github.com/youzan/vant/pull/2706)
- 修复 Swipe 内懒加载图片无法正确加载的问题 [\#2708](https://github.com/youzan/vant/pull/2708) - 修复 Swipe 内懒加载图片无法正确加载的问题 [\#2708](https://github.com/youzan/vant/pull/2708)
- 修复 Collpase 在特定情况下高度计算错误的问题 [\#2702](https://github.com/youzan/vant/pull/2702) - 修复 Collpase 在特定情况下高度计算错误的问题 [\#2702](https://github.com/youzan/vant/pull/2702)
- 修复 Dialog 点击层时无法触发 beforeClose 属性的问题 [\#2707](https://github.com/youzan/vant/pull/2707) - 修复 Dialog 点击遮罩层时无法触发 beforeClose 属性的问题 [\#2707](https://github.com/youzan/vant/pull/2707)
- 修复 AddressList 在禁用状态下样式错误的问题 [\#2687](https://github.com/youzan/vant/pull/2687) - 修复 AddressList 在禁用状态下样式错误的问题 [\#2687](https://github.com/youzan/vant/pull/2687)
- 修复 AddressEdit 在 Vue 2.6 版本下无法选择推荐地址的问题 [\#2689](https://github.com/youzan/vant/pull/2689) - 修复 AddressEdit 在 Vue 2.6 版本下无法选择推荐地址的问题 [\#2689](https://github.com/youzan/vant/pull/2689)
@ -1118,7 +1118,7 @@ PS: 不小心跳过了 1.4.6 版本 ^_^
**Bug Fixes** **Bug Fixes**
- 修复 Toast 使用 forbidClick 属性时导致其他弹层的层失效的问题 [\#1154](https://github.com/youzan/vant/pull/1154) - 修复 Toast 使用 forbidClick 属性时导致其他弹层的遮罩层失效的问题 [\#1154](https://github.com/youzan/vant/pull/1154)
- 修复 Field 在 safari 上不正确的 margin [\#1147](https://github.com/youzan/vant/pull/1147) - 修复 Field 在 safari 上不正确的 margin [\#1147](https://github.com/youzan/vant/pull/1147)
- 修复 Progress 文字超出边界的问题 [\#1135](https://github.com/youzan/vant/pull/1135) - 修复 Progress 文字超出边界的问题 [\#1135](https://github.com/youzan/vant/pull/1135)
@ -1314,7 +1314,7 @@ PS: 不小心跳过了 1.4.6 版本 ^_^
**Bug Fixes** **Bug Fixes**
- 修复 Tag 文字在部分安卓手机上未垂直居中的问题 [\#773](https://github.com/youzan/vant/pull/773) - 修复 Tag 文字在部分安卓手机上未垂直居中的问题 [\#773](https://github.com/youzan/vant/pull/773)
- 修复 Toast 层在某些情况下无法收起的问题 [\#762](https://github.com/youzan/vant/pull/762) - 修复 Toast 遮罩层在某些情况下无法收起的问题 [\#762](https://github.com/youzan/vant/pull/762)
## [v1.0.2](https://github.com/youzan/vant/tree/v1.0.2) ## [v1.0.2](https://github.com/youzan/vant/tree/v1.0.2)
`2018-03-22` `2018-03-22`
@ -1331,7 +1331,7 @@ PS: 不小心跳过了 1.4.6 版本 ^_^
* 修复 AddressEdit 初始化时省市区未正确选中的问题 [\#748](https://github.com/youzan/vant/pull/748) * 修复 AddressEdit 初始化时省市区未正确选中的问题 [\#748](https://github.com/youzan/vant/pull/748)
* 修复 List 隐藏时依然会触发 load 事件的问题 [\#751](https://github.com/youzan/vant/pull/751) * 修复 List 隐藏时依然会触发 load 事件的问题 [\#751](https://github.com/youzan/vant/pull/751)
* 修复 Sku 默认选中不生效的问题 [\#752](https://github.com/youzan/vant/pull/752) * 修复 Sku 默认选中不生效的问题 [\#752](https://github.com/youzan/vant/pull/752)
* 修复 Toast 层被其他元素遮挡的问题 [\#740](https://github.com/youzan/vant/pull/740) * 修复 Toast 遮罩层被其他元素遮挡的问题 [\#740](https://github.com/youzan/vant/pull/740)
* 修复 Tab 内容无法点击的问题 [\#749](https://github.com/youzan/vant/pull/749) * 修复 Tab 内容无法点击的问题 [\#749](https://github.com/youzan/vant/pull/749)

View File

@ -103,7 +103,7 @@ export default {
| cancel-text | 取消按钮文字 | `String` | - | - | | cancel-text | 取消按钮文字 | `String` | - | - |
| overlay | 是否显示遮罩层 | `Boolean` | `true` | - | | overlay | 是否显示遮罩层 | `Boolean` | `true` | - |
| close-on-click-action | 是否在点击选项后关闭 | `Boolean` | `false` | 2.0.0 | | close-on-click-action | 是否在点击选项后关闭 | `Boolean` | `false` | 2.0.0 |
| close-on-click-overlay | 是否在点击层后关闭 | `Boolean` | `true` | - | | close-on-click-overlay | 是否在点击遮罩层后关闭 | `Boolean` | `true` | - |
| lazy-render | 是否在显示弹层时才渲染节点 | `Boolean` | `true` | 1.1.11 | | lazy-render | 是否在显示弹层时才渲染节点 | `Boolean` | `true` | 1.1.11 |
| get-container | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `String | () => HTMLElement` | - | - | | get-container | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `String | () => HTMLElement` | - | - |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配,需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `Boolean` | `false` | 1.6.15 | | safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配,需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `Boolean` | `false` | 1.6.15 |

View File

@ -128,8 +128,8 @@ export default {
| cancelButtonColor | 取消按钮颜色 | `String` | `#000` | 1.6.14 | | cancelButtonColor | 取消按钮颜色 | `String` | `#000` | 1.6.14 |
| confirmButtonText | 确认按钮文案 | `String` | `确认` | - | | confirmButtonText | 确认按钮文案 | `String` | `确认` | - |
| confirmButtonColor | 确认按钮颜色 | `String` | `#1989fa` | 1.6.14 | | confirmButtonColor | 确认按钮颜色 | `String` | `#1989fa` | 1.6.14 |
| overlay | 是否展示层 | `Boolean` | `true` | - | | overlay | 是否展示遮罩层 | `Boolean` | `true` | - |
| closeOnClickOverlay | 点击层时是否关闭弹窗 | `Boolean` | `false` | - | | closeOnClickOverlay | 点击遮罩层时是否关闭弹窗 | `Boolean` | `false` | - |
| lockScroll | 是否锁定背景滚动 | `Boolean` | `true` | - | | lockScroll | 是否锁定背景滚动 | `Boolean` | `true` | - |
| beforeClose | 关闭前的回调函数,<br>调用 done() 后关闭弹窗,<br>调用 done(false) 阻止弹窗关闭 | `(action, done) => void` | - | 1.1.6 | | beforeClose | 关闭前的回调函数,<br>调用 done() 后关闭弹窗,<br>调用 done(false) 阻止弹窗关闭 | `(action, done) => void` | - | 1.1.6 |
| getContainer | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `String | () => HTMLElement` | `body` | 1.6.11 | | getContainer | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `String | () => HTMLElement` | `body` | 1.6.11 |
@ -150,8 +150,8 @@ export default {
| cancel-button-color | 取消按钮颜色 | `String` | `#000` | 1.6.14 | | cancel-button-color | 取消按钮颜色 | `String` | `#000` | 1.6.14 |
| confirm-button-text | 确认按钮文案 | `String` | `确认` | - | | confirm-button-text | 确认按钮文案 | `String` | `确认` | - |
| confirm-button-color | 确认按钮颜色 | `String` | `#1989fa` | 1.6.14 | | confirm-button-color | 确认按钮颜色 | `String` | `#1989fa` | 1.6.14 |
| overlay | 是否展示层 | `Boolean` | `true` | - | | overlay | 是否展示遮罩层 | `Boolean` | `true` | - |
| close-on-click-overlay | 是否在点击层后关闭 | `Boolean` | `false` | - | | close-on-click-overlay | 是否在点击遮罩层后关闭 | `Boolean` | `false` | - |
| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | - | | lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | - |
| before-close | 关闭前的回调函数,<br>调用 done() 后关闭弹窗,<br>调用 done(false) 阻止弹窗关闭 | `(action, done) => void` | - | 1.1.6 | | before-close | 关闭前的回调函数,<br>调用 done() 后关闭弹窗,<br>调用 done(false) 阻止弹窗关闭 | `(action, done) => void` | - | 1.1.6 |
| get-container | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `String | () => HTMLElement` | `body` | 1.1.6 | | get-container | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `String | () => HTMLElement` | `body` | 1.1.6 |

View File

@ -85,7 +85,7 @@ export default {
| active-color | 菜单标题和选项的选中态颜色 | `String` | `#1989fa` | - | | active-color | 菜单标题和选项的选中态颜色 | `String` | `#1989fa` | - |
| z-index | 菜单栏 z-index 层级 | `Number` | `10` | - | | z-index | 菜单栏 z-index 层级 | `Number` | `10` | - |
| overlay | 是否显示遮罩层 | `Boolean` | `true` | - | | overlay | 是否显示遮罩层 | `Boolean` | `true` | - |
| close-on-click-overlay | 是否在点击层后关闭菜单 | `Boolean` | `true` | - | | close-on-click-overlay | 是否在点击遮罩层后关闭菜单 | `Boolean` | `true` | - |
### DropdownItem Props ### DropdownItem Props

View File

@ -42,14 +42,14 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------| |------|------|------|------|------|
| v-model | 当前组件是否显示 | `Boolean` | `false` | - | | v-model | 当前组件是否显示 | `Boolean` | `false` | - |
| overlay | 是否显示层 | `Boolean` | `true` | - | | overlay | 是否显示遮罩层 | `Boolean` | `true` | - |
| position | 位置,可选值为 `top` `bottom` <br> `right` `left` | `String` | `center` | - | | position | 位置,可选值为 `top` `bottom` <br> `right` `left` | `String` | `center` | - |
| overlay-class | 自定义层类名 | `String` | - | - | | overlay-class | 自定义遮罩层类名 | `String` | - | - |
| overlay-style | 自定义层样式 | `Object` | - | - | | overlay-style | 自定义遮罩层样式 | `Object` | - | - |
| transition | 动画类名,用法与原生`transtion`组件的`name`属性一致 | `String` | - | - | | transition | 动画类名,用法与原生`transtion`组件的`name`属性一致 | `String` | - | - |
| duration | 动画时长,单位秒 | `Number` | `0.3` | 2.0.0 | | duration | 动画时长,单位秒 | `Number` | `0.3` | 2.0.0 |
| get-container | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `String | () => HTMLElement` | - | - | | get-container | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `String | () => HTMLElement` | - | - |
| close-on-click-overlay | 是否在点击层后关闭 | `Boolean` | `true` | - | | close-on-click-overlay | 是否在点击遮罩层后关闭 | `Boolean` | `true` | - |
| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | 1.0.0 | | lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | 1.0.0 |
| lazy-render | 是否在显示弹层时才渲染节点 | `Boolean` | `true` | 1.1.5 | | lazy-render | 是否在显示弹层时才渲染节点 | `Boolean` | `true` | 1.1.5 |
@ -62,4 +62,4 @@ export default {
| opened | 打开弹出层且动画结束后触发 | - | | opened | 打开弹出层且动画结束后触发 | - |
| close | 关闭弹出层时触发 | - | | close | 关闭弹出层时触发 | - |
| closed | 关闭弹出层且动画结束后触发 | - | | closed | 关闭弹出层且动画结束后触发 | - |
| click-overlay | 点击层时触发 | - | | click-overlay | 点击遮罩层时触发 | - |

View File

@ -113,7 +113,7 @@ Vue.use(Sku);
| reset-stepper-on-hide | 隐藏时重置选择的商品数量 | `Boolean` | `false` | - | | reset-stepper-on-hide | 隐藏时重置选择的商品数量 | `Boolean` | `false` | - |
| reset-selected-sku-on-hide | 隐藏时重置已选择的 sku | `Boolean` | `false` | - | | reset-selected-sku-on-hide | 隐藏时重置已选择的 sku | `Boolean` | `false` | - |
| disable-stepper-input | 是否禁用步进器输入 | `Boolean` | `false` | - | | disable-stepper-input | 是否禁用步进器输入 | `Boolean` | `false` | - |
| close-on-click-overlay | 是否在点击层后关闭 | `Boolean` | `false` | - | | close-on-click-overlay | 是否在点击遮罩层后关闭 | `Boolean` | `false` | - |
| stepper-title | 数量选择组件左侧文案 | `String` | `购买数量` | - | | stepper-title | 数量选择组件左侧文案 | `String` | `购买数量` | - |
| custom-stepper-config | 步进器相关自定义配置 | `Object` | `{}` | - | | custom-stepper-config | 步进器相关自定义配置 | `Object` | `{}` | - |
| message-config | 留言相关配置 | `Object` | `{}` | - | | message-config | 留言相关配置 | `Object` | `{}` | - |

View File

@ -98,7 +98,7 @@ toast2.clear();
| type | 提示类型,可选值为 `loading` `success`<br>`fail` `html` | `String` | `text` | - | | type | 提示类型,可选值为 `loading` `success`<br>`fail` `html` | `String` | `text` | - |
| position | 位置,可选值为 `top` `bottom` | `String` | `middle` | - | | position | 位置,可选值为 `top` `bottom` | `String` | `middle` | - |
| message | 文本内容,支持通过`\n`换行 | `String` | `''` | - | - | | message | 文本内容,支持通过`\n`换行 | `String` | `''` | - | - |
| mask | 是否显示背景层 | `Boolean` | `false` | - | | mask | 是否显示背景遮罩层 | `Boolean` | `false` | - |
| forbidClick | 是否禁止背景点击 | `Boolean` | `false` | - | | forbidClick | 是否禁止背景点击 | `Boolean` | `false` | - |
| loadingType | 加载图标类型, 可选值为 `spinner` | `String` | `circular` | 1.1.3 | | loadingType | 加载图标类型, 可选值为 `spinner` | `String` | `circular` | 1.1.3 |
| duration | 展示时长(ms),值为 0 时toast 不会消失 | `Number` | `3000` | - | | duration | 展示时长(ms),值为 0 时toast 不会消失 | `Number` | `3000` | - |