Skip to main content

Toggle Button

A button that can be toggled On/Off, useful for recognizing states when multiple options need to be provided.

toggle_anatomy.svg

1. Root : The topmost container area that wraps the button
2. Label: Button label
3. Icon(Prefix) : Icon area that visually elaborates the Label
4. Icon(Suffix) : Icon area that visually illustrates the label


States

StateValueDefaultDescription
ToggledBooleanFalseSwitches to True when the toggle button is activated. Default value is False
PressedBooleanFalseSwitches to True when the window is draggable
DisabledBoolean-If True, the Button is in a non-controllable state

toggle_state.svg



Properties

StateValueDescription
FloatingBooleanDisplayed as a shadow or color depending on the background style.
SizeLarge, Medium, SmallYou can select and use the button size options.

toggle_property.svg