docs: update docs

Change-Id: I76d0f72679cd75085f5ffd42f641daa198cafe11

docs: update docs for alert/autocomplete/carousel, etc.

Change-Id: Ib7507f4979024f53c127e4b64b88560b93999db7

fix: update for autocomplete filter

Change-Id: Ie54556715fa52838aeb6caaa19b4f9a9f14b490f

docs: add docs for calendar/transfer/cascader

Change-Id: I655b3cb3d25dd0649de9ae7e224e7063a40dd079

fix: add more demos for input/textarea

Change-Id: Iada527ca82643a435a4775110b332155512d62a7

docs: add docs for uploader,select,table, etc.

Change-Id: Ib034fd5cc9d9a420d4e002956ae925175783c5f3

docs: adjust formatting and punc.

docs: adjust docs for uploader, etc.

Change-Id: If06c8c1102eafce43f5802a333676fc9e62cd474

docs: add docs for nav

Change-Id: If56a653ec53f19239606128fd30cae80f8e10025

docs: improve anchor demos

Change-Id: I6ac1c08cc8905924d0062def1f8921fe1f302f15

docs: refine wording and format

docs: update docs for check-button-group desc

Change-Id: Ica7d6d0692250f0be6bd330b1ad4cc41938afd46
This commit is contained in:
Justineo
2021-09-16 19:23:58 +08:00
committed by GU Yiling
parent 4a257c3680
commit 32632e796e
75 changed files with 3360 additions and 411 deletions

View File

@@ -14,6 +14,18 @@
[[ demo src="/demo/alert/multiple.vue" ]]
### 标题
设置 `title` 属性来指定消息标题。
[[ demo src="/demo/alert/title.vue" ]]
### 额外内容
通过 `extra` 插槽来指定消息之后的额外内容区域。
[[ demo src="/demo/alert/extra.vue" ]]
## API
### 属性

View File

@@ -2,9 +2,15 @@
## 示例
### 容器与吸附
### 普通锚点
使用 [`container`](#props-container) 属性设置 `Anchor` 的容器,使用 [`sticky`](#props-sticky) 属性来控制是否在滚动出容器时进行吸附
使用 [`container`](#props-container) 属性设置发生滚动的容器,当 `Anchor` 组件不在容器中(也就不随容器滚动),此时可以不用设置 `sticky` 属性
[[ demo src="/demo/anchor/normal.vue" ]]
### 吸附锚点
`Anchor` 组件在容器中(随容器滚动),此时可设置 `sticky` 属性来控制组件在滚动出容器时进行吸附。
[[ demo src="/demo/anchor/sticky.vue" ]]

View File

@@ -2,8 +2,30 @@
## 示例
### 触发建议的时机
设置 `suggest-trigger` 来指定触发建议的时机。
[[ demo src="/demo/autocomplete/normal.vue" ]]
### 严格模式
设置 `strict` 属性来指定严格模式,若输入值没有完全匹配建议值,那么在失焦时会清空输入值。
[[ demo src="/demo/autocomplete/strict.vue" ]]
### 自定义搜索逻辑
设置 `match` 属性来自定义自定义高亮逻辑。
设置 `filter` 属性来自定义搜索命中逻辑。
:::tip
`match` 用于高亮显示匹配文本的逻辑;而 `filter` 是控制是否命中。默认情况下 `filter` 会过滤掉未被 `match` 匹配的节点,且将包含非叶子节点。如希望搜索结果中都是叶子节点,可通过重写 `filter` 过滤掉非叶子节点。
:::
[[ demo src="/demo/autocomplete/custom.vue" ]]
## API
### 属性
@@ -12,7 +34,8 @@
| -- | -- | -- | -- |
| ``datasource`` | `Array<string | Object>=` | `[]` | [^datasource] |
| ``value`` | `*` | - | [^prop-value] |
| ``match`` | `function(string | Object, string): boolean=` | - | 自定义搜索逻辑。 |
| ``match`` | `(item, keyword, { ancestors }) => boolean | [number, number] | Array<[number, number]>` | - | 支持自定义高亮逻辑,默认进行大小写不敏感的子串匹配。 |
| ``filter`` | `(item, keyword, { ancestors, offsets }) => boolean` | - | 支持自定义搜索命中逻辑。 |
| ``strict`` | `boolean=` | `false` | 建议下拉面板关闭时,若输入值没有完全匹配建议值,那么会清空输入值。 |
| ``suggest-trigger`` | `string | Array<string>=` | `'input'` | 触发建议下拉面板的时机,可用值有:`'input'`、`'focus'`。 |
| ``placeholder`` | `string=` | | 输入占位符。 |

View File

@@ -14,6 +14,12 @@
[[ demo src="/demo/badge/number.vue" ]]
### 右上角圆点徽标
不提供徽标内容时,徽标将以圆点样式显示在右上角。
[[ demo src="/demo/badge/corner-dot.vue" ]]
### 圆点徽标
不提供插槽内容时,徽标将以圆点样式显示。

View File

@@ -20,6 +20,30 @@
[[ demo src="/demo/calendar/multiple-ranges.vue" ]]
### 日历类型
设置 `type` 来指定日历的类型:年、月、日。
[[ demo src="/demo/calendar/type.vue" ]]
### 显示非本月日期
设置 `fill-month` 来控制是否显示非本月日期。
[[ demo src="/demo/calendar/fill-month.vue" ]]
### 禁用日期
设置 `disabled-date` 来自定义指定日期是否禁用。
[[ demo src="/demo/calendar/disabled-date.vue" ]]
### 自定义日期的样式
设置 `date-class` 来自定义指定日期的 `class`
[[ demo src="/demo/calendar/date-class.vue" ]]
## API
### 属性

View File

@@ -42,6 +42,13 @@
[[ demo src="/demo/carousel/slides.vue" ]]
### 轮播项纵横比
设置 `slide-aspect-ratio` 属性来指定每个轮播项的纵横比。
[[ demo src="/demo/carousel/ratio.vue" ]]
## API
### 属性

View File

@@ -27,6 +27,24 @@
[[ demo src="/demo/cascader/multiple.vue" ]]
### 选择模式
使用 `select-mode` 属性来控制在单选模式下哪些项目可以被选中。
[[ demo src="/demo/cascader/select-mode.vue" ]]
### 子项展开时机
使用 `column-trigger` 属性来控制下拉面板中下级的展开时机。
[[ demo src="/demo/cascader/column-trigger.vue" ]]
### 渲染选中值
使用 `value-display` 属性来控制选中值如何展示。
[[ demo src="/demo/cascader/value-display.vue" ]]
## API
### 属性
@@ -52,6 +70,8 @@
| ``readonly`` | `boolean=` | `false` | 是否为只读状态。 |
| ``overlay-class`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props-overlay-class) 属性。 |
| ``overlay-style`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#props-overlay-style) 属性。 |
| ``match`` | `(item, keyword, { ancestors }) => boolean | Array<[number, number]>` | - | 支持自定义高亮逻辑, 默认大小写不敏感,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)。 |
| ``filter`` | `(item, keyword, { ancestors, offsets }) => boolean` | - | 支持自定义搜索命中逻辑,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)。 |
^^^ui
预设样式。

