Toggle
Toggles are used to switch between two states, such as on/off or enabled/disabled. They are commonly used in settings, preferences, and other interactive elements.
Loading Code Block...Installation
Section titled “Installation”To get started, install Butterfly DS via aqua:
Loading Code Block...Loading Code Block...sm
md
Loading Code Block...Toggle Disabled
Section titled “Toggle Disabled”Loading Code Block...| Props | Default | Type | Description |
|---|---|---|---|
| size | md | sm | md | The size of the toggle. |
| title | - | string | The title to display next to the toggle. |
| supportingText | string | The supporting text to display below the title. | |
| colorScheme | primary | 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | The color scheme of the toggle. |
| alignment | left | 'left' | 'right' | The alignment of the toggle. |
| titleBold | true | boolean | Whether the title should be bold. |
| disabled | false | boolean | Whether the toggle is disabled. |
| checked | false | boolean | Whether the toggle is checked. |