Skip to main content

CheckboxField Multi-select

When to Use

  • When making multiple selections from a set of options.
  • When used separately, it can indicate a toggle between two states, similar to a switch. The difference is that toggling a switch directly triggers a state change, while a checkbox is generally used for state marking and needs to be paired with a submit operation.

Component Example

Component Properties

属性说明类型默认值
behavior

表单组件显示状态

Behavior

'NORMAL'

dataSource

Set options

DataSource[]

[
{
  "text": "Option 1",
  "value": "1"
},
{
  "text": "Option 2",
  "value": "2"
},
{
  "text": "Option 3",
  "value": "3"
}
]
    
iconPosition

Mobile Icon position

'left' | 'right'

'left'

itemDirection

Option arrangement method for PC

'hoz' | 'ver'

'hoz'

label

表单组件标题

string

-
labelAlign

表单组件标题的位置

'left' | 'top'

'top'

labelColOffset

设置标题的偏移位置,配置值为栅格值,1代表1/24

number

0

labelColSpan

设置标题的占位宽度,配置值为栅格值,1代表1/24

number

4

labelTextAlign

表单组件的标题对齐方式

'left' | 'right'

'right'

labelTipsIcon

表单组件标题提示信息入口图标,当labelTipsTypes取值为 textrender 时生效

string

-
labelTipsRender

表单组件标题提示信息自定义渲染方法,当labelTipsTypes取值为 render 时生效

(props: IComponentProps) => ReactNode

-
labelTipsText

表单组件标题提示文本信息,当labelTipsTypes取值为 text 时生效

string

-
labelTipsTypes

表单组件标题提示信息类型设置

LabelTipsTypes

'none'

onChange

Component value change event

(value: string[]) => void

-
size

表单组件尺寸

Size

'medium'

tips

表单组件描述信息,展示在控件下方

string

-
useDrawerInMobile

Mobile arrangement method, when true then directly tiled, when false then bottom popup layer

boolean

false

validation

表单组件校验设置,具体使用详见表单校验文档

Validation[]

[]

value

Current component default value

string[]

-
wrapperColOffset

设置表单组件的偏移位置,设置值为栅格值,1代表1/24

number

0

wrapperColSpan

设置表单组件的占位宽度,设置值为栅格值,1代表1/24

number

0

This doc is generated using machine translation. Any discrepancies or differences created in the translation are not binding and have no legal effect for compliance or enforcement purposes.
Copyright © 2025钉钉(中国)信息技术有限公司和/或其关联公司浙ICP备18037475号-4