From cc4c68dc2b2697f7f93b29be563510cad2c9dd3b Mon Sep 17 00:00:00 2001 From: neverland Date: Wed, 8 Apr 2020 15:35:47 +0800 Subject: [PATCH] docs(ActionSheet): add v-model api (#6017) --- src/action-sheet/README.md | 1 + src/action-sheet/README.zh-CN.md | 23 ++++++++++++++--------- src/popup/README.md | 2 +- src/popup/README.zh-CN.md | 2 +- 4 files changed, 17 insertions(+), 11 deletions(-) diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index 4fe07bb59..fea2e5457 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -123,6 +123,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| +| v-model (value) | Whether to show ActionSheet | *boolean* | `false` | | actions | Options | *Action[]* | `[]` | | title | Title | *string* | - | | cancel-text | Text of cancel button | *string* | - | diff --git a/src/action-sheet/README.zh-CN.md b/src/action-sheet/README.zh-CN.md index d22ea5778..4dec8b5f0 100644 --- a/src/action-sheet/README.zh-CN.md +++ b/src/action-sheet/README.zh-CN.md @@ -1,4 +1,8 @@ -# ActionSheet 上拉菜单 +# ActionSheet 动作面板 + +### 介绍 + +底部弹起的模态面板，包含与当前情境相关的多个选项。 ### 引入 @@ -46,7 +50,7 @@ export default { ### 展示取消按钮 -设置`cancel-text`属性后，会在底部展示取消按钮，点击后关闭当前菜单 +设置`cancel-text`属性后，会在底部展示取消按钮，点击后关闭当前面板 ```html @@ -137,7 +141,8 @@ export default { | 参数 | 说明 | 类型 | 默认值 | |------|------|------|------| -| actions | 菜单选项 | *Action[]* | `[]` | +| v-model (value) | 是否显示动作面板 | *boolean* | `false` | +| actions | 面板选项列表 | *Action[]* | `[]` | | title | 顶部标题 | *string* | - | | cancel-text | 取消按钮文字 | *string* | - | | description `v2.2.8` | 选项上方的描述信息 | *string* | - | @@ -172,14 +177,14 @@ export default { |------|------|------| | select | 选中选项时触发，禁用或加载状态下不会触发 | *action: Action, index: number* | | cancel | 取消按钮点击时触发 | - | -| open | 打开菜单时触发 | - | -| close | 关闭菜单时触发 | - | -| opened | 打开菜单且动画结束后触发 | - | -| closed | 关闭菜单且动画结束后触发 | - | +| open | 打开面板时触发 | - | +| close | 关闭面板时触发 | - | +| opened | 打开面板且动画结束后触发 | - | +| closed | 关闭面板且动画结束后触发 | - | | click-overlay | 点击遮罩层时触发 | - | ## 常见问题 ### 引入时提示 dependencies not found？ -在 1.x 版本中，上拉菜单的组件名为`Actionsheet`，从 2.0 版本开始更名为`ActionSheet`，请注意区分。 +在 1.x 版本中，动作面板的组件名为`Actionsheet`，从 2.0 版本开始更名为`ActionSheet`，请注意区分。 diff --git a/src/popup/README.md b/src/popup/README.md index cac0c6836..daa76e468 100644 --- a/src/popup/README.md +++ b/src/popup/README.md @@ -117,7 +117,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| v-model | Whether to show popup | *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* | - | diff --git a/src/popup/README.zh-CN.md b/src/popup/README.zh-CN.md index 75194775c..cc66b42dc 100644 --- a/src/popup/README.zh-CN.md +++ b/src/popup/README.zh-CN.md @@ -128,7 +128,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | |------|------|------|------| -| v-model | 当前组件是否显示 | *boolean* | `false` | +| v-model (value) | 是否显示弹出层 | *boolean* | `false` | | overlay | 是否显示遮罩层 | *boolean* | `true` | | position | 弹出位置，可选值为 `top` `bottom` `right` `left` | *string* | `center` | | overlay-class | 自定义遮罩层类名 | *string* | - |