docs: add docs for option-group and switch

Change-Id: I9d2b7e37af40febdbf02104ab7a8756de753e134
This commit is contained in:
xiaodemen 2022-03-25 13:49:27 +08:00 committed by GU Yiling
parent f098a1bb8c
commit ef735a625b
4 changed files with 19 additions and 1 deletions

View File

@ -28,7 +28,8 @@ export default {
props: ['model']
},
switch: {
props: ['model']
props: ['model', 'offLabel', 'onLabel'],
slots: ['content']
},
drawer: {
props: ['inline']
@ -36,6 +37,9 @@ export default {
select: {
props: ['max'] // 脚本没识别出来,先忽略
},
'option-group': {
props: ['optionTag']
},
link: {
props: ['replace']
},

View File

@ -44,6 +44,8 @@
| ``min`` | `number` | - | 允许的最小值。 |
| ``decimal-place`` | `number` | 0 | 数值的小数精度位数,默认精确到整数位,`-1` 表示不处理精度。 |
| ``step`` | `number` | 1 | 每次递增/递减的数值。 |
| ``format`` | `(val: number, defaultFormattedValue: string) => string` | - | 自定义数字格式化。 |
| ``parse`` | `(val: string) => number` | - | 自定义将输入的值解析成数字。 |
^^^ui
预设样式。

View File

@ -15,6 +15,8 @@
| 名称 | 类型 | 默认值 | 描述 |
| -- | -- | -- | -- |
| ``label`` | `string` | - | 选项组的标题。 |
| ``expanded`` | `boolean=` | `false` | 选项列表是否展开。 |
| ``trigger`` | `'click' | 'hover'` | `'click'` | 选项列表展开的时机。 |
| ``options`` | `Array<Object>` | `[]` | [^options] |
| ``position`` | `string` | `inline` | [^position] |
| ``overlay-class`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props-overlay-class) 属性。 |
@ -52,6 +54,8 @@
| ``group-label`` | [^slot-group-label] |
| ``option-label`` | [^slot-option-label] |
| ``option`` | [^slot-option] |
| ``before`` | 选项列表的前置区域。 |
| ``after`` | 选项列表的后置区域。 |
^^^slot-label
选项组标题文本区域。
@ -115,6 +119,13 @@
另外,当前选项数据中除了上面描述的字段之外的其它字段也会自动通过 `v-bind` 进行绑定到作用域参数上。
^^^
### 事件
| 名称 | 描述 |
| -- | -- |
| ``toggle`` | 选项列表展开状态切换时触发,回调参数为 `(expanded: boolean)`。`expanded` 表示操作将触发选项列表展开还是收起。 |
| ``afteropen`` | 选项列表打开完成之后触发。 |
### 图标
| 名称 | 描述 |

View File

@ -26,6 +26,7 @@
| ``false-value`` | `*` | `false` | 关闭状态对应的值。 |
| ``disabled`` | `boolean=` | `false` | 是否为禁用状态。 |
| ``readonly`` | `boolean=` | `false` | 是否为只读状态。 |
| ``loading`` | `boolean=` | `false` | 是否为加载中状态。 |
^^^ui
预设样式。