Toggle Button

A two-state button that can be either on (pressed) or off (not pressed).

Import

ts
import { ToggleButton } from "@kobalte/core/toggle-button";
// or
import { Root } from "@kobalte/core/toggle-button";
// or (deprecated)
import { ToggleButton } from "@kobalte/core";

ts
import { ToggleButton } from "@kobalte/core/toggle-button";
// or
import { Root } from "@kobalte/core/toggle-button";
// or (deprecated)
import { ToggleButton } from "@kobalte/core";

Features

Native HTML <button>, <a>, and custom element type support.
Exposed as a toggle button via the WAI ARIA Button design pattern.
Mouse and touch event handling, and press state management.
Keyboard event support for Space and Enter keys.
Can be controlled or uncontrolled.

Anatomy

The toggle button consists of:

ToggleButton: the root container for a toggle button.

tsx
<ToggleButton />

tsx
<ToggleButton />

Example

Usage

Default pressed

An initial, uncontrolled value can be provided using the defaultPressed prop.

tsx
<ToggleButton defaultPressed>...</ToggleButton>

tsx
<ToggleButton defaultPressed>...</ToggleButton>

Controlled pressed

The pressed prop can be used to make the pressed state controlled. The onChange event is fired when the user toggle the button, and receives the new value.

The microphone is active.

tsx
import { createSignal } from "solid-js";
function ControlledExample() {
	const [pressed, setPressed] = createSignal(false);
	return (
		<>
			<ToggleButton pressed={pressed()} onChange={setPressed}>
				...
			</ToggleButton>
			<p>The microphone is {pressed() ? "muted" : "active"}.</p>
		</>
	);
}

tsx
import { createSignal } from "solid-js";
function ControlledExample() {
	const [pressed, setPressed] = createSignal(false);
	return (
		<>
			<ToggleButton pressed={pressed()} onChange={setPressed}>
				...
			</ToggleButton>
			<p>The microphone is {pressed() ? "muted" : "active"}.</p>
		</>
	);
}

API Reference

ToggleButton

ToggleButton is equivalent to the Root import from @kobalte/core/toggle-button (and deprecated ToggleButton.Root).

ToggleButton consists of Button and additional props.

Prop	Description
pressed	`boolean` The controlled pressed state of the toggle button.
defaultPressed	`boolean` The default pressed state when initially rendered. Useful when you do not need to control the pressed state.
onChange	`(pressed: boolean) => void` Event handler called when the pressed state of the toggle button changes.
children	`JSX.Element \| (state: ToggleButtonState) => JSX.Element` The children of the toggle button. Can be a `JSX.Element` or a render prop for having access to the internal state.

Render Prop	Description
pressed	`Accessor<boolean>` Whether the toggle button is on (pressed) or off (not pressed).

Data attribute	Description
data-pressed	Present when the toggle button is on (pressed).

Rendered elements

Component	Default rendered element
`ToggleButton`	`button`

Accessibility

Keyboard Interactions

Key	Description
`Space`	Activates/deactivates the toggle button.
`Enter`	Activates/deactivates the toggle button.