Skip to content


A ToggleButton is a button that can be toggled on and off.


When to use toggle buttons

Toggle buttons feature a normal and an “on” state. They generally contain a label and can also include an icon. For icon-only buttons, the label will be visually hidden while still available to screen reader users.

There are two types of toggle buttons: normal and quiet. There is no toggle button variant designed for progressive or destructive actions.

Use the ToggleButton component for options that require state persistence and are longer or more involved than a typical button click action. Avoid using ToggleButton if you need to trigger an immediate action or toggle something within the current user context; in this case use a Button instead.


Specification of ToggleButton.

ToggleButton may include the following elements:

  1. Icon (optional)
    Icons simplify user recognition and provide the ability to shorten button labels to a minimum.
  2. Label
    Button labels should be as short as possible, with text that clearly states what state is changed when toggling the button (eg. show/hide). Note that the label text should not change depending on the button’s toggled state.

Component limitations

The minimum width and height for both icon and text toggle buttons is min-size-interactive-pointer token (equivalent to 32px in the default Codex theme). The toggle button will adjust to fit the expanding text but will halt growth at a maximum width of max-width-button (equivalent to 448px in the default Codex theme). An ellipsis will appear to accommodate the text if necessary.

On mobile, toggle buttons should span the full-width of the container, except for icon-only buttons, which will maintain their fixed square proportions.

Refer to the ToggleButton component in Codex Figma.


Depending on the style of the button, there are two types of toggle buttons:

  1. Normal toggle buttons. They are the default choice for simplified recognition.
  2. Quiet toggle buttons (frameless). Only use quiet toggle buttons for an easily recognizable action that does not detract focus from the content.

Type of ToggleButton based on its style: normal and quiet.

Depending on the button's content, it can have one of the following formats:

  1. Icon and text
  2. Text-only
  3. Icon-only

Type of ToggleButton based on its content: icon and text, text-only, and icon-only.

Interaction states

Buttons have the following visually separate states:

Interaction states of the normal toggle button for both toggled-off and toggled-on: default, hover, active, focus, and disabled.

Neutral buttons

Interaction states of the quiet toggle button for both toggled-off and toggled-on: default, hover, active, focus, and disabled.

Quiet buttons

  1. Toggled-off default
  2. Toggled-off hover
  3. Toggled-off active
  4. Toggled-off focus
  5. Toggled-off disabled
  6. Toggled-on default
  7. Toggled-on hover
  8. Toggled-on active
  9. Toggled-on focus
  10. Toggled-on disabled

Best practices

Consider the following recommendations when working with toggle buttons.


ToggleButton featuring an icon relevant to its action.

  • Ensure that icons used in buttons are relevant to the action they represent.
  • Use icons only when they are clear and easily recognizable.

ToggleButton displaying a complex icon that doesn't add value to the button's text.

  • Use icons that are difficult to understand or do not clearly convey their purpose.

Toggle state

ToggleButton in its default and toggled states, with the same icon used in both states.

  • Maintain consistent text and icon representation across both default and toggled button states to indicate state changes solely through button color.

ToggleButton altering the icon in its default and toggled states.

  • Alter the icon and/or text when the button is toggled.

Keyboard navigation

TabIt moves the focus to the next interactive element.
Shift + TabIt moves the focus to the previous interactive element.
Enter / SpaceIf the focus is placed on the button, it toggles the button on and off.



Reading direction


Press the ToggleButton to see the value change. Open up the console to see emitted events.

ToggleButtons should always have a static label. This helps indicate to the user (including users of assistive technology) what it means for the button to be on or off. If you want a button with a label that changes when it is pressed, use the Button component instead.

Toggle button value: false

Icon only

When the ToggleButton includes only an icon and no text, add an aria-label to the ToggleButton to ensure the button is understandable to those using assistive technology.

Vue usage

The v-model value will be a boolean, it is true if the button is currently toggled ("on") and false otherwise ("off").


Prop nameDescriptionTypeDefault
modelValueWhether the button should be set to "on" (true) or "off" (false).

Provided by v-model binding in the parent component.
disabledWhether the disabled attribute should be added to the button, which prevents it from being clicked.booleanfalse
quietWhether the toggle button should be "quiet", which renders more minimally.booleanfalse


Event namePropertiesDescription
update:modelValuemodelValue boolean - The new model valueEmitted when modelValue changes (i.e. when the state is toggled)


defaultButton content