Skip to main content

Interface: SwitchProps

Defined in: components/Switch/Switch.tsx:113

Props for the Switch component.

Extends​

  • Omit<RACSwitchFieldProps, "style" | "children" | "className">

Properties​

children?​

optional children?: ReactNode

Defined in: components/Switch/Switch.tsx:121

Label content displayed next to the switch track. Rendered inside a data-part="label" span.

description?​

optional description?: ReactNode

Defined in: components/Switch/Switch.tsx:126

Supporting hint under the label — what turning this on actually commits the user to.

errorMessage?​

optional errorMessage?: ReactNode

Defined in: components/Switch/Switch.tsx:132

Validation message, shown only while the switch is invalid. Supply the copy: a switch's rule is domain-specific ("confirm before enabling"), which is not something the platform can phrase (ADR-001).