ToggleButton
ToggleButton is used to select a boolean value using a button.
Two-way binding to a boolean property is defined using the standard ngModel directive.
Usage #
Examples #
Basic #
Two-way binding to a boolean property is defined using the standard ngModel directive.
Customized #
Icons and Labels can be customized using onLabel, offLabel, onIcon and offIcon properties.
Sizes #
ToggleButton provides small and large sizes as alternatives to the base.
Fluid #
The fluid prop makes the component take up the full width of its container when set to true.
Disabled #
When disabled is present, the element cannot be edited and focused.
Invalid #
The invalid state is applied using the invalid property to indicate failed validation, which can be integrated with Angular Forms.
Forms #
Template Driven #
Reactive Forms #
ToggleButton can also be used with reactive forms. In this case, the formControlName property is used to bind the component to a form control.
Accessibility #
Screen Reader
ToggleButton component uses an element with button role and updates aria-pressed state for screen readers. Value to describe the component can be defined with ariaLabelledBy or ariaLabel props, it is highly suggested to use either of these props as the component changes the label displayed which will result in screen readers to read different labels when the component receives focus. To prevent this, always provide an aria label that does not change related to state.
Keyboard Support
| Key | Function |
|---|---|
| tab | Moves focus to the button. |
| space | Toggles the checked state. |