View File

@@ -8,12 +8,30 @@
[[ demo src="/demo/check-button-group/default.vue" ]]
### 简单样式
设置 `ui` 属性值:`simple` 来指定简单样式。
[[ demo src="/demo/check-button-group/simple.vue" ]]
### 单复选共存
可以使用 `exclusive` 选项与 `empty-value` 实现一些单复选共存的场景。
[[ demo src="/demo/check-button-group/exclusive.vue" ]]
### 额外描述
在数据源的项目中设置 `desc` 字段或者通过 `desc` 插槽来指定额外描述。额外描述会在悬浮时显示。
[[ demo src="/demo/check-button-group/desc.vue" ]]
### 最小宽度
通过设置 `ui` 属性值 `stable` 来开启项目的最小宽度。
[[ demo src="/demo/check-button-group/stable.vue" ]]
## API
### 属性
@@ -38,7 +56,7 @@
^^^
^^^items
复选按钮组数据源,项目类型为 `{label, value, disabled, exclusive, ...}`。
复选按钮组数据源,项目类型为 `{ label, value, disabled, exclusive, desc, ... }`。
+++字段详情
| 名称 | 类型 | 描述 |
@@ -47,6 +65,7 @@
| `value` | `*` | 选项对应的值。 |
| `disabled` | `boolean=` | 选项是否为禁用。 |
| `exclusive` | `boolean=` | 选项是否为排它项。当选项为排它项时,选中该项将取消选中其它所有选项。 |
| `desc` | `string` | 选项的额外描述信息。 |
+++
^^^
@@ -63,6 +82,7 @@
| 名称 | 描述 |
| -- | -- |
| ``item`` | [^slot-item] |
| ``desc`` | 按钮的额外描述信息,作用域参数同 `item` 插槽。 |
^^^slot-item
按钮内文本区域。

View File

