CheckboxGroup

A checkbox group allows a user to select multiple items from a list of options.

This is a label for a fieldThis is a description for a field

Examples

Disabled

This is a label for a fieldThis is a description for a field

Invalid

This is a label for a fieldThis is a description for a field

Props

isDisabled
boolean—
onFocus
((e: FocusEvent<Element, Element>) => void)—
onBlur
((e: FocusEvent<Element, Element>) => void)—
onFocusChange
((isFocused: boolean) => void)—
id
string—
name
string—
value
string[]—
defaultValue
string[]—
onChange
((value: string[]) => void)—
isReadOnly
boolean—
isRequired
boolean—
isInvalid
boolean—
validate
((value: string[]) => true | ValidationError | null)—
validationBehavior
"native" | "aria"'native'
children
ReactNode | ((values: CheckboxGroupRenderProps & { defaultChildren: ReactNode; }) => ReactNode)—
className
string | ((values: CheckboxGroupRenderProps & { defaultClassName: string; }) => string)—
style
CSSProperties | ((values: CheckboxGroupRenderProps & { defaultStyle: CSSProperties; }) => CSSProperties)—
slot
string | null—
ref
ForwardedRef<HTMLDivElement>—