diff --git a/packages/devui-vue/docs/components/checkbox/index.md b/packages/devui-vue/docs/components/checkbox/index.md index c54b533366b2cfce131eaf766d7250763f81c7b7..5d69d893300ee613d57df6c553a092c5bd989ebf 100644 --- a/packages/devui-vue/docs/components/checkbox/index.md +++ b/packages/devui-vue/docs/components/checkbox/index.md @@ -142,7 +142,7 @@ export default defineComponent({ ::: -### 使用 CheckBoxGroup +### 使用CheckBoxGroup :::demo @@ -274,7 +274,7 @@ export default defineComponent({ ::: -### checkbox 根据条件终止切换状态 +### checkbox根据条件终止切换状态 根据条件判断,label 为'条件判断回调禁止选中'的 checkbox 终止切换状态。 :::demo @@ -327,7 +327,7 @@ export default defineComponent({ ::: -### checkbox-group 根据条件终止切换状态 +### checkbox-group根据条件终止切换状态 选项包含'拦截'字段的 checkbox 无法切换状态。 :::demo @@ -380,3 +380,48 @@ export default defineComponent({ ``` ::: + +### API + +d-checkbox 参数 + +| 参数 | 类型 | 默认 | 说明 | 跳转 Demo | +| :----------: | :------------------: | :--------------------: | :------------------------------------------------------------------------ | --------------------------------------- | +| name | `string` | -- | 可选,表单域名,input 原生 name 属性 | [基本用法](#基本用法) | +| label | `string` | -- | 可选,显示标签 | [基本用法](#基本用法) | +| halfchecked | `boolean` | false | 可选,半选状态 | [基本用法](#基本用法) | +| isShowTitle | `boolean` | true | 可选,是否显示 title 提示,默认显示参数`label`的值 | [基本用法](#基本用法) | +| title | `string` | -- | 可选,显示自定义 title 提示内容 | [基本用法](#基本用法) | +| color | `string` | -- | 可选,复选框颜色 | [基本用法](#基本用法) | +| showAnimation | `boolean` | true | 可选,控制是否显示动画 | [基本用法](#基本用法) | +| disabled | `boolean` | false | 可选,是否禁用 | [基本用法](#基本用法) | +| beforeChange | `Function\|Promise` | -- | 可选,checkbox 切换前的回调函数,返回 boolean 类型,返回 false 可以阻止 checkbox 切换 | [基本用法](#基本用法) | + + +d-checkbox 事件 + +| 事件 | 类型 | 说明 | 跳转 Demo | +| :---------: | :------: | :--------------------: | :---------: | +| onChange | `string` | 复选框的值改变时发出的事件,值是当前状态 | [基本用法](#基本用法) | + +d-checkbox-group 参数 + +| 参数 | 类型 | 默认 | 说明 | 跳转 Demo | +| :----------: | :------------------: | :--------------------: | :------------------------------------------------------------------------ | --------------------------------------- | +| name | `string` | -- | 可选,表单域名,input 原生 name 属性 | [使用CheckBoxGroup](#使用CheckBoxGroup) | +| direction | 'row'\|'column' | 'column' | 可选,显示方向 | [使用CheckBoxGroup](#使用CheckBoxGroup) | +| itemWidth | `number` | -- | 可选,表示每一项 checkbox 的宽度(`px`) | [使用CheckBoxGroup](#使用CheckBoxGroup) | +| options | `array` | [] | 可选,复选框选项数组 | [使用CheckBoxGroup](#使用CheckBoxGroup) | +| halfchecked | `boolean` | false | 可选,半选状态 | [使用CheckBoxGroup](#使用CheckBoxGroup) | +| isShowTitle | `boolean` | true | 可选,是否显示 title 提示,默认显示参数`label`的值 | [使用CheckBoxGroup](#使用CheckBoxGroup) | +| color | `string` | -- | 可选,复选框颜色 | [使用CheckBoxGroup](#使用CheckBoxGroup) | +| showAnimation | `boolean` | true | 可选,控制是否显示动画 | [使用CheckBoxGroup](#使用CheckBoxGroup) | +| disabled | `boolean` | false | 可选,是否禁用 | [使用CheckBoxGroup](#使用CheckBoxGroup) | +| beforeChange | `Function\|Promise` | -- | 可选,checkbox 切换前的回调函数,返回 boolean 类型,返回 false 可以阻止 checkbox 切换 | [使用CheckBoxGroup](#使用CheckBoxGroup) | + + +d-checkbox-group 事件 + +| 事件 | 类型 | 说明 | 跳转 Demo | +| :---------: | :------: | :--------------------: | :---------: | +| onChange | `string` | checkbox 值改变事件 | [使用CheckBoxGroup](#使用CheckBoxGroup) | diff --git a/packages/devui-vue/docs/components/select/index.md b/packages/devui-vue/docs/components/select/index.md index 2cac4481bf263c147818d8c7b929c46c9078ead5..ae6ebc0a7944d7ea4ecc1b23bfd6c6f52ec78057 100644 --- a/packages/devui-vue/docs/components/select/index.md +++ b/packages/devui-vue/docs/components/select/index.md @@ -177,3 +177,27 @@ export default defineComponent({ ``` ::: + +### API + +d-select 参数 + +| 参数 | 类型 | 默认 | 说明 | 跳转 Demo | +| :----------: | :------------------: | :--------------------: | :------------------------------------------------------------------------ | --------------------------------------- | +| options | `array` | [] | 可选, 和 searchFn 互斥,两者必须有且只有一个。下拉选项资源string object | [基本用法](#基本用法) || +| multiple | `boolean` | false | 可选,是否支持多选 | [多选](#多选) | +| readonly | `boolean` | false | 可选,是否可以输入 || +| size | `string` | 'md' | 可选,下拉选框尺寸,有三种选择'lg','md','sm' | [基本用法](#基本用法) | +| disabled | `boolean` | false | 可选,是否禁用下拉框 | [禁用](#禁用) | +| placeholder | `string` | '请选择' | 可选,输入框的 placeholder || +| overview | `string` | 'border' | 可选,决定选择框样式显示,默认有边框'border','underlined' | [基本用法](#基本用法) | +| optionDisabledKey | `string` | '' | 可选,禁用单个选项;当传入资源 options 类型为Object,比如设置为'disabled',则当对象的 disabled 属性为 true 时,该选项将禁用;当设置为''时不禁用单个选项 | [禁用](#禁用) | +| allowClear | `boolean` | false | 可选, 配置是否允许清空选值,仅单选场景适用 | [可清空](#可清空) | + + +d-select 事件 + +| 事件 | 类型 | 说明 | 跳转 Demo | +| :---------: | :------: | :--------------------: | :---------: | +| valueChange | `string` | 可选,输出函数,当选中某个选项后,将会调用此函数,参数为当前选择项的值 || +| toggleChange | `string` | 可选,输出函数,下拉打开关闭 toggle 事件 ||