0.0.8 • Published 6 years ago
@alicd/crui-radio-group-field v0.0.8
category: Components type: UI Views component: Form chinese: 单选按钮组 english: RadioGroupField
source: next-checkbox
单选按钮允许用户从一个数据集中选择单个选项。如果你觉得用户需要并排看到所有的可选项，使用单选按钮进行排他操作。此外，考虑使用下拉列表，相对于显示所有的选项占用更少的空间。
API
RadioGroupField
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| prefix | 样式类名的品牌前缀 | String | 'next-' |
| className | 自定义类名 | String | - |
| style | 自定义内敛样式 | Object | - |
| size | 与 shape 属性配套使用，shape设为button时有效可选值:'large'(大)'medium'(中)'small'(小) | Enum | - |
| shape | 可以设置成 button 展示形状可选值:'button'(按钮状) | Enum | - |
| value | radio group的选中项的值 | String/Number/Boolean | - |
| defaultValue | radio group的默认值 | String/Number/Boolean | - |
| onChange | 选中值改变时的事件签名:Function(value: String/Number, e: Event) => void参数:value: {String/Number} 选中项的值e: {Event} Dom 事件对象 | Function | () => {} |
| disabled | 表示radio被禁用 | Boolean | - |
| dataSource | 可选项列表, 数据项可为 String 或者 Object, 如 ['apple', 'pear', 'orange'] | Array<any> | [] |
| children | 通过子元素方式设置内部radio | Array<ReactElement>/ReactElement | - |
| label | label 标签的文本 | ReactNode | - |
| labelCol | label 标签布局，通 <Col> 组件，设置 span offset 值，如 {span: 8, offset: 16}，该项仅在垂直表单有效 | Object | - |
| help | 提示信息，如不设置，则会根据校验规则自动生成. 如果设置会受控（ps: 可以利用这点自定义错误位置,详细看demo自定义错误) | ReactNode | - |
| validateStatus | 校验状态，如不设置，则会根据校验规则自动生成可选值:'''success'(成功)'error'(失败)'loading'(校验中) | Enum | - |
| hasFeedback | 配合 validateStatus 属性使用，是否展示校验状态图标, 目前只有Input支持 | Boolean | false |
| wrapperCol | 需要为输入控件设置布局样式时，使用该属性，用法同 labelCol | Object | - |
| extra | 额外的提示信息，和 help 类似，当需要错误信息和提示文案同时出现时，可以使用这个。 位于错误信息后面 | ReactNode | - |
| inputStyle | 表单输入框自定义内联样式 | Object/String | null |
| showValidateType | 应用于Field 类元素后，指定其展示错误的方式，可选值有 help、tooltip 两种 | String | help |
| name | walle 模式下才支持 可以配合表单Form 收集表单元素的数据，要求表单必须指定 field 属性 | String | '' |
| rules | walle 模式下才支持 配置表单规则，可以配置多个规则，可参考：async-validator，注意Form 表单必须配置field 属性才会生效 | Array | null |
| x-bind | walle 模式下才支持 双向绑定某一个变量 | state | null |
子标签 Radio
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| prefix | 样式类名的品牌前缀 | String | 'next-' |
| className | 自定义类名 | String | - |
| style | 自定义内敛样式 | Object | - |
| onChange | 状态变化时触发的事件签名:Function(checked: Boolean, e: Event) => void参数:checked: {Boolean} 是否选中e: {Event} Dom 事件对象 | Function | () => {} |
| checked | 设置radio是否选中 | Boolean | - |
| defaultChecked | radio的默认选中 | Boolean | - |
| disabled | 表示radio被禁用 | Boolean | - |
0.0.8
6 years ago