@@ -14,6 +14,12 @@
[[ demo src="/demo/checkbox-group/exclusive.vue" ]]
### 额外描述
在数据源的项目中设置 `desc` 字段或者通过 `desc` 插槽来指定额外描述。额外描述会在悬浮时显示。
[[ demo src="/demo/checkbox-group/desc.vue" ]]
## API
### 属性
@@ -38,7 +44,7 @@
^^^
^^^items
复选框组数据源,项目类型为 `{label, value, disabled, exclusive, ...}`。
复选框组数据源,项目类型为 `{ label, value, disabled, exclusive, desc, ... }`。
+++字段详情
| 名称 | 类型 | 描述 |
@@ -47,6 +53,7 @@
| `value` | `*` | 选项对应的值。 |
| `disabled` | `boolean=` | 选项是否为禁用。 |
| `exclusive` | `boolean=` | 选项是否为排它项。 |
| `desc` | `string` | 选项的额外描述信息。 |
+++
^^^
@@ -63,6 +70,7 @@
| 名称 | 描述 |
| -- | -- |
| ``item`` | [^slot-item] |
| ``desc`` | 按钮的额外描述信息,作用域参数同 `item` 插槽。 |
^^^slot-item
选项描述文本区域。

View File

@@ -20,6 +20,14 @@
[[ demo src="/demo/date-picker/shortcuts.vue" ]]
### 禁用和只读
设置 `disabled` 属性可使组件处于禁用状态。
设置 `readonly` 属性可使组件处于只读状态。
[[ demo src="/demo/date-picker/disabled.vue" ]]
## API
### 属性

View File

@@ -57,6 +57,8 @@
| ``disabled`` | `boolean=` | `false` | 是否为禁用状态。 |
| ``overlay-class`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props-overlay-class) 属性。 |
| ``overlay-style`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#props-overlay-style) 属性。 |
| ``match`` | `(item, keyword, { ancestors }) => boolean | Array<[number, number]>` | - | 支持自定义高亮逻辑, 默认大小写不敏感,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)。 |
| ``filter`` | `(item, keyword, { ancestors, offsets }) => boolean` | - | 支持自定义搜索命中逻辑,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)。 |
^^^ui
预设样式。

View File

@@ -20,6 +20,18 @@
[[ demo src="/demo/input/disabled.vue" ]]
### 感知输入法
设置 `composition` 来感知输入法输入过程中的值。
[[ demo src="/demo/input/composition.vue" ]]
### 过滤首尾空白字符
设置 `trim` 来自动过滤用户输入的首尾空白字符。
[[ demo src="/demo/input/trim.vue" ]]
## API
### 属性

119
one/docs/components/nav.md Normal file
View File

