Getting Started
Overview
Installation
Theme
Forms
Basic Inputs
Custom Inputs
Select
Components
Components
78
Micro Charts
Navigation
Libraries
Content Editor
Data View
Form Builder
Image Designer
Kanban Board
PDF Viewer
Video Player
Latest npm version of @ngstarter-ui/componentsWeekly npm downloads of @ngstarter-ui/components
Buy License

Button Toggle

The Button Toggle component lets users choose one or more states from a short set of related options. Use it as a compact selection control for modes, formatting, filters, density, alignment, or other preferences where the selected state should stay visible.

Use it for:
  • Mode switching: Select one view, format, sorting mode, period, or layout density.
  • Multiple compact choices: Let users select several short options in the same group.
  • Persistent state: Show the current value directly on the control.
  • Form values: Bind selected values through Angular forms.

Do not use Button Toggle to run actions, navigate between pages, handle long option lists, or replace radio, checkbox, select, slide toggle, or tabs when those controls better match the task.

Button Toggle Group

PropTypeDefault
appearance
The appearance of the button toggle group.
ButtonToggleAppearancestandard
disabled
Whether the button toggle group is disabled.
booleanfalse
multiple
Whether multiple button toggles can be selected.
booleanfalse
hideSelectionIndicator
Whether to hide the selection indicator.
booleanfalse
vertical
Whether the button toggle group is vertical.
booleanfalse
onlyIcon
Whether the button toggle group should use icon-only sizing.
booleanfalse
value
The value of the button toggle group.
anyundefined
EventDescription
changeEvent emitted when the value of the button toggle group changes.

Button Toggle

PropTypeDefault
id
The unique ID of the button toggle.
stringngs-button-toggle-n
value
The value of the button toggle.
anyundefined
name
The name of the button toggle.
stringundefined
checked
Whether the button toggle is checked.
booleanfalse
disabled
Whether the button toggle is disabled.
booleanfalse
onlyIcon
Whether the button toggle should use icon-only sizing.
booleanfalse
EventDescription
changeEvent emitted when the checked state of the button toggle changes.