eo-checkbox
<eo-checkbox>
Alias:
<form.general-checkbox>
表单复选框构件。
Examples
Label
Value
Options
Disabled
Type
checkboxColor
optionGroups
Event
With Form
Properties
Name | Description | Type | Default | Required |
---|---|---|---|---|
name | 字段名称 | string | ||
label | 字段说明 | string | ||
value | 值 | CheckboxValueType[] | ||
options | 多选框选项表 | CheckboxOptionType[] | [] | ✅ |
type | 类型 | CheckboxType | "default" | |
disabled | 是否禁用 | boolean | ||
isCustom | 是否为自定义 | boolean | false | |
required | 是否必填 | boolean | ||
message | 校验文本 | Record<string, string> | ||
isGroup | 是否为复选框,为true时,则可设置分组数据 optionGroups | boolean | ||
optionGroups | 多选框选项分组数据,需要设置 isGroup 为 true 才生效 | OptionGroup[] |
Events
Name | Description | Event Detail |
---|---|---|
change | 复选框变化事件 | CheckboxOptionType[] |
options.change | 复选框变化事件 | { options: CheckboxOptionType[]; name: string } |
Type references
CheckboxOptionType
Name | Type | Required | Description |
---|---|---|---|
label | React.ReactNode | ✅ | |
value | any | ✅ | |
style | React.CSSProperties | ||
disabled | boolean | ||
checkboxColor | string | ||
[propName: string] | any |
OptionGroup
Name | Type | Required | Description |
---|---|---|---|
name | string | ✅ | |
key | string | ✅ | |
options | CheckboxOptionType[] | ✅ |
CheckboxValueType
string | number | boolean
CheckboxType
"default" | "icon"