# Toggle

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

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).





<ComponentPreview name="toggle-demo">
  <ToggleDemo />
</ComponentPreview>

## Installation [#installation]

<Tabs defaultValue="cli">
  <TabsList>
    <TabsTrigger value="cli">
      CLI
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add https://shadcn-cssinjs.com/r/toggle.json
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      pnpm add @base-ui/react @stylexjs/stylex
      ```

      <Step>
        Make sure [StyleX is configured](/docs/installation) and the design tokens are
        installed.
      </Step>

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource name="toggle" title="toggle.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</Tabs>

## Usage [#usage]

```tsx
import { Toggle } from "@/components/ui/toggle/toggle";
```

```tsx
<Toggle aria-label="Toggle bold">
  <BoldIcon />
</Toggle>
```

## Examples [#examples]

### Outline [#outline]

Use the `outline` variant for a bordered toggle.

<ComponentPreview name="toggle-outline">
  <ToggleOutline />
</ComponentPreview>

### With Text [#with-text]

<ComponentPreview name="toggle-with-text">
  <ToggleWithText />
</ComponentPreview>



### Size [#size]

<ComponentPreview name="toggle-sizes">
  <ToggleSizes />
</ComponentPreview>

### Disabled [#disabled]

<ComponentPreview name="toggle-disabled">
  <ToggleDisabled />
</ComponentPreview>



## RTL [#rtl]

To enable right-to-left support, see the [RTL guide](/docs/rtl).

<ComponentPreview name="toggle-rtl" direction="rtl">
  <ToggleRtl />
</ComponentPreview>

## API Reference [#api-reference]

See the [Base UI](https://base-ui.com/react/components/toggle#api-reference)
documentation for the full API.