DEVELOPER REFERENCE · v4.0.0

Checkbox API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

Checkbox7 props1 callbacks0 methods

Checkbox props
Name	Type	Description
`checked`Optional	`boolean \| undefined`	Checked state displayed by the checkbox or switch.
`indeterminate`Optional	`boolean \| undefined`	Displays the mixed/partially selected checkbox state.
`label`Optional	`any`	Label content or accessible name for the component, as rendered by this control.
`description`Optional	`any`	Supporting text shown with the label or heading.
`ariaLabel`Optional	`string \| undefined`	Accessible name announced by assistive technology.
`controlClassName`Optional	`string \| undefined`	Additional CSS classes for the control part of the component.
`inputRef`Optional	`((input: HTMLInputElement \| null) => void) \| undefined`Inspect type	Reference or callback receiving the underlying input element.

Checkbox events and callbacks
Name	Type	Description
`onChange`Optional	`((checked: boolean, event: Event & { currentTarget: HTMLInputElement; }) => void) \| undefined`Inspect type	Receives the new value when the user changes the control. Update the corresponding value prop for controlled use.

No component-specific imperative methods. Use props and callbacks to control this component.