Toggle

The Toggle component is a switch input. It behaves as a standard HTML checkbox input, but it is styled to match the design system. Per default they are rendered inlined, but can be stacked by wrapping them in a flex container or using a field.

Field Attributes

• label (String): The label of the toggle.
• label-start (String): The label of the toggle, rendered before the toggle.
• description (String): The description of the toggle.
• desc-start (String): The description of the toggle, rendered before the toggle.

Group Attributes

• legend (String): The legend of the group.
• divided (Boolean): Whether the toggle switches should be separated by a divider.
• inline (Boolean): Whether the toggle switches should be rendered inline.

Basic Usage

Sizes

Alternative Label

Disabled

Checked

Grouped

To group toggle switches, wrap them in a aura:toggle.group component.

Group styles

When grouping toggle switches, you can use the inline attribute to render them inline. or divided to separate them with a divider.