Switch

JSON-safe Switch props forwarded to Astryx.

Supported Astryx props include:

• ref (React.Ref<HTMLInputElement>): Ref forwarded to the underlying <input> element.
• label (string; required): Label text for the switch (always rendered for accessibility).
• value (boolean; required): Whether the switch is on or off.
• onChange ((checked: boolean, e: ChangeEvent<HTMLInputElement>) => void): Callback fired when the switch state changes.
• changeAction ((checked: boolean, e: ChangeEvent<HTMLInputElement>) => void or Promise<void>): Async action fired after onChange. Triggers optimistic UI and shows a loading spinner until the promise resolves.
• isLoading (boolean): Whether the switch is in a loading state, showing a spinner inside the thumb.
• isLabelHidden (boolean): Visually hides the label while keeping it accessible to screen readers.
• description (string): Description text displayed below the label.
• isDisabled (boolean): Whether the switch is disabled.
• isOptional (boolean): Whether the field is optional. Mutually exclusive with isRequired.
• isRequired (boolean): Whether the switch is required. Mutually exclusive with isOptional.
• status (InputStatus): Status indicator with type and message. Displays a colored message box below the switch and sets aria-invalid when type is "error".
• onFocus ((e: FocusEvent<HTMLInputElement>) => void): Callback fired when the switch receives focus.
• onBlur ((e: FocusEvent<HTMLInputElement>) => void): Callback fired when the switch loses focus.
• labelIcon (IconType): Icon displayed before the label text. See 'npx astryx docs icons' for valid semantic names.
• labelTooltip (string): Tooltip text shown in an info icon at the end of the label.
• labelPosition ('start' or 'end'): Which side of the switch the label appears on. "start" places the label before the switch.
• labelSpacing ('default' or 'spread'): Spacing behavior between label and switch. "spread" pushes them to opposite ends of the container (full width).

Props typed as React nodes, render functions, event handlers, refs, or StyleX styles are documented for Astryx parity but cannot be serialized directly from Python unless the wrapper adapts them.

See Astryx component docs: https://astryx.atmeta.com/components/Switch.