test/amis
1
0
Fork 0
mirror of https://gitee.com/baidu/amis.git synced 2024-12-03 20:39:07 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #3773 from blue-squirrel/feat-select-md-event

Browse Source 
feat: 下拉类组件 文档修改
This commit is contained in:
hsm-lv 2022-03-16 10:57:01 +08:00 committed by GitHub
commit 109ea10856
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 128 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/zh-CN/components/form/chain-select.md
View File

@ -54,3 +54,16 @@ order: 7
| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) |
| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) |
| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| change | `value: string \| Option[]` 选中值 | 选中值发生变化时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| clear | - | 清空 |
| reset | `resetValue: boolean` 重置值 | 重置 |

13
docs/zh-CN/components/form/checkbox.md
View File

@ -95,3 +95,16 @@ order: 8
| trueValue | `string｜number｜boolean` | `true` | 标识真值 |
| falseValue | `string｜number｜boolean` | `false` | 标识假值 |
| optionType | `default｜button` | `default` | 设置option类型 |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| change | `value: boolean` 选中状态 | 选中状态发生变化时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| clear | - | 清空 |
| reset | `resetValue: boolean` 重置值 | 重置 |

13
docs/zh-CN/components/form/checkboxes.md
View File

@ -305,3 +305,16 @@ order: 9
| editApi | [API](../../docs/types/api) | | [配置编辑选项接口](./options#%E9%85%8D%E7%BD%AE%E7%BC%96%E8%BE%91%E6%8E%A5%E5%8F%A3-editapi) |
| removable | `boolean` | `false` | [删除选项](./options#%E5%88%A0%E9%99%A4%E9%80%89%E9%A1%B9) |
| deleteApi | [API](../../docs/types/api) | | [配置删除选项接口](./options#%E9%85%8D%E7%BD%AE%E5%88%A0%E9%99%A4%E6%8E%A5%E5%8F%A3-deleteapi) |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| change | `value: string \| Option[]` 选中值 | 选中值发生变化时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| clear | - | 清空 |
| reset | `resetValue: boolean` 重置值 | 重置 |

13
docs/zh-CN/components/form/input-city.md
View File

@ -81,3 +81,16 @@ order: 10
| allowDistrict | `boolean` | `true` | 允许选择区域 |
| searchable | `boolean` | `false` | 是否出搜索框 |
| extractValue | `boolean` | `true` | 默认 `true` 是否抽取值，如果设置成 `false` 值格式会变成对象，包含 `code`、`province`、`city` 和 `district` 文字信息。 |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| change | `value: number \| string` 选中值 | 选中值发生变化时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| clear | - | 清空 |
| reset | `resetValue: boolean` 重置值 | 重置 |

15
docs/zh-CN/components/form/input-tag.md
View File

@ -45,3 +45,18 @@ order: 55
| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) |
| clearable | `boolean` | `false` | 在有值的时候是否显示一个删除图标在右侧。 |
| resetValue | `string` | `""` | 删除后设置此配置项给定的值。 |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| change | `value: string \| Option[]` 选中值 | 选中值发生变化时触发 |
| blur | `(event: Event)` 原始事件 | 失去焦点时触发 |
| focus | `(event: Event)` 原始事件 | 获得焦点时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| clear | - | 清空 |
| reset | `resetValue: boolean` 重置值 | 重置 |

13
docs/zh-CN/components/form/matrix-checkboxes.md
View File

@ -281,3 +281,16 @@ row 模式，每行只能单选某个单元格
| source | [API](../../../docs/types/api) | | Api 地址，如果选项组不固定，可以通过配置 `source` 动态拉取。 |
| multiple | `boolean` | `true` | 是否多选 |
| singleSelectMode | `string` | `"column"` | 设置单选模式，`multiple`为`false`时有效，可设置为`cell`, `row`, `column` 分别为全部选项中只能单选某个单元格、每行只能单选某个单元格，每列只能单选某个单元格 |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| change | `value: Array` 选中值 | 选中值发生变化时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| clear | - | 清空 |
| reset | `resetValue: boolean` 重置值 | 重置 |

15
docs/zh-CN/components/form/nestedselect.md
View File

@ -519,3 +519,18 @@ order: 31
| noResultsText | `string` | `"未找到任何结果"` | 无结果时的文本 |
| multiple | `boolean` | `false` | 可否多选 |
| hideNodePathLabel | `boolean` | `false` | 是否隐藏选择框中已选择节点的路径 label 信息 |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| change | `value: string \| Option[]` 选中值 | 选中值发生变化时触发 |
| blur | `(event: Event)` 原始事件 | 失去焦点时触发 |
| focus | `(event: Event)` 原始事件 | 获得焦点时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| clear | - | 清空 |
| reset | `resetValue: boolean` 重置值 | 重置 |

13
docs/zh-CN/components/form/radios.md
View File

@ -129,3 +129,16 @@ order: 36
| columnsCount | `number` | `1` | 选项按几列显示，默认为一列 |
| inline | `boolean` | `true` | 是否显示为一行 |
| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| change | `value: string \| Option` 选中值 | 选中值发生变化时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| clear | - | 清空 |
| reset | `resetValue: boolean` 重置值 | 重置 |

18
docs/zh-CN/components/form/select.md
View File

@ -993,3 +993,21 @@ leftOptions 动态加载，默认 source 接口是返回 options 部分，而 le
| leftOptions | `Array<Object>` | | 当展示形式为 `associated` 时用来配置左边的选项集。 |
| leftMode | `string` | | 当展示形式为 `associated` 时用来配置左边的选择形式，支持 `list` 或者 `tree`。默认为 `list`。 |
| rightMode | `string` | | 当展示形式为 `associated` 时用来配置右边的选择形式，可选：`list`、`table`、`tree`、`chained`。 |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| change | `value: string \| Option[]` 选中值 | 选中值发生变化时触发 |
| blur | `(event: Event)` 原始事件 | 失去焦点时触发 |
| focus | `(event: Event)` 原始事件 | 获得焦点时触发 |
| add | - | 新增选项的时候触发 |
| edit | `value: Option` 修改的选项 | 编辑选项时触发 |
| delete | `value: Option` 删除的选项 | 删除选项时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------------------------------------------------------------------------------------------------- | ---- |
| clear | - | 清空 |
| reset | `resetValue: boolean` 重置值 | 重置 |

4
src/renderers/Form/Select.tsx
View File

@ -409,8 +409,8 @@ export default class SelectControl extends React.Component<SelectProps, any> {
onBlur={(e: any) => this.dispatchEvent('blur', e)}
onFocus={(e: any) => this.dispatchEvent('focus', e)}
onAdd={() => this.dispatchEvent('add')}
onEdit={(item: any) => this.dispatchEvent('edit', item)}
onDelete={(item: any) => this.dispatchEvent('delete', item)}
onEdit={(item: any) => this.dispatchEvent('edit', {value: item})}
onDelete={(item: any) => this.dispatchEvent('delete', {value: item})}
loading={loading}
noResultsText={noResultsText}
renderMenu={menuTpl ? this.renderMenu : undefined}