DEVELOPER REFERENCE · v4.0.0

Switch API

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

Switch8 props1 callbacks0 methods

Switch props
Name	Type	Description
`checked`Required	`boolean`	Checked state displayed by the checkbox or switch.
`label`Required	`any`	Label content or accessible name for the component, as rendered by this control.
`ariaLabel`Optional	`string \| undefined`	Accessible name announced by assistive technology.
`className`Optional	`string \| undefined`	Additional CSS classes applied to the component root.
`disabled`Optional	`boolean \| undefined`	Disables user interaction with the control.
`labelPosition`Optional	`"before" \| "after" \| undefined`	Places the switch label before or after the control.
`title`Optional	`string \| undefined`	Heading or title text used by this component.
`testId`Optional	`string \| undefined`	Stable data attribute for locating the control in automated tests.

Switch events and callbacks
Name	Type	Description
`onChange`Required	`(checked: boolean) => void`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.