docs: add more docs

Change-Id: Ib18b92ff647ce1eed4676d84d994c51105393bea
This commit is contained in:
xiaodemen 2022-03-24 18:40:01 +08:00 committed by GU Yiling
parent aa9ad39d79
commit f098a1bb8c
16 changed files with 84 additions and 1 deletions

View File

@ -7,6 +7,8 @@ export default {
'ui',
'name',
'invalid',
'disabled',
'readonly',
'overlayClass',
'overlayStyle',
'overlayPriority',
@ -36,5 +38,20 @@ export default {
},
link: {
props: ['replace']
},
pagination: {
props: ['goto']
},
option: {
props: ['tag']
},
nav: {
slots: ['more']
},
input: {
emits: ['autofill']
},
progress: {
props: ['radius', 'strokeWidth']
}
}

View File

@ -32,6 +32,7 @@
| ``closable`` | `boolean` | `true` | 是否显示关闭按钮。 |
| ``outside-closable`` | `boolean` | `false` | 点击抽屉外部时是否关闭抽屉。 |
| ``escapable`` | `boolean` | `false` | 按下 <kbd>esc</kbd> 键是否可以关闭抽屉。仅在 `closable``true` 时生效。 |
| ``priority`` | `number=` | - | 抽屉浮层层叠权重,参考 [`Overlay`](./overlay) 组件的 [`priority`](./overlay#props-priority) 属性。 |
| ``footless`` | `boolean` | `false` | 是否不显示默认的底部操作栏。 |
| ``loading`` | `boolean=` | `false` | 是否处于加载状态。处于加载状态时确定按钮也将进入加载状态,无法点击。 |
| ``disabled`` | `boolean=` | `false` | 是否处于禁用状态。处于禁用状态时确定按钮也将进入禁用状态,无法点击。 |

View File

@ -55,6 +55,8 @@
| ``split`` | `boolean=` | `false` | 是否将下拉按钮分离为指令按钮和切换下拉按钮两部分。 |
| ``expanded`` | `boolean=` | `false` | [^expanded] |
| ``disabled`` | `boolean=` | `false` | 是否为禁用状态。 |
| ``searchable`` | `boolean=` | `false` | 是否可搜索。 |
| ``placeholder`` | `string=` | - | 搜索框的输入占位符。 |
| ``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#自定义搜索逻辑)。 |
@ -106,6 +108,7 @@
| ``option-label`` | [^slot-option-label] |
| ``option`` | [^slot-option] |
| ``trigger`` | [^slot-trigger] |
| ``no-data`` | 用于定义当搜索无数据时要展现的内容。 |
^^^slot-label
下拉按钮文本区域。

View File

@ -49,6 +49,8 @@
| ``select-on-focus`` | `boolean=` | `false` | 聚焦时是否自动选中输入框文本。 |
| ``get-length`` | `function(string): number=` | 自定义的字符长度计算函数。 |
| ``trim`` | `boolean | string=` | `false` | [^trim] |
| ``maxlength`` | `number=` | - | 最大可输入的字符长度。 |
| ``strict`` | `boolean=` | `false` | 是否超出最大字符长度后不允许继续输入。 |
^^^ui
预设样式。
@ -113,6 +115,7 @@
| -- | -- |
| ``change`` | [^event-change] |
| ``input`` | [^event-input] |
| ``clear`` | 点击清除按钮时触发。 |
^^^event-change
输入框内容变化时触发,即原生 `change` 事件触发时。回调参数为 `(value, event)`

View File

@ -23,6 +23,7 @@
| ``overlay-class`` | `string | Array | Object=` | - | 浮层根元素类名,参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props-overlay-class) 属性。 |
| ``indicator`` | `string=` | `'number'` | [^indicator] |
| ``options`` | `Object=` | `{ video: { muted: true, autoplay: true, controls: true } }` | 额外配置。 |
| ``lazy`` | `boolean= | { preload: number }` | `false` | [^lazy] |
^^^open
:::badges
@ -72,6 +73,18 @@
```
^^^
^^^lazy
指定是否懒加载轮播资源。
+++详情
| 名称 | 描述 |
| -- | -- | -- |
| `false` | 不懒加载资源。 |
| `true` | 预加载当前展示项目的前后 1 个资源。 |
| `{ preload: number }` | 预加载当前展示项目的前后指定数量个资源。 |
+++
^^^
### 插槽
| 名称 | 描述 |

View File

@ -28,6 +28,8 @@
## API
### 属性
| 名称 | 类型 | 默认值 | 描述 |
| -- | -- | -- | -- |
| ``ui`` | `string=` | - | [^ui] |

View File

@ -28,7 +28,9 @@
### 事件
在选项被点击时触发 `click` 事件,没有参数。
| 名称 | 描述 |
| -- | -- |
| ``click`` | 在选项被点击时触发 `click` 事件,没有参数。 |
### 图标

View File

@ -45,6 +45,8 @@
| ``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)。 |
| ``position`` | `string` | 'auto' | 透传给底层 Popper.js 实现的 `placement` 配置项,具体内容参见[这里](https://popper.js.org/docs/v1/#popperplacements--codeenumcode)。 |
| ``match-width`` | `boolean` | `false` | 当浮层宽度较窄时,是否自动匹配目标元素的宽度。 |
^^^open
:::badges
@ -98,6 +100,7 @@
| ``locate`` | 浮层定位发生变化时触发。 |
| ``afteropen`` | 浮层打开后触发。浮层内容在打开后才会进行渲染,所以如果有依赖内容渲染的逻辑,请在此事件触发后再执行。 |
| ``afterclose`` | 浮层关闭后触发。如果样式主题提供了退出动画,将在退出动画完毕后触发。 |
| ``orderchange`` | 浮层的 `z-index` 发生变化时触发,参数是 `(order: number)`, `order` 就是新的 `z-index`。 |
### 全局配置

View File

@ -83,3 +83,10 @@
| ``default`` | 气泡提示内容。 |
| ``title`` | 用于自定义标题内容。 |
| ``foot`` | 用于自定义底部操作区。 |
### 事件
| 名称 | 描述 |
| -- | -- |
| ``ok`` | 点击“确定”按钮时触发。 |
| ``cancel`` | 点击“取消”按钮时触发。 |

View File

@ -46,6 +46,7 @@
| 名称 | 描述 |
| -- | -- |
| ``default`` | [^slot-default] |
| ``after`` | 可用来定制文字提示区域之后的内容,作用域参数参考 `default` 插槽。 |
^^^slot-default
可用来定制文字提示区域的内容。

View File

@ -105,6 +105,9 @@
| ``suggestions-before`` | 插入推荐列表前的内容。 |
| ``suggestions-after`` | 插入推荐列表后的内容。 |
| ``suggestion`` | [^slot-suggestion] |
| ``clear`` | 点击清除按钮时触发。 |
| ``group-label`` | 可以参考 [`Select`](./select) 组件的 [`group-label`](./select#props-group-label) 属性。 |
| ``option-label`` | 可以参考 [`Select`](./select) 组件的 [`option-label`](./select#props-option-label) 属性。 |
^^^slot-suggestions
推荐列表内容。

View File

@ -57,6 +57,7 @@
| ``expanded`` | `boolean=` | `false` | [^expanded] |
| ``disabled`` | `boolean=` | `false` | 是否为禁用状态。 |
| ``readonly`` | `boolean=` | `false` | 是否为只读状态。 |
| ``composition`` | `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 | [number, number] | Array<[number, number]>` | - | 支持自定义高亮逻辑, 默认大小写不敏感,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)。 |
@ -117,6 +118,7 @@
| ``option`` | [^slot-option] |
| ``trigger`` | [^slot-trigger] |
| ``selected`` | [^slot-selected] |
| ``no-data`` | 用于定义当搜索无数据时要展现的内容。 |
^^^slot-before
选项列表前的内容。无默认内容。
@ -250,6 +252,8 @@
| ``input`` | 输入搜索关键词时触发。回调参数为 `(value: string)``value` 为输入框的 `value` 值。 |
| ``change`` | [^event-change] |
| ``toggle`` | 下拉菜单展开状态切换时触发,回调参数为 `(expanded: boolean)`。`expanded` 表示操作将触发下拉菜单展开还是收起。 |
| ``clear`` | 点击清除按钮时触发。 |
| ``afteropen`` | 下拉打开完成之后触发。 |
^^^event-change
:::badges

View File

@ -89,6 +89,8 @@
| ``scroll`` | `number` | - | 指定滚动区域的最大高度,当超出此高度时,表格将进入固定表头和底部只允许数据区域滚动的模式。 |
| ``loading`` | `boolean` | `false` | 指定表格是否处于加载状态。 |
| ``allowed-orders`` | `Array` | `[false, 'desc', 'asc']` | [^allowed-orders] |
| ``bordered`` | `boolean` | `false` | 指定表格是否有边框。 |
| ``column-filter`` | `Array<string>` | - | 用于过滤表格的列,元素的值应该是列的 `key-field`,默认全部列都显示出来。 |
^^^ui
预设样式。

View File

@ -43,6 +43,9 @@
| ``select-on-focus`` | `boolean` | `false` | 聚焦时是否自动选中文本域文本。 |
| ``autoresize`` | `boolean` | `false` | 高度是否会被内容撑开。 |
| ``get-length`` | `function(string): number=` | 自定义的字符长度计算函数。 |
| ``resizable`` | `boolean=` | 指定是否可以调节长宽。 |
| ``maxlength`` | `number=` | - | 最大可输入的字符长度。 |
| ``strict`` | `boolean=` | `false` | 是否超出最大字符长度后不允许继续输入。 |
^^^ui
预设样式。

View File

@ -22,8 +22,10 @@
| -- | -- | -- | -- |
| ``open`` | `boolean` | `false` | [^open] |
| ``type`` | `string` | `'success'` | [^type] |
| ``title`` | `string` | - | 消息标题。 |
| ``message`` | `string` | - | 消息内容。 |
| ``duration`` | `number` | `toast.duration` | 消息展示时间毫秒数,超过此事件则消息提示自动关闭。 |
| ``closable`` | `boolean` | - | 是否有关闭按钮。 |
^^^open
:::badges
@ -51,12 +53,14 @@
| 名称 | 描述 |
| -- | -- |
| ``default`` | 内容区。默认显示 [`message`](#props-message) 属性的内容。 |
| ``title`` | 标题区。默认显示 [`title`](#props-title) 属性的内容。 |
### 事件
| 名称 | 描述 |
| -- | -- |
| ``close`` | 消息自动关闭后触发。 |
| ``ready`` | 组件挂载之后会触发该事件。 |
### 全局配置

View File

@ -33,6 +33,7 @@
| ``aim-center`` | `boolean` | `false` | 指定浮层提示箭头是否始终指向目标元素中心。 |
| ``trigger`` | `string` | `'hover'` | [^trigger] |
| ``interactive`` | `boolean` | `true` | 浮层内容是否允许交互。如果为 `false` 则在 `target` 外满足 `trigger` 指定的条件浮层即自动关闭。 |
| ``autofocus`` | `boolean` | - | 是否自动抢占焦点到浮层内的第一个可聚焦元素。 |
| ``hide-delay`` | `number` | `tooltip.hideDelays` | 触发关闭条件满足后延迟关闭等待时间的毫秒数。可以用来防止光标移出 `target` 后移入浮层进行交互前已经自动关闭。 |
| ``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) 属性。 |
@ -73,6 +74,20 @@
| -- | -- |
| ``default`` | 浮层提示内容。 |
### 事件
| 名称 | 描述 |
| -- | -- |
| ``toggle`` | [^event-toggle] |
^^^event-toggle
:::badges
`v-model`
:::
浮层提示展开状态切换时触发,回调参数为 `(open: boolean)`
^^^
### 全局配置
| 配置项 | 类型 | 默认值 | 描述 |