@@ -0,0 +1,119 @@
# Nav <small>导航菜单</small>
## 示例
### 尺寸
可选的尺寸 `ui` 属性值:`s`/`m`
[[ demo src="/demo/nav/size.vue" ]]
### 大卡样式
设置首层数据项属性 `position``card` 可使该数据项下拉展示成大卡样式。
[[ demo src="/demo/nav/card.vue" ]]
### 自定义插槽
[[ demo src="/demo/nav/slot.vue" ]]
### 自适应宽度
自动根据实际渲染宽度来决定是否将多余的导航项目折叠起来。
[[ demo src="/demo/nav/more.vue" ]]
## API
### 属性
| 名称 | 类型 | 默认值 | 描述 |
| -- | -- | -- | -- |
| `ui` | `string=` | - | [^ui] |
| `items` | `Array<Object>=` | `[]` | [^items] |
| `active` | `string` | - | [^active] |
| `matches` | `function(Object, string): boolean` | - | [^matches] |
^^^ui
预设样式。
+++枚举值
| 值 | 描述 |
| -- | -- |
| `s` | 小尺寸样式。 |
| `m` | 中尺寸样式。 |
+++
^^^
^^^active
当前激活节点,若该节点定义了 `name` 则就是该 `name` 值,否则该值是由 `to` 生成的路由路径([route.path](https://router.vuejs.org/zh/api/#%E8%B7%AF%E7%94%B1%E5%AF%B9%E8%B1%A1%E5%B1%9E%E6%80%A7))。
^^^
^^^items
数据源数组,每个节点类型为 `{label, to, name, icon, disabled, children, ...}`
+++字段详情
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `label` | `string` | 节点的文字描述。 |
| `to` | `string | Object` | 节点的导航目的地。参考 [`Link`](./link) 组件的 [`to`](./link#props) 属性。 |
| `name` | `string` | 节点的唯一标识,`name``to` 二者至少有一个存在。 |
| `disabled` | `boolean=` | 节点是否被禁用。 |
| `position` | `string=` | 首层节点的下拉面板样式,设置成 `card` 则展示成大卡样式。 |
| `children` | `Array<Object>=` | 节点的子节点数组,数组项类型同 `items` 数组项。 |
+++
^^^
^^^matches
当路由发生切换时,用来从 `items` 中找到激活的项目。
默认实现:项目路由路径和当前路由的路径相等 (===) 则认为该项目是激活的。
^^^
### 插槽
| 名称 | 描述 |
| -- | -- |
| `item` | [^item] |
| `item-label` | [^item-label] |
^^^item
每个节点的渲染插槽。
默认内容:渲染了 `icon` 插槽和 `item-label` 插槽。
+++作用域参数
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `label` | `string` | 图标名称。 |
| `to` | `string | Object` | 节点的导航目的地。参考 [`Link`](./link) 组件的 [`to`](./link#props) 属性。 |
| `name` | `string` | 节点的唯一标识,`name``to` 二者至少有一个存在。 |
| `disabled` | `boolean=` | 节点是否被禁用。 |
| `children` | `Array<Object>=` | 节点的子节点数组,数组项类型同 `items` 数组项。 |
+++
^^^
^^^item-label
节点的 `label` 插槽。
默认内容:渲染节点对应的 `Link`
作用域参数参考 `item` 插槽。
^^^
### 事件
| 名称 | 描述 |
| -- | -- |
| `activate` | 用户点击有 `to` 的节点触发,参数是激活节点的整个 `item` 数据。 |
| `click` | 用户点击节点时触发,参数是激活节点整个 `item` 数据。 |
### 图标
| 名称 | 描述 |
| -- | -- |
| `expand` | 展开。 |
| `more` | 更多。 |

View File

@@ -20,6 +20,14 @@
[[ demo src="/demo/number-input/disabled.vue" ]]
### 精度位数和递增/递减
设置 `decimal-place` 来指定数值的小数精度位数。
设置 `step` 来指定每次递增/减的数值。
[[ demo src="/demo/number-input/decimal.vue" ]]
## API
### 属性
@@ -35,6 +43,7 @@
| ``max`` | `number` | - | 允许的最大值。 |
| ``min`` | `number` | - | 允许的最小值。 |
| ``decimal-place`` | `number` | 0 | 数值的小数精度位数,默认精确到整数位,`-1` 表示不处理精度。 |
| ``step`` | `number` | 1 | 每次递增/递减的数值。 |
^^^ui
预设样式。

View File

@@ -12,6 +12,15 @@
[[ demo src="/demo/pagination/goto.vue" ]]
### 每页个数
使用 `page-size` 属性来指定当前每页的个数。
使用 `page-sizes` 属性来指定每页个数候选项。
[[ demo src="/demo/pagination/pages.vue" ]]
## API
### 属性

View File

@@ -8,6 +8,24 @@
[[ demo src="/demo/radio-button-group/default.vue" ]]
### 简单样式
设置 `ui` 属性值:`simple` 来指定简单样式。
[[ demo src="/demo/radio-button-group/simple.vue" ]]
### 额外描述
在数据源的项目中设置 `desc` 字段或者通过 `desc` 插槽来指定额外描述。额外描述会在悬浮时显示。
[[ demo src="/demo/radio-button-group/desc.vue" ]]
### 最小宽度
设置 `ui` 属性值:`simple` 来指定简单样式。
[[ demo src="/demo/radio-button-group/stable.vue" ]]
## API
### 属性
@@ -31,7 +49,7 @@
^^^
^^^items
单选按钮组数据源,项目类型为 `{label, value, disabled, ...}`。
单选按钮组数据源,项目类型为 `{ label, value, disabled, desc, ... }`。
+++字段详情
| 名称 | 类型 | 描述 |
@@ -39,6 +57,7 @@
| `label` | `string` | 选项的文字说明。 |
| `value` | `*` | 选项对应的值。 |
| `disabled` | `boolean=` | 选项是否为禁用。 |
| `desc` | `string` | 选项的额外描述信息。 |
+++
^^^
@@ -55,6 +74,7 @@
| 名称 | 描述 |
| -- | -- |
| ``item`` | [^slot-item] |
| ``desc`` | 按钮的额外描述信息,作用域参数同 `item` 插槽。 |
^^^slot-item
按钮内文本区域。
@@ -68,6 +88,7 @@
| `value` | `string` | 选项值。 |
| `index` | `number` | 选项在 `items` 中的序号。 |
| `disabled` | `boolean=` | 选项是否禁用。 |
| `desc` | `string` | 选项的额外描述信息。 |
+++
另外,`items` 内数据项中除了上面描述的字段之外的其它字段也会自动通过 `v-bind` 进行绑定到作用域参数上。

View File

@@ -8,6 +8,12 @@
[[ demo src="/demo/radio-group/default.vue" ]]
### 额外描述
在数据源的项目中设置 `desc` 字段或者通过 `desc` 插槽来指定额外描述。额外描述会在悬浮时显示。
[[ demo src="/demo/radio-group/desc.vue" ]]
## API
### 属性
@@ -31,7 +37,7 @@
^^^
^^^items
单选框组数据源,项目类型为 `{label, value, disabled, ...}`。
单选框组数据源,项目类型为 `{ label, value, disabled, desc, ... }`。
+++字段详情
| 名称 | 类型 | 描述 |
@@ -39,6 +45,7 @@
| `label` | `string` | 选项的文字说明。 |
| `value` | `*` | 选项对应的值。 |
| `disabled` | `boolean=` | 选项是否为禁用。 |
| `desc` | `string` | 选项的额外描述信息。 |
+++
^^^
@@ -55,6 +62,7 @@
| 名称 | 描述 |
| -- | -- |
| ``item`` | [^slot-item] |
| ``desc`` | 按钮的额外描述信息,作用域参数同 `item` 插槽。 |
^^^slot-item
选项描述文本区域。

View File

@@ -41,6 +41,8 @@
| ``expanded`` | `boolean=` | `false` | [^expanded] |
| ``disabled`` | `boolean=` | `false` | 是否为禁用状态。 |
| ``readonly`` | `boolean=` | `false` | 是否为只读状态。 |
| ``match`` | `(item, keyword, { ancestors }) => boolean | Array<[number, number]>` | - | 支持自定义高亮逻辑, 默认大小写不敏感,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)。 |
| ``filter`` | `(item, keyword, { ancestors, offsets }) => boolean` | - | 支持自定义搜索命中逻辑,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)。 |
^^^ui
按钮预设样式。

View File

@@ -30,6 +30,15 @@
[[ demo src="/demo/select/multiple.vue" ]]
### 自定义已选项展示
使用 `label` 插槽来自定义**下拉关闭时**已选项如何展示。
使用 `select` 插槽来自定义已选项如何展示,和下拉是否关闭无关。
[[ demo src="/demo/select/selected.vue" ]]
## API
### 属性
@@ -50,6 +59,8 @@
| ``readonly`` | `boolean=` | `false` | 是否为只读状态。 |
| ``overlay-class`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props-overlay-class) 属性。 |
| ``overlay-style`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#props-overlay-style) 属性。 |
| ``match`` | `(item, keyword, { ancestors }) => boolean | Array<[number, number]>` | - | 支持自定义高亮逻辑, 默认大小写不敏感,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)。 |
| ``filter`` | `(item, keyword, { ancestors, offsets }) => boolean` | - | 支持自定义搜索命中逻辑,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)。 |
^^^ui
预设样式。

