Skip to content

ToggleButton

A button with an on/off state, or one option of an exclusive group that behaves like radio (without a form).

Independent

<ToggleButton>Bold</ToggleButton>
<ToggleButton>Italic</ToggleButton>

Exclusive group

<ToggleButton exclusiveGroup="range">Day</ToggleButton>
<ToggleButton exclusiveGroup="range" pressed>Week</ToggleButton>
<ToggleButton exclusiveGroup="range">Month</ToggleButton>

Props

PropTypeDefaultDescription
pressedbooleanfalseInitial on state.
exclusiveGroupstring-One on at a time within the same group name.
variant / sizesecondary | ghost / sm | md | lgsecondary / mdButton styling.

Events

document.addEventListener("ink:toggle:change", (event) => {
  console.log(event.target.textContent);
});

Accessibility