Switch

A label used for users using assistive technologies like screen readers. When set, any children or label supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.

Whether the control is active.

Whether the control is active by default.

Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user.

This will also be exposed to screen reader users.

Disables the field, disallowing any interaction.

Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.

A unique identifier for the element.

Visual content to use as the control label.

Changes the visibility of the component's label.

• visible: the label is visible to all users.
• exclusive: the label is visually hidden but remains in the accessibility tree.

An identifier for the field that is unique within the nearest containing form.

Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the error property.

The value used in form data when the checkbox is checked.