From e3341e6c68a2024810a5feb272d58d4f496443ac Mon Sep 17 00:00:00 2001 From: neverland Date: Thu, 17 Jun 2021 21:03:32 +0800 Subject: [PATCH] docs(Cascader): add Option description (#8880) --- src/cascader/README.md | 8 ++++++++ src/cascader/README.zh-CN.md | 10 ++++++++++ src/picker/README.md | 4 ++-- 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/src/cascader/README.md b/src/cascader/README.md index fca4c81d2..3dd5ad0d5 100644 --- a/src/cascader/README.md +++ b/src/cascader/README.md @@ -213,6 +213,14 @@ export default { | close-icon `v3.0.10` | Close icon name | _string_ | `cross` | | field-names `v3.0.4` | Custom the fields of options | _object_ | `{ text: 'text', value: 'value', children: 'children' }` | +### Data Structure of Option + +| Key | Description | Type | +| -------- | ---------------- | ------------------ | +| text | Option text | _string_ | +| value | Option value | _string \| number_ | +| children | Cascade children | _Option[]_ | + ### Events | Event | Description | Arguments | diff --git a/src/cascader/README.zh-CN.md b/src/cascader/README.zh-CN.md index fa4c4b08e..c873f4ef3 100644 --- a/src/cascader/README.zh-CN.md +++ b/src/cascader/README.zh-CN.md @@ -223,6 +223,16 @@ export default { | close-icon `v3.0.10` | 关闭[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `cross` | | field-names `v3.0.4` | 自定义 `options` 结构中的字段 | _object_ | `{ text: 'text', value: 'value', children: 'children' }` | +### Option 数据结构 + +`options` 属性是一个由对象构成的数组,数组中的每个对象配置一个可选项,对象可以包含以下值: + +| 键名 | 说明 | 类型 | +| -------- | ------------ | ------------------ | +| text | 选项文字 | _string_ | +| value | 选项对应的值 | _string \| number_ | +| children | 子选项列表 | _Option[]_ | + ### Events | 事件 | 说明 | 回调参数 | diff --git a/src/picker/README.md b/src/picker/README.md index 192c8b033..c95827dc1 100644 --- a/src/picker/README.md +++ b/src/picker/README.md @@ -72,11 +72,11 @@ export default { setup() { const columns = [ { - values: ['Monday', 'Tuesday', 'Wednesday', 'Thusday', 'Friday'], + values: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'], defaultIndex: 2, }, { - values: ['Morging', 'Afternoon', 'Evening'], + values: ['Morning', 'Afternoon', 'Evening'], defaultIndex: 1, }, ];