Source: https://www.radix-ui.com/primitives/docs/components/toggle

Radix Homepage

Made by WorkOS

Radix Homepage

Made by WorkOS

ThemesThemes PrimitivesPrimitives IconsIcons ColorsColors

Documentation Case studies Blog

Search

/

Overview

Introduction Getting started Accessibility Releases

Guides

Styling Animation Composition Server-side rendering

Components

Accordion Alert Dialog Aspect Ratio Avatar Checkbox Collapsible Context Menu Dialog Dropdown Menu Form

Preview Hover Card Label Menubar Navigation Menu One-Time Password Field

Preview Password Toggle Field

Preview Popover Progress Radio Group Scroll Area Select Separator Slider Switch Tabs Toast Toggle Toggle Group Toolbar Tooltip

Utilities

Accessible Icon Direction Provider Portal Slot Visually Hidden

Components

Toggle

A two-state button that can be either on or off.

index.jsxindex.jsxstyles.cssstyles.css

CSS

import * as React from "react";
import { Toggle } from "radix-ui";
import { FontItalicIcon } from "@radix-ui/react-icons";
import "./styles.css";

const ToggleDemo = () => (
	<Toggle.Root className="Toggle" aria-label="Toggle italic">
		<FontItalicIcon />
	</Toggle.Root>
);

export default ToggleDemo;

Features

Full keyboard navigation.

Can be controlled or uncontrolled.

Installation

---

Install the component from your command line.

npm install @radix-ui/react-toggle

Anatomy

---

Import the component.

import { Toggle } from "radix-ui";

export default () => <Toggle.Root />;

API Reference

---

Root

The toggle.

| Prop | Type | Default | | --- | --- | --- | | asChild<br><br>Prop description | boolean | false | | defaultPressed<br><br>Prop description | boolean | No default value | | pressed<br><br>Prop description | boolean | No default value | | onPressedChange<br><br>Prop description | function<br><br>See full type | No default value | | disabled<br><br>Prop description | boolean | No default value |

| Data attribute | Values | | --- | --- | | [data-state] | "on" \| "off" | | [data-disabled] | Present when disabled |

Accessibility

---

Keyboard Interactions

| Key | Description | | --- | --- | | Space | Activates/deactivates the toggle. | | Enter | Activates/deactivates the toggle. |

PreviousToast

NextToggle Group

Edit this page on GitHub.