taolin/docs_vue2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

refactor: improve union type formatting

Browse Source
This commit is contained in:
Justineo 2021-10-18 16:51:48 +08:00
parent 87e976bb7e
commit 85ef96d46b
No known key found for this signature in database
GPG Key ID: B73F0979CF18A0EA
38 changed files with 72 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
one/docs/components/accordion.md
View File

@ -26,7 +26,7 @@
| -- | -- | -- | -- |
| `multiple` | `boolean=` | `false` | 是否允许多个子面板同时展开。 |
| `disabled` | `boolean=` | `false` | 是否为禁用状态。 |
| `expanded` | `string|Array<string>` | - | [^expanded] |
| `expanded` | `string | Array<string>` | - | [^expanded] |
^^^expanded
:::badges
@ -56,6 +56,6 @@
| -- | -- | -- |
| `expand` | `boolean` | 是否展开。 |
| `name` | `string` | 被切换的折叠面板标识。 |
| `expanded` | `string|Array<string>` | 当前所有被展开的折叠面板标识。 |
| `expanded` | `string | Array<string>` | 当前所有被展开的折叠面板标识。 |
+++
^^^

4
one/docs/components/alert-box.md
View File

@ -27,8 +27,8 @@
| `disabled` | `boolean=` | `false` | 是否处于禁用状态。处于禁用状态时确定按钮也将进入禁用状态，无法点击。 |
| `ok-label` | `string=` | - | “确定”按钮的文字内容。 |
| `before-close` | `function(string): boolean=|Promise<boolean=>` | - | 在将触发关闭的操作发生后执行，参考 [`Dialog`](./dialog) 组件的 [`before-close`](./dialog#props) 属性。 |
| `overlay-class` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
| `overlay-class` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
^^^open
:::badges

2
one/docs/components/alert.md
View File

@ -22,7 +22,7 @@
| -- | -- | -- | -- |
| `type` | `string=` | `'success'` | [^type] |
| `title` | `string` | - | 消息标题。 |
| `message` | `string|Array<string>` | - | 消息内容，当类型为数组时会显示多条数据并支持切换上一条/下一条。 |
| `message` | `string | Array<string>` | - | 消息内容，当类型为数组时会显示多条数据并支持切换上一条/下一条。 |
| `closable` | `boolean=` | `false` | 是否允许关闭。 |
| `open` | `boolean=` | `true` | [^open] |
| `index` | `number=` | `0` | [^index] |

6
one/docs/components/anchor.md
View File

@ -24,9 +24,9 @@
| -- | -- | -- | -- |
| `items` | `Array<{value, label, children}>` | `[]` | [^items] |
| `sticky` | `boolean=` | `false` | 是否有吸附效果。 |
| `container` | `string|HTMLElement|Window=` | - | `Anchor` 吸附与判断锚点激活所参考的容器。 |
| `target-offset` | `string|number=` | `0` | 当某个锚点处于到容器的 `target-offset` 位置，那么对应的锚点链接处于激活状态。 |
| `sticky-offset` | `string|number=` | `0` | 对于 sticky `Anchor` 而言，当容器滚动到 `sticky-offset` 位置，那么该 `Anchor` 开始吸附。 |
| `container` | `string | HTMLElement | Window=` | - | `Anchor` 吸附与判断锚点激活所参考的容器。 |
| `target-offset` | `string | number=` | `0` | 当某个锚点处于到容器的 `target-offset` 位置，那么对应的锚点链接处于激活状态。 |
| `sticky-offset` | `string | number=` | `0` | 对于 sticky `Anchor` 而言，当容器滚动到 `sticky-offset` 位置，那么该 `Anchor` 开始吸附。 |
^^^items
数据源数组，每个项目类型为 `{label, value, children, ...}`。

8
one/docs/components/autocomplete.md
View File

@ -10,11 +10,11 @@
| 名称 | 类型 | 默认值 | 描述 |
| -- | -- | -- | -- |
| `datasource` | `Array<string|Object>=` | `[]` | [^datasource] |
| `datasource` | `Array<string | Object>=` | `[]` | [^datasource] |
| `value` | `*` | - | [^prop-value] |
| `match` | `function(string|Object, string): boolean=` | - | 自定义搜索逻辑。 |
| `match` | `function(string | Object, string): boolean=` | - | 自定义搜索逻辑。 |
| `strict` | `boolean=` | `false` | 建议下拉面板关闭时，若输入值没有完全匹配建议值，那么会清空输入值。 |
| `suggest-trigger` | `string|Array<string>=` | `'input'` | 触发建议下拉面板的时机，可用值有：`'input'`、`'focus'`。 |
| `suggest-trigger` | `string | Array<string>=` | `'input'` | 触发建议下拉面板的时机，可用值有：`'input'`、`'focus'`。 |
| `placeholder` | `string=` | | 输入占位符。 |
| `select-on-focus` | `boolean=` | `false` | 聚焦时是否自动选中输入框文本。 |
| `composition` | `boolean=` | `false` | 是否感知输入法输入过程的值。 |
@ -65,7 +65,7 @@
+++作用域参数
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `datasource` | `Array<string|Object>` | 数据源，类型同 `datasource` 属性。 |
| `datasource` | `Array<string | Object>` | 数据源，类型同 `datasource` 属性。 |
| `keyword` | `string` | 搜索关键词。 |
+++
^^^

2
one/docs/components/badge.md
View File

@ -27,7 +27,7 @@
| 名称 | 类型 | 默认值 | 描述 |
| -- | -- | -- | -- |
| `type` | `string=` | `'error'` | [^type] |
| `value` | `string|number` | - | 徽标内容值。为 `number` 类型值时，会受 `max` 属性限制。为 `string` 类型时，`max` 会被忽略。 |
| `value` | `string | number` | - | 徽标内容值。为 `number` 类型值时，会受 `max` 属性限制。为 `string` 类型时，`max` 会被忽略。 |
| `max` | `number=` | `badge.max` | 徽标数值的最大值，当 `value` 超过此值时，徽标内容会显示为 `{max}+`。当 `value` 为 `string` 时会被忽略。 |
| `hidden` | `boolean=` | `false` | 是否处于隐藏状态。 |

2
one/docs/components/breadcrumb-item.md
View File

@ -14,7 +14,7 @@
| 名称 | 类型 | 默认值 | 描述 |
| --- | --- | --- | --- |
| `to` | `string|Object` | - | 点击面包屑项之后要跳转到的地址。见 [`Link`](./link#属性) 组件的同名属性。 |
| `to` | `string | Object` | - | 点击面包屑项之后要跳转到的地址。见 [`Link`](./link#属性) 组件的同名属性。 |
| `type` | `string` | `'link'` | [^link] |
| `native` | `boolean` | `false` | 当值为 `true` 且指定了 `to` 时，会直接使用原生 `<a>` 元素，`to` 值会被设置到 `<a>` 标签的 `href` 属性上。 |

2
one/docs/components/breadcrumb.md
View File

@ -62,7 +62,7 @@
^^^
^^^routes
面包屑配置，项目类型为 `{label: string, type: string, to: string|Object=, native: boolean=}`，除 `label` 外字段详情可参考 [`BreadcrumbItem`](./breadcrumb-item) 组件的属性。
面包屑配置，项目类型为 `{label: string, type: string, to: string | Object=, native: boolean=}`，除 `label` 外字段详情可参考 [`BreadcrumbItem`](./breadcrumb-item) 组件的属性。
:::warning
默认情况下，最后一项始终会显示成普通文本样式。

4
one/docs/components/calendar.md
View File

@ -29,12 +29,12 @@
| `type` | `string=` | `'date'` | 日历的类型，可用值为 `'date'`/`'month'`/`'year'`，分别对应日期/月/年视图。 |
| `multiple` | `boolean=` | `false` | 是否可以选择多个日期（范围）。 |
| `range` | `boolean=` | `false` | 是否选择日期范围。 |
| `selected` | `Date|Array=` | - | [^selected] |
| `selected` | `Date | Array=` | - | [^selected] |
| `panel` | `number=` | `1` | 日历面板数量。 |
| `today` | `Date=` | `new Date()` | 「今天」的日期。 |
| `week-start` | `number=` | `calendar.weekStart` | 一周的起始。可进行[全局配置](#全局配置)。 |
| `fill-month` | `boolean=` | `true` | 当只有一个面板时，是否要在当前月份面板显示非本月日期。 |
| `date-class` | `string|Array|Object|function=` | `{}` | 特定日期的自定义 HTML `class`。传非函数时，数据格式为所有 [Vue 支持的 `class` 表达式](https://cn.vuejs.org/v2/guide/class-and-style.html#%E7%BB%91%E5%AE%9A-HTML-Class)；传函数时，签名为 `function(Date): string|Array<string>|Object<string, boolean>`，返回值格式亦为所有 Vue 支持的 `class` 表达式。 |
| `date-class` | `string | Array | Object | function=` | `{}` | 特定日期的自定义 HTML `class`。传非函数时，数据格式为所有 [Vue 支持的 `class` 表达式](https://cn.vuejs.org/v2/guide/class-and-style.html#%E7%BB%91%E5%AE%9A-HTML-Class)；传函数时，签名为 `function(Date): string | Array<string>|Object<string, boolean>`，返回值格式亦为所有 Vue 支持的 `class` 表达式。 |
| `disabled-date` | `function(Date, Date=): boolean=` | `() => false` | 用于自定义指定日期是否禁用。第一个参数为需要判断是否禁用的日期。当处于范围选择过程中且已经选择了一个日期，会作为第二个参数传入。 |
| `disabled` | `boolean=` | `false` | 是否为禁用状态。 |
| `readonly` | `boolean=` | `false` | 是否为只读状态。 |

6
one/docs/components/cascader.md
View File

@ -45,13 +45,13 @@
| `expanded` | `boolean=` | `false` | [^expanded] |
| `column-trigger` | `hover | click` | `click` | [^column-trigger] |
| `select-mode` | `'leaf-only' | 'any'` | `any` | [^select-mode] |
| `column-width` | `number|string` | - | [^column-width] |
| `column-width` | `number | string` | - | [^column-width] |
| `show-select-all` | `boolean` | `false` | 在多选模式下是否有全选按钮。 |
| `value-display` | `'complete' | 'simple'` | `simple` | [^value-display] |
| `disabled` | `boolean=` | `false` | 是否为禁用状态。 |
| `readonly` | `boolean=` | `false` | 是否为只读状态。 |
| `overlay-class` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
| `overlay-class` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
^^^ui
预设样式。

2
one/docs/components/collapse.md
View File

@ -21,7 +21,7 @@
| `label` | `string` | - | 折叠面板标题。 |
| `expanded` | `boolean=` | `false` | [^expanded] |
| `disabled` | `boolean=` | `false` | 是否为禁用状态。 |
| `name` | `string|number=` | - | 当内联在 [`Accordion`](./accordion) 组件中使用时，用来提供已展开面板的唯一标识。 |
| `name` | `string | number=` | - | 当内联在 [`Accordion`](./accordion) 组件中使用时，用来提供已展开面板的唯一标识。 |
^^^expanded
:::badges

4
one/docs/components/confirm-box.md
View File

@ -19,8 +19,8 @@
| `ok-label` | `string=` | - | “确定”按钮的文字内容。 |
| `cancel-label` | `string=` | - | “取消”按钮的文字内容。 |
| `before-close` | `function(string): boolean=|Promise<boolean=>` | - | 在将触发关闭的操作发生后执行，参考 [`Dialog`](./dialog) 组件的 [`before-close`](./dialog#props) 属性。 |
| `overlay-class` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
| `overlay-class` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
^^^open
:::badges

8
one/docs/components/date-picker.md
View File

@ -28,15 +28,15 @@
| -- | -- | -- | -- |
| `type` | `string` | `'date'` | 日历的类型，可用值为 `'date'`/`'month'`/`'year'`，分别对应日期/月/年视图。 |
| `range` | `boolean` | `false` | 是否选择日期范围。 |
| `selected` | `Date|Array` | - | [^selected] |
| `selected` | `Date | Array` | - | [^selected] |
| `today` | `Date` | `new Date()` | 「今天」的日期。 |
| `week-start` | `number` | `calendar.weekStart` | 一周的起始。可进行[全局配置](./calendar#全局配置)。 |
| `fill-month` | `boolean` | `true` | 当只有一个面板时，是否要在当前月份面板显示非本月日期。 |
| `date-class` | `string|Array|Object|function` | `{}` | 特定日期的自定义 HTML `class`。传非函数时，数据格式为所有 Vue 支持的 `class` 表达式；传函数时，签名为 `function(Date): string|Array<string>|Object<string, boolean>`，返回值格式亦为所有 Vue 支持的 `class` 表达式。 |
| `date-class` | `string | Array | Object | function` | `{}` | 特定日期的自定义 HTML `class`。传非函数时，数据格式为所有 Vue 支持的 `class` 表达式；传函数时，签名为 `function(Date): string | Array<string>|Object<string, boolean>`，返回值格式亦为所有 Vue 支持的 `class` 表达式。 |
| `disabled-date` | `function(Date, Date=): boolean=` | `() => false` | 用于自定义指定日期是否禁用。第一个参数为需要判断是否禁用的日期。当处于范围选择过程中且已经选择了一个日期，会作为第二个参数传入。 |
| `clearable` | `boolean` | `false` | 已选值是否可以清除。 |
| `placeholder` | `string` | `range ? datepicker.rangePlaceholder : datepicker.placeholder` | 未选择时的占位文本。可进行[全局配置](#全局配置)。 |
| `format` | `string|function(Date): string=` | `'yyyy-MM-dd'`/`'yyyy-MM'`/`'yyyy'` | 使用字符串时，表示用于格式化/解析的字符串表达式，具体格式可以参见 [date-fns 的文档](https://date-fns.org/v2.12.0/docs/format)。传入函数可自定义格式化逻辑。 |
| `format` | `string | function(Date): string=` | `'yyyy-MM-dd'`/`'yyyy-MM'`/`'yyyy'` | 使用字符串时，表示用于格式化/解析的字符串表达式，具体格式可以参见 [date-fns 的文档](https://date-fns.org/v2.12.0/docs/format)。传入函数可自定义格式化逻辑。 |
| `parse` | `function(string): Date=` | - | 自定义将输入字符串解析为 `Date` 对象的函数。 |
| `shortcuts` | `Array<Object>` | `datepicker.shortcuts` | [^shortcuts] |
| `expanded` | `boolean=` | `false` | [^expanded] |
@ -91,7 +91,7 @@
#### 快捷选项偏移量数据格式
`shortcuts` 列表项中的 `from` 及 `to` 字段格式相同，分别用来设置开始结束日期的计算方式。格式为 `number|Object`，默认值为 `0`。
`shortcuts` 列表项中的 `from` 及 `to` 字段格式相同，分别用来设置开始结束日期的计算方式。格式为 `number | Object`，默认值为 `0`。
* 类型为 `number` 时，表示以「今天」为基准，偏移指定天数，比如 `-1` 等价于 `{ startOf: 'day', days: -1 }`，即「昨天」；
* 类型为 `Object` 时，支持的格式为：`{startOf: string=, days: number=, weeks: number=, months: number=, }`。

2
one/docs/components/dialog.md
View File

@ -54,7 +54,7 @@
| `cancel-label` | `string=` | - | “取消”按钮的文字内容。 |
| `priority` | `number=` | - | 对话框浮层层叠权重，参考 [`Overlay`](./overlay) 组件的 [`priority`](./overlay#props) 属性。 |
| `before-close` | `function(string): boolean=|Promise<boolean=>` | - | [^before-close] |
| `overlay-class` | `string|Object=` | - | 对话框浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 |
| `overlay-class` | `string | Object=` | - | 对话框浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 |
^^^ui
预设样式。

2
one/docs/components/drawer.md
View File

@ -39,7 +39,7 @@
| `ok-label` | `string=` | - | “确定”按钮的文字内容。 |
| `cancel-label` | `string=` | - | “取消”按钮的文字内容。 |
| `before-close` | `function(string): boolean=|Promise<boolean=>` | - | 在将触发关闭的操作发生后执行，参考 [`Dialog`](./dialog) 组件的 [`before-close`](./dialog#props) 属性。 |
| `overlay-class` | `string|Object` | - | 抽屉浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 |
| `overlay-class` | `string | Object` | - | 抽屉浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 |
^^^ui
预设样式。

4
one/docs/components/dropdown.md
View File

@ -55,8 +55,8 @@
| `split` | `boolean=` | `false` | 是否将下拉按钮分离为指令按钮和切换下拉按钮两部分。 |
| `expanded` | `boolean=` | `false` | [^expanded] |
| `disabled` | `boolean=` | `false` | 是否为禁用状态。 |
| `overlay-class` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
| `overlay-class` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
^^^ui
预设样式。

2
one/docs/components/embedded.md
View File

@ -22,7 +22,7 @@
| `loading` | `boolean=` | `false` | 是否处于加载状态。处于加载状态时确定按钮也将进入加载状态，无法点击。 |
| `priority` | `number=` | - | 折叠式面板浮层层叠权重，参考 [`Overlay`](./overlay) 组件的 [`priority`](./overlay#props) 属性。 |
| `before-close` | `function(string): boolean=|Promise<boolean=>` | - | 在将触发折叠式面板关闭的操作发生后执行，参考 [`Dialog`](./dialog) 组件的 [`before-close`](./dialog#props) 属性。 |
| `overlay-class` | `string|Object=` | - | 折叠式面板浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 |
| `overlay-class` | `string | Object=` | - | 折叠式面板浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 |
^^^ui
预设样式。

6
one/docs/components/field.md
View File

@ -21,7 +21,7 @@
| `tip` | `string` | - | 表单项提示。 |
| `name` | `string` | - | 表单项名称，可用于指定数据字段名或展示错误消息的定位。 |
| `field` | `string` | - | [^field] |
| `rules` | `string|Array<Object>` | - | [^rules] |
| `rules` | `string | Array<Object>` | - | [^rules] |
^^^ui
预设样式。
@ -79,7 +79,7 @@ let minLengthRule = {
| `triggers` | `string` | 触发校验的事件名称集合，逗号分隔。 |
| `name` | `string` | 规则名称。 |
| `value` | `*` | 规则要匹配的值。`boolean` 类型的规则，默认为 `true`。 |
| `message` | `string|function` | [^message] |
| `message` | `string | function` | [^message] |
| `priority` | `number` | 规则优先级，可以覆盖规则默认优先级。 |
+++
@ -88,7 +88,7 @@ let minLengthRule = {
| -- | -- | -- |
| `required` | `boolean` | 值不能为空值（`null`/`undefined`/`''`/`[]`）。 |
| `numeric` | `boolean` | 值必须可描述十进制数值。(`6`/`66.6`/`6e6`/`'6'`/`.6`) |
| `pattern` | `RegExp|string` | 正则匹配。 |
| `pattern` | `RegExp | string` | 正则匹配。 |
| `maxLength` | `number` | 值的 `length` 属性不能大于限定值。 |
| `minLength` | `number` | 值的 `length` 属性不能小于限定值。 |
| `max` | `number` | 值不能大于限定值。 |

2
one/docs/components/form.md
View File

@ -57,7 +57,7 @@
| -- | -- | -- |
| `fields` | `Array` | 对应 `Field` 的 `field` 描述的集合。事件会绑定到对应 `Field` 中的输入组件上。 |
| `validate` | `function` | 自定义校验函数，传入参数为 `(data[fields[0]], data[fields[1]], ...)`，`data` 为表单 `data` 属性值的引用。返回 `undefined`/`true` 代表校验成功，返回 `{[field]: message, ...}` 表示校验失败信息，详见[表单 › 表单校验逻辑](#表单校验逻辑)。 |
| `triggers` | `string|Array<string>` | 事件名称集合。 |
| `triggers` | `string | Array<string>` | 事件名称集合。 |
+++

2
one/docs/components/input.md
View File

@ -36,7 +36,7 @@
| `composition` | `boolean=` | `false` | 是否感知输入法输入过程的值。 |
| `select-on-focus` | `boolean=` | `false` | 聚焦时是否自动选中输入框文本。 |
| `get-length` | `function(string): number=` | 自定义的字符长度计算函数。 |
| `trim` | `boolean|string=` | `false` | [^trim] |
| `trim` | `boolean | string=` | `false` | [^trim] |
^^^ui
预设样式。

2
one/docs/components/lightbox.md
View File

@ -19,7 +19,7 @@
| `escapable` | `boolean=` | `true` | 按下 <kbd>esc</kbd> 键是否可以关闭浮层。仅在 `closable` 为 `true` 时生效。 |
| `priority` | `number=` | - | 浮层层叠权重，参考 [`Overlay`](./overlay) 组件的 [`priority`](./overlay#props) 属性。 |
| `before-close` | `function(string): boolean=|Promise<boolean=>` | - | [^before-close] |
| `overlay-class` | `string|Array|Object=` | - | 浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 |
| `overlay-class` | `string | Array | Object=` | - | 浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 |
| `indicator` | `string=` | `'number'` | [^indicator] |
| `options` | `Object=` | `{ video: { muted: true, autoplay: true, controls: true } }` | 额外配置。 |

2
one/docs/components/link.md
View File

@ -11,7 +11,7 @@
| 名称 | 类型 | 默认值 | 描述 |
| -- | -- | -- | -- |
| `ui` | `string=` | - | [^ui] |
| `to` | `string|Object` | - | 链接路径。当配合 Vue Router 使用时，会透传到 [`<router-link>`](https://router.vuejs.org/api/#router-link) 的[同名属性](https://router.vuejs.org/api/#to)；否则只支持 `string` 类型，输出到 `<a>` 元素的 `href` 属性中。 |
| `to` | `string | Object` | - | 链接路径。当配合 Vue Router 使用时，会透传到 [`<router-link>`](https://router.vuejs.org/api/#router-link) 的[同名属性](https://router.vuejs.org/api/#to)；否则只支持 `string` 类型，输出到 `<a>` 元素的 `href` 属性中。 |
| `rel` | `string` | - | HTML 原生的链接类型，可参考 [MDN 的相关介绍](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Link_types)。 |
| `target` | `string` | - | [^target] |
| `native` | `boolean` | `false` | 是否强制使用原生的 `<a>` 元素。 |

4
one/docs/components/menu.md
View File

@ -56,7 +56,7 @@
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `label` | `string` | 节点的文字描述。 |
| `to` | `string|Object` | 节点的导航目的地。参考 [`Link`](./link) 组件的 [`to`](./link#props) 属性。 |
| `to` | `string | Object` | 节点的导航目的地。参考 [`Link`](./link) 组件的 [`to`](./link#props) 属性。 |
| `name` | `string` | 节点的唯一标识，`name` 和 `to` 二者至少有一个存在。 |
| `disabled` | `boolean=` | 节点是否被禁用。 |
| `icon` | `string|{render: function}` | 首层节点使用的图标。 |
@ -105,7 +105,7 @@
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `label` | `string` | 图标名称。 |
| `to` | `string|Object` | 节点的导航目的地。参考 [`Link`](./link) 组件的 [`to`](./link#props) 属性。 |
| `to` | `string | Object` | 节点的导航目的地。参考 [`Link`](./link) 组件的 [`to`](./link#props) 属性。 |
| `name` | `string` | 节点的唯一标识，`name` 和 `to` 二者至少有一个存在。 |
| `disabled` | `boolean=` | 节点是否被禁用。 |
| `icon` | `string` | 首层节点使用的图标。 |

4
one/docs/components/option-group.md
View File

@ -17,8 +17,8 @@
| `label` | `string` | - | 选项组的标题。 |
| `options` | `Array<Object>` | `[]` | [^options] |
| `position` | `string` | `inline` | [^position] |
| `overlay-class` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
| `overlay-class` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
^^^options
选项列表，项目的类型为 `{label, value, disabled, ...}`。

8
one/docs/components/overlay.md
View File

@ -36,14 +36,14 @@
| -- | -- | -- | -- |
| `ui` | `string=` | - | 预设样式。`veui-theme-dls` 未提供，可自定义。 |
| `open` | `boolean` | `false` | [^open] |
| `target` | `string|Vue|Element` | - | [^target] |
| `target` | `string | Vue | Element` | - | [^target] |
| `priority` | `number` | - | [^priority] |
| `autofocus` | `boolean` | - | 是否自动抢占焦点到浮层内的第一个可聚焦元素。 |
| `modal` | `boolean` | `false` | 是否是模态浮层。模态浮层会抢占焦点且限制键盘导航处于浮层内部（关闭后焦点会回归）。 |
| `inline` | `boolean` | `false` | 是否将浮层渲染为内联内容。 |
| `local` | `boolean` | `false` | 是否将浮层保留在原来的 DOM 位置，而非移动到全局位置并参与[全局浮层管理](../advanced/overlay)。 |
| `overlay-class` | `string|Array|Object=` | - | [^overlay-class] |
| `overlay-style` | `string|Array|Object=` | - | [^overlay-style] |
| `overlay-class` | `string | Array | Object=` | - | [^overlay-class] |
| `overlay-style` | `string | Array | Object=` | - | [^overlay-style] |
| `options` | `Object` | 透传给底层 Popper.js 实现的 `modifiers` 配置项，具体内容参见[这里](https://popper.js.org/docs/v1/#modifiers)。 |
^^^open
@ -103,4 +103,4 @@
| 配置项 | 类型 | 默认值 | 描述 |
| -- | -- | -- | -- |
| `overlay.overlayClass` | `string|Array|Object=` | `[]` | 全局配置需要添加到浮层容器上的类名，数据格式为所有 [Vue 支持的 `class` 表达式](https://cn.vuejs.org/v2/guide/class-and-style.html#%E7%BB%91%E5%AE%9A-HTML-Class)。 |
| `overlay.overlayClass` | `string | Array | Object=` | `[]` | 全局配置需要添加到浮层容器上的类名，数据格式为所有 [Vue 支持的 `class` 表达式](https://cn.vuejs.org/v2/guide/class-and-style.html#%E7%BB%91%E5%AE%9A-HTML-Class)。 |

2
one/docs/components/pagination.md
View File

@ -21,7 +21,7 @@
| `ui` | `string=` | - | [^ui] |
| `page` | `number` | `1` | 当前页码（从 `1` 开始）。 |
| `total` | `number` | - | 总页数。 |
| `to` | `string|Object` | `''` | [^to] |
| `to` | `string | Object` | `''` | [^to] |
| `native` | `boolean` | `false` | 原生链接跳转。 |
| `page-size` | `number` | `pagination.pageSize` | [^page-size] |
| `page-sizes` | `Array` | `pagination.pageSizes` | 每页个数候选项。 |

6
one/docs/components/popover.md
View File

@ -28,12 +28,12 @@
| -- | -- | -- | -- |
| `ui` | `string=` | - | [^ui] |
| `open` | `boolean` | `false` | [^open] |
| `target` | `string|Vue|Node` | - | 参考 [`Overlay`](./overlay) 组件的 `target` 属性。 |
| `target` | `string | Vue | Node` | - | 参考 [`Overlay`](./overlay) 组件的 `target` 属性。 |
| `position` | `string` | `'top'` | [^position] |
| `trigger` | `string` | `'hover'` | [^trigger] |
| `hide-delay` | `number` | `tooltip.hideDelays` | 触发关闭条件满足后延迟关闭等待时间的毫秒数。可以用来防止光标移出 `target` 后移入气泡进行交互前已经自动关闭。 |
| `overlay-class` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
| `overlay-class` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
^^^ui
预设样式。

2
one/docs/components/progress.md
View File

@ -18,7 +18,7 @@
| `max` | `number` | `1` | 最大值。 |
| `decimal-place` | `number` | `0` | 保留的小数位数。 |
| `status` | `string` | - | [^status] |
| `autosucceed` | `boolean|number` | - | 是否在进度值到达最大时自动进入 `success` 状态。`true` 表示直接进入成功状态，如果是 `number` 类型则表示在到达最大值后切换为成功状态前等待的毫秒数。 |
| `autosucceed` | `boolean | number` | - | 是否在进度值到达最大时自动进入 `success` 状态。`true` 表示直接进入成功状态，如果是 `number` 类型则表示在到达最大值后切换为成功状态前等待的毫秒数。 |
| `indeterminate` | `boolean` | `false` | 是否不确定进度，目前仅支持在 `type` 为 `bar` 时生效。 |

4
one/docs/components/prompt-box.md
View File

@ -21,8 +21,8 @@
| `ok-label` | `string=` | - | “确定”按钮的文字内容。 |
| `cancel-label` | `string=` | - | “取消”按钮的文字内容。 |
| `before-close` | `function(string): boolean=|Promise<boolean=>` | - | 在将触发关闭的操作发生后执行，参考 [`Dialog`](./dialog) 组件的 [`before-close`](./dialog#props) 属性。 |
| `overlay-class` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
| `overlay-class` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
^^^open
:::badges

4
one/docs/components/schedule.md
View File

@ -11,7 +11,7 @@
| 名称 | 类型 | 默认值 | 描述 |
| -- | -- | -- | -- |
| `selected` | `Object` | - | [^selected] |
| `hour-class` | `string|Array|Object|function` | `{}` | 特定小时的自定义 HTML `class`。传非函数时，数据格式为所有 [Vue 支持的 `class` 表达式](https://cn.vuejs.org/v2/guide/class-and-style.html#%E7%BB%91%E5%AE%9A-HTML-Class)；传函数时，签名为 `function(day: number, hour: number): string|Array<string>|Object<string, boolean>`，返回值格式亦为所有 Vue 支持的 `class` 表达式。 |
| `hour-class` | `string | Array | Object | function` | `{}` | 特定小时的自定义 HTML `class`。传非函数时，数据格式为所有 [Vue 支持的 `class` 表达式](https://cn.vuejs.org/v2/guide/class-and-style.html#%E7%BB%91%E5%AE%9A-HTML-Class)；传函数时，签名为 `function(day: number, hour: number): string | Array<string>|Object<string, boolean>`，返回值格式亦为所有 Vue 支持的 `class` 表达式。 |
| `disabled-date` | `function(number, number): boolean` | `() => false` | 特定小时是否禁用。参数类型为 `(day: number, hour: number)`，分别表示一周的第几天（`0` 表示周日）及对应的小时数。 |
| `shortcuts` | `Array` | `schedule.shortcuts` | [^shortcuts] |
| `shortcuts-display` | `string` | `'inline'` | 快捷选择项的显示方式，支持 `inline`/`popup`，分别对应内联按钮组与下拉选择。 |
@ -46,7 +46,7 @@
^^^
^^^shortcuts
快捷选择选项列表。类型为 `{label: string, selected: boolean|Array}`。
快捷选择选项列表。类型为 `{label: string, selected: boolean | Array}`。
`label` 为显示的提示文字。`selected` 表示预选择的时段，类型为数组时，格式与 `selected` 属性相同；值为 `true` 时等同于 `[[0, 23]]`。
^^^

4
one/docs/components/select.md
View File

@ -48,8 +48,8 @@
| `expanded` | `boolean=` | `false` | [^expanded] |
| `disabled` | `boolean=` | `false` | 是否为禁用状态。 |
| `readonly` | `boolean=` | `false` | 是否为只读状态。 |
| `overlay-class` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string|Array|Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
| `overlay-class` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#属性) 属性。 |
| `overlay-style` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#属性) 属性。 |
^^^ui
预设样式。

2
one/docs/components/slider.md
View File

@ -46,7 +46,7 @@
| -- | -- | -- | -- |
| `ui` | `string=` | - | [^ui] |
| `value` | `*|Array<*>` | - | [^value] |
| `secondary-progress` | `number|Array<number>` | `0` | 次要条。 |
| `secondary-progress` | `number | Array<number>` | `0` | 次要条。 |
| `min` | `number` | `0` | `value` 经过 `parse` 函数处理后允许的最小值。 |
| `max` | `number` | `1` | `value` 经过 `parse` 函数处理后允许的最大值。 |
| `step` | `number` | `0` | `value` 经过 `parse` 函数处理后的步进值。 |

4
one/docs/components/steps.md
View File

@ -45,7 +45,7 @@
| -- | -- | -- |
| `label` | `string` | 步骤标题。 |
| `desc` | `string` | 步骤描述。 |
| `to` | `string|Object` | 步骤链接。类型见 [`Link`](./link#属性) 组件的同名属性。 |
| `to` | `string | Object` | 步骤链接。类型见 [`Link`](./link#属性) 组件的同名属性。 |
| `status` | `string` | 步骤状态。可选值为默认和 `error`。 |
+++
^^^
@ -69,7 +69,7 @@
| -- | -- | -- |
| `label` | `string` | 步骤标题。同 `steps` 属性中项目的 `label` 字段。 |
| `desc` | `string` | 步骤描述。同 `steps` 属性中项目的 `desc` 字段。 |
| `to` | `string|Object` | 步骤链接。同 `steps` 属性中项目的 `to` 字段。 |
| `to` | `string | Object` | 步骤链接。同 `steps` 属性中项目的 `to` 字段。 |
| `status` | `string` | 步骤状态。同 `steps` 属性中项目的 `status` 字段。 |
| `index` | `number` | 步骤索引值。 |

2
one/docs/components/tab.md
View File

@ -17,7 +17,7 @@
| `label` | `string` | - | 选项卡文本。 |
| `name` | `string` | - | 选项卡名称。 |
| `disabled` | `boolean=` | `false` | 选项卡是否禁用。 |
| `to` | `string|Object` | - | [^to] |
| `to` | `string | Object` | - | [^to] |
| `matches` | `function(Route, Route): boolean` | - | [^matches] |
| `native` | `boolean` | `false` | 路由模式是否强制使用原生的 `<a>` 元素。 |
| `removable` | `boolean` | | 是否可删除。 |

6
one/docs/components/table.md
View File

@ -62,7 +62,7 @@
| `selected` | `Array<*>|*` | `[]` | [^selected] |
| `expandable` | `boolean` | `false` | 是否允许展开行。 |
| `expanded` | `Array<*>` | `[]` | [^expanded] |
| `order` | `string|boolean` | `false` | 排序顺序。为 `false` 时表示无序，为字符串值 `'asc'`/`'desc'` 时分别为升序/降序。 |
| `order` | `string | boolean` | `false` | 排序顺序。为 `false` 时表示无序，为字符串值 `'asc'`/`'desc'` 时分别为升序/降序。 |
| `order-by` | `string` | - | 用于指定当前基于哪一列进行了排序，值必须来自内部某个 `Column` 组件的 `field` 属性。 |
| `scroll` | `number` | - | 指定滚动区域的最大高度，当超出此高度时，表格将进入固定表头和底部只允许数据区域滚动的模式。 |
| `loading` | `boolean` | `false` | 指定表格是否处于加载状态。 |
@ -140,7 +140,7 @@
| -- | -- | -- |
| `selected` | `boolean` | `true` 表示已选择，`false` 则表示取消选择。 |
| `item` | `Object` | 选择状态发生变化的 `data` 属性中的数据项。当存在纵向合并单元格且以相应行作为键进行选择时，将返回第一条相关的 `data` 数据项。 |
| `selectedItems` | `Object<string, Object|Array>` | 当前所有已选项的信息，键为 `key-field` 对应字段，值为对应的 `data` 数据项。当存在纵向合并单元格且以相应行作为键进行选择时，值为所有相关行数据项组成的数组。 |
| `selectedItems` | `Object<string, Object | Array>` | 当前所有已选项的信息，键为 `key-field` 对应字段，值为对应的 `data` 数据项。当存在纵向合并单元格且以相应行作为键进行选择时，值为所有相关行数据项组成的数组。 |
+++
^^^
@ -151,6 +151,6 @@
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `field` | `string` | 基于哪一列进行排序。值来自对应 `Column` 组件的 `field` 属性。 |
| `order` | `string|boolean` | 同 [`order` 属性](#属性)。 |
| `order` | `string | boolean` | 同 [`order` 属性](#属性)。 |
+++
^^^

2
one/docs/components/textarea.md
View File

@ -31,7 +31,7 @@
| `disabled` | `boolean=` | `false` | 文本域是否为禁用状态。 |
| `readonly` | `boolean=` | `false` | 文本域是否为只读状态。 |
| `line-number` | `boolean` | `false` | 是否显示行号。 |
| `rows` | `number|string` | - | 默认情况下文本域可视行数。 |
| `rows` | `number | string` | - | 默认情况下文本域可视行数。 |
| `placeholder` | `string` | - | 输入占位符。 |
| `composition` | `boolean` | `false` | 是否感知输入法输入过程的值。 |
| `select-on-focus` | `boolean` | `false` | 聚焦时是否自动选中文本域文本。 |

2
one/docs/components/transfer.md
View File

@ -36,7 +36,7 @@
| `candidate-label` | `string=` | - | “待选项”标题的文字内容。 |
| `selected-label` | `string=` | - | “已选项”标题的文字内容。 |
| `selected-show-mode` | `string=` | `'tree'` | [^selected-show-mode] |
| `keys` | `string|function` | `'value'` | [^keys] |
| `keys` | `string | function` | `'value'` | [^keys] |
| `merge-checked` | `string=` | `keep-all` | [^merge-checked] |
^^^ui

10
one/docs/components/uploader.md
View File

@ -40,7 +40,7 @@
| --- | --- | --- | --- |
| `ui` | `string=` | - | [^ui] |
| `type` | `string` | `'file'` | [^type] |
| `value` | `Object|Array<Object>` | - | [^value] |
| `value` | `Object | Array<Object>` | - | [^value] |
| `key-field` | `string` | `'key'` | 用于指定文件对象的唯一 key，作为数据变化时正确处理文件列表顺序的依据。 |
| `name` | `string` | `'file'` | 原生 `<input>` 元素的 `name`。 |
| `action` | `string` | - | 上传地址。 |
@ -53,8 +53,8 @@
| `convert-response` | `uploader.convertResponse` | - | [^convert-response] |
| `accept` | `string` | - | 与原生 `<input>` 元素 的 `accept` 相同，在浏览器的文件类型筛选后再加一层校验。对于类似 `application/msword` 这样的 MIME type 与扩展名对不上的情形跳过校验。 |
| `max-count` | `number` | - | 最大文件数量。 |
| `max-size` | `number|string` | - | 单个文件的最大大小，如果是 `number`，单位是 `byte`；如果是 `string`，支持在数字后面添加单位，单位可以是 `b`/`kb`/`mb`/`gb`/`tb`。 |
| `validator` | `function(Object): Object|Promise<Object>` | - | [^validator] |
| `max-size` | `number | string` | - | 单个文件的最大大小，如果是 `number`，单位是 `byte`；如果是 `string`，支持在数字后面添加单位，单位可以是 `b`/`kb`/`mb`/`gb`/`tb`。 |
| `validator` | `function(Object): Object | Promise<Object>` | - | [^validator] |
| `payload` | `Object` | - | 附带在上传请求中的额外参数。 |
| `autoupload` | `boolean` | `true` | 指定是否在选完文件后立刻上传。 |
| `order` | `string` | `'asc'` | [^order] |
@ -262,7 +262,7 @@
+++参数详情
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `value` | `Object|Array<Object>` | 组件的 `value` 的值。 |
| `value` | `Object | Array<Object>` | 组件的 `value` 的值。 |
+++
^^^
@ -301,7 +301,7 @@
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `type` | `string` | 校验失败的类型，类型枚举值可从 `Uploader.errors` 对象获取，如 `Uploader.errors.SIZE_INVALID`。 |
| `value` | `number|string|Object` | 没有通过校验的值，根据 `type` 的不同有不同的类型。 |
| `value` | `number | string | Object` | 没有通过校验的值，根据 `type` 的不同有不同的类型。 |
| `message` | `string` | 检验失败的提示信息。 |
+++