From bbcea6f5e98ed68af482a37cb01547f9fb2ab50d Mon Sep 17 00:00:00 2001 From: xiaodemen Date: Fri, 7 May 2021 10:57:45 +0800 Subject: [PATCH] docs: update docs Change-Id: Ia7978d5e7fb726c5fd888d80b571ebda6a52c912 --- one/docs/components/cascader.md | 26 ++++++++++++------------ one/docs/components/column.md | 2 +- one/docs/components/lightbox.md | 4 ++-- one/docs/components/select.md | 2 +- one/docs/components/transfer.md | 2 +- one/docs/components/uploader.md | 2 +- one/docs/demo/cascader/multiple.vue | 19 +++++++++-------- one/docs/demo/directives/drag/sort-x.vue | 4 +++- one/docs/demo/directives/drag/sort-y.vue | 4 +++- one/docs/directives/v-drag.md | 4 ++-- 10 files changed, 38 insertions(+), 31 deletions(-) diff --git a/one/docs/components/cascader.md b/one/docs/components/cascader.md index 25ee219..bf14c29 100644 --- a/one/docs/components/cascader.md +++ b/one/docs/components/cascader.md @@ -102,7 +102,7 @@ +++枚举值 | 值 | 描述 | | -- | -- | -| `hover` | hover展开下一级。 | +| `hover` | 光标悬浮展开下一级。 | | `click` | 点击展开下一级。 | +++ ^^^ @@ -130,8 +130,8 @@ +++枚举值 | 值 | 描述 | | -- | -- | -| `complete` | 完整展示选中值的父子路径，如`中国 > 上海`。 | -| `simple` | 仅仅展示选中值。 | +| `complete` | 完整展示选中值的路径，如“中国 > 上海”。 | +| `simple` | 仅仅展示选中值文本。 | +++ ^^^ @@ -159,13 +159,13 @@ | 名称 | 类型 | 描述 | | -- | -- | -- | | `value` | `*` | 已选项值。 | -| `selected` | `object` | 已选项 | +| `selected` | `Object` | 已选项对象。 | | `expanded` | `boolean` | 下拉菜单是否展开。 | | `keyword` | `string` | 搜索值。 | -| `select` | `function(value: *): void` | 用于设置已选项。 | -| `updateExpanded` | `function(expanded: boolean): void` | 用于切换下拉菜单展开状态。 | -| `clearSelected` | `function(): void` | 用于清除已选项。 | -| `removeSelected` | `function(option: object): void` | 用于删除某个已选项，参数 `option` 是该已选项。 | +| `select` | `function(option: Object): void` | 用于设置已选项。 | +| `toggle` | `function(force: boolean): void` | 用于切换下拉菜单展开状态。 | +| `clear` | `function(): void` | 用于清除已选项。 | +| `remove` | `function(option: Object): void` | 用于删除某个已选项，参数 `option` 是该已选项。 | | `updateKeyword` | `function(keyword: string): void` | 用于修改搜索值。 | +++ ^^^ @@ -176,7 +176,7 @@ +++作用域参数 | 名称 | 类型 | 描述 | | -- | -- | -- | -| `option` | `object` | 该列的父选项，其中 `options` 属性可以拿到当前列的数据。 | +| `option` | `Object` | 该列的父选项，其中 `options` 属性可以拿到当前列的数据。 | +++ ^^^ @@ -206,10 +206,10 @@ +++作用域参数 | 名称 | 类型 | 描述 | | -- | -- | -- | -| `option` | `object` | 当前选项。 | -| `select` | `function(option: object): void` | 选中当前选项。 | -| `expand` | `function(option: object): void` | 展开当前选项。 | -| `click` | `function(option: object): void` | 点击当前选项内容区，会按情况选中和(或)展开当前选项。 | +| `option` | `Object` | 当前选项。 | +| `select` | `function(option: Object): void` | 选中当前选项。 | +| `expand` | `function(option: Object): void` | 展开当前选项。 | +| `click` | `function(option: Object): void` | 点击当前选项内容区，会按情况选中和(或)展开当前选项。 | +++ ^^^ diff --git a/one/docs/components/column.md b/one/docs/components/column.md index 0094abe..d799ec8 100644 --- a/one/docs/components/column.md +++ b/one/docs/components/column.md @@ -52,7 +52,7 @@ ^^^ ^^^allowed-orders -指定该列的排序范围。 +指定该列的排序范围。用户点击时将按设定的顺序进行切换。 +++值范围 | 值 | 描述 | diff --git a/one/docs/components/lightbox.md b/one/docs/components/lightbox.md index 0ee11ec..8d83b4e 100644 --- a/one/docs/components/lightbox.md +++ b/one/docs/components/lightbox.md @@ -21,7 +21,7 @@ | `before-close` | `function(string): boolean=|Promise` | - | [^before-close] | | `overlay-class` | `string|Array|Object=` | - | 浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 | | `indicator` | `string=` | `'number'` | [^indicator] | -| `options` | `object=` | `{video: {muted: true, autoplay: true, controls: true}}` | 额外配置。 | +| `options` | `Object=` | `{ video: { muted: true, autoplay: true, controls: true } }` | 额外配置。 | ^^^open :::badges @@ -32,7 +32,7 @@ ^^^ ^^^datasource -灯箱数据源，项目类型为：`{src, alt, type}`。 +灯箱数据源，项目类型为：`{ src, alt, type, desc }`。 +++字段详情 | 名称 | 类型 | 描述 | diff --git a/one/docs/components/select.md b/one/docs/components/select.md index 56d0e70..fba5455 100644 --- a/one/docs/components/select.md +++ b/one/docs/components/select.md @@ -213,7 +213,7 @@ ^^^slot-selected 选中值渲染区域。 -默认内容：单选时渲染选中项目的标签；多选时将每个选中项目的标签渲染成`Tag`。 +默认内容：单选时渲染选中项目的标签；多选时将每个选中项目的标签渲染为 `Tag` 组件。 +++单选时的作用域参数 | 名称 | 类型 | 描述 | diff --git a/one/docs/components/transfer.md b/one/docs/components/transfer.md index d245b41..d7508cf 100644 --- a/one/docs/components/transfer.md +++ b/one/docs/components/transfer.md @@ -112,7 +112,7 @@ function (keyword, { label }) { ^^^merge-checked -选中值的合并策略。 +选中值的合并策略。当某个节点下的所有子节点都被选中时，可以选择只保留父节点、只保留子节点或都保留。 +++枚举值 | 值 | 描述 | diff --git a/one/docs/components/uploader.md b/one/docs/components/uploader.md index 7fb2ff0..9452c93 100644 --- a/one/docs/components/uploader.md +++ b/one/docs/components/uploader.md @@ -211,7 +211,7 @@ ^^^ ^^^entries -控制每个上传文件的操作项，如删除，预览等，会传递默认的操作项数组作为参数，返回实际生效的操作项数组。操作项对象一般是 `{name, icon, label}`。 +控制每个上传文件的操作项，如删除，预览等，会传递默认的操作项数组作为参数，返回实际生效的操作项数组。操作项对象参考 `controls` 属性的字段详情。 ^^^ ### 插槽 diff --git a/one/docs/demo/cascader/multiple.vue b/one/docs/demo/cascader/multiple.vue index 6179da4..d86f252 100644 --- a/one/docs/demo/cascader/multiple.vue +++ b/one/docs/demo/cascader/multiple.vue @@ -1,25 +1,27 @@