Beta

Search Documentation

Search through documentation pages

Components

Toggle

A two-state button built on Base UI that can be toggled on or off.

Preview

'use client';

import { Toggle } from '@/registry/san-francisco/ui/toggle';

export default function ToggleDemo() {
  return <Toggle>Toggle</Toggle>;
}

Installation

bun
bunx shadcn@latest add @sft-ui/toggle

Variants

'use client';

import { Toggle } from '@/registry/san-francisco/ui/toggle';

export default function ToggleDemoVariants() {
  return (
    <>
      <Toggle variant="default">Default</Toggle>
      <Toggle variant="outline">Outline</Toggle>
    </>
  );
}

Sizes

'use client';

import { Toggle } from '@/registry/san-francisco/ui/toggle';

export default function ToggleDemoSizes() {
  return (
    <>
      <Toggle size="sm">Small</Toggle>
      <Toggle size="default">Default</Toggle>
      <Toggle size="lg">Large</Toggle>
    </>
  );
}

API Reference

See the Base UI Toggle documentation for the API reference.