Skip to main content

Checkbox

Container properties

All component configurations support Container properties at the first level.

Component properties

NameTypeDefaultSupports Variable PatternDescription
classNamestring✔️The className of the component
styleobjectThe style of the component
optionsArray<{ value: string | number, label: string }>Optional
direction'horizontal' | 'vertical'Direction of Checkbox elements
gap'small' | 'middle' | 'large' | number'small'Spacing between Checkboxes

All the remaining componentsProps will be passed to the component root element(Checkbox.Group)。

JS API

The interface obtained through formApi.getFieldApi() is as follows:

NameTypeDescription
nodeHTML ElementThe root DOM element of the component