Switch

Usage and props

Use for an on/off setting, such as email notifications. Give it a label through Field or a native label, and keep the label the same in both states. Use a persistent setting label. The checked value comes from application state, not from an inferred network result.

checkedboolean (optional)

The controlled on/off state.

onCheckedChange(checked: boolean) => void (optional)

Receives the next state. Your application decides when to save the setting.

namestring (optional)

The form-data key. The switch uses a native checkbox input.

disabledboolean (optional)

Prevents changes and excludes the switch from native form submission.

These are the main props for the example. The package's TypeScript declarations include the full API.

Customize and use with a keyboard