View File

@@ -48,6 +48,22 @@
[[ demo src="/demo/table/desc.vue" ]]
### 排序
使用 `order` 属性和 `order-by` 属性来指定表头上的排序状态。
监听 `sort` 事件来处理排序状态的变化。
设置 `allowed-orders` 属性来自定义允许的排序状态。
[[ demo src="/demo/table/order.vue" ]]
### 加载状态
使用 `loading` 属性来指定表格处于加载状态。
[[ demo src="/demo/table/loading.vue" ]]
## API
### 属性

View File

@@ -20,6 +20,12 @@
[[ demo src="/demo/textarea/disabled.vue" ]]
### 自动扩展
设置 `autoresize` 来使文本域处于自动扩展状态。
[[ demo src="/demo/textarea/autoresize.vue" ]]
## API
### 属性

View File

@@ -20,6 +20,12 @@
[[ demo src="/demo/transfer/flat.vue" ]]
### 选中值的合并模式
设置 `merge-checked` 来指定选中值的合并模式。
[[ demo src="/demo/transfer/merge-checked.vue" ]]
## API
### 属性

View File

@@ -32,6 +32,25 @@
[[ demo src="/demo/uploader/custom.vue" ]]
### 拖拽排序
设置 `sortable` 属性来指定上传项目之间可以拖拽排序。
[[ demo src="/demo/uploader/sortable.vue" ]]
### 已上传项自定义操作
设置 `controls` 属性来指定悬浮到每个上传项时的操作选项。
[[ demo src="/demo/uploader/controls.vue" ]]
### 上传入口自定义操作
设置 `entries` 属性来指定悬浮到继续上传项目时的操作选项。
[[ demo src="/demo/uploader/entries.vue" ]]
## API
### 属性