feat: add link for individual props/events/slots/configs/icons

This commit is contained in:
Justineo
2021-10-20 01:11:27 +08:00
parent df2b6892d2
commit b0dcdbb873
162 changed files with 2176 additions and 2073 deletions

View File

@@ -8,37 +8,37 @@
### 样式
可选的样式 `ui` 属性值: `primary`/`text`
可选的样式 [`ui`](#props-ui) 属性值: `primary` / `text`
[[ demo src="/demo/dropdown/style.vue" ]]
### 尺寸
可选的尺寸 `ui` 属性值:`xs`/`s`/`m`/`l`
可选的尺寸 [`ui`](#props-ui) 属性值:`xs` / `s` / `m` / `l`
[[ demo src="/demo/dropdown/size.vue" ]]
### 内联模式
`Dropdown` 组件内支持内联使用 `OptionGroup``Option` 组件来代替 `options` 属性。
`Dropdown` 组件内支持内联使用 `OptionGroup``Option` 组件来代替 [`options`](#props-options) 属性。
[[ demo src="/demo/dropdown/inline.vue" ]]
### 含搜索的下拉框菜单
使用 `searchable` 属性使组件支持搜索并高亮显示符合条件的选项。
使用 [`searchable`](#props-searchable) 属性使组件支持搜索并高亮显示符合条件的选项。
[[ demo src="/demo/dropdown/searchable.vue" ]]
### 禁用状态的下拉框菜单
使用数据源中的 `disabled` 属性来禁用下拉项。
使用数据源中的 [`disabled`](#props-disabled) 属性来禁用下拉项。
[[ demo src="/demo/dropdown/disable.vue" ]]
### 下拉触发时机与分离按钮
使用 `trigger` 属性指定展开下拉菜单的时机,使用 `split` 属性来使命令按钮与下拉按钮分离。
使用 [`trigger`](#props-trigger) 属性指定展开下拉菜单的时机,使用 [`split`](#props-split) 属性来使命令按钮与下拉按钮分离。
[[ demo src="/demo/dropdown/other.vue" ]]
@@ -48,15 +48,15 @@
| 名称 | 类型 | 默认值 | 描述 |
| -- | -- | -- | -- |
| `ui` | `string=` | - | [^ui] |
| `options` | `Array<Object>=` | `[]` | [^options] |
| `label` | `string` | - | 下拉按钮的描述文本。 |
| `trigger` | `string=` | `'click'` | 触发下拉框展开的时机,可选值为 `'click'`/`'hover'`。 |
| `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#属性) 属性。 |
| ``ui`` | `string=` | - | [^ui] |
| ``options`` | `Array<Object>=` | `[]` | [^options] |
| ``label`` | `string` | - | 下拉按钮的描述文本。 |
| ``trigger`` | `string=` | `'click'` | 触发下拉框展开的时机,可选值为 `'click'` / `'hover'`。 |
| ``split`` | `boolean=` | `false` | 是否将下拉按钮分离为指令按钮和切换下拉按钮两部分。 |
| ``expanded`` | `boolean=` | `false` | [^expanded] |
| ``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) 属性。 |
^^^ui
预设样式。
@@ -81,7 +81,7 @@
| -- | -- | -- |
| `label` | `string` | 选项的文字说明。 |
| `value` | `*` | 选项对应的值。 |
| `options` | `Array<Object>=` | 选项的子选项数组,数组项类型同 `options` 属性数组项。 |
| `options` | `Array<Object>=` | 选项的子选项数组,数组项类型同 [`options`](#props-options) 属性数组项。 |
| `disabled` | `boolean=` | 选项是否为禁用。 |
+++
^^^
@@ -98,14 +98,14 @@
| 名称 | 描述 |
| -- | -- |
| `default` | 选项列表的内容。在没有指定 `options` 属性时,可以用来直接内联 `Option``OptionGroup`。 |
| `before` | 选项列表前的内容。无默认内容。 |
| `after` | 选项列表后的内容。无默认内容。 |
| `label` | [^slot-label] |
| `group-label` | [^slot-group-label] |
| `option-label` | [^slot-option-label] |
| `option` | [^slot-option] |
| `trigger` | [^slot-trigger] |
| ``default`` | 选项列表的内容。在没有指定 [`options`](#props-options) 属性时,可以用来直接内联 `Option` 或 `OptionGroup`。 |
| ``before`` | 选项列表前的内容。无默认内容。 |
| ``after`` | 选项列表后的内容。无默认内容。 |
| ``label`` | [^slot-label] |
| ``group-label`` | [^slot-group-label] |
| ``option-label`` | [^slot-option-label] |
| ``option`` | [^slot-option] |
| ``trigger`` | [^slot-trigger] |
^^^slot-label
下拉按钮文本区域。
@@ -174,7 +174,7 @@
+++作用域参数
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `attrs` | `Object` | 需要输出到触发元素上的属性,包括 `aria-*`/`disabled` 等,可以使用 `v-bind="attrs"` 统一进行输出。 |
| `attrs` | `Object` | 需要输出到触发元素上的属性,包括 `aria-*` / `disabled` 等,可以使用 `v-bind="attrs"` 统一进行输出。 |
| `handlers` | `Object` | [^handlers-desc] |
| `expanded` | `boolean` | 下拉菜单是否展开。 |
| `toggle` | `function(force?: boolean): void` | 用于切换下拉菜单展开状态。 |
@@ -193,12 +193,12 @@
| 名称 | 描述 |
| -- | -- |
| `click` | 点击选项后触发,回调参数为 `(value: *=)``value` 为当前已选项 `value` 字段的值。当 `split` 属性为 `true` 时,直接点击指令按钮部分也会触发,但不会携带 `value` 参数。 |
| `toggle` | 下拉菜单展开状态切换时触发,回调参数为 `(expanded: boolean)``expanded` 表示操作将触发下拉菜单展开还是收起。 |
| ``click`` | 点击选项后触发,回调参数为 `(value: *=)`。`value` 为当前已选项 `value` 字段的值。当 [`split`](#props-split) 属性为 `true` 时,直接点击指令按钮部分也会触发,但不会携带 `value` 参数。 |
| ``toggle`` | 下拉菜单展开状态切换时触发,回调参数为 `(expanded: boolean)`。`expanded` 表示操作将触发下拉菜单展开还是收起。 |
### 图标
| 名称 | 描述 |
| -- | -- |
| `expand` | 展开浮层。 |
| `collapse` | 收起浮层。 |
| ``expand`` | 展开浮层。 |
| ``collapse`` | 收起浮层。 |