Search every page in the navigation.
A two-state button that can be either on or off.
import { IconBookmark } from "@tabler/icons-react"
import { Toggle } from "@/components/ui/toggle"
function ToggleDemo() {
return (
<Toggle aria-label="Toggle bookmark" size="sm" variant="outline">
<IconBookmark className="group-aria-pressed/toggle:fill-gray-1000" />
Bookmark
</Toggle>
)
}
export default ToggleDemonpx shadcn@latest add @ziiz/toggleimport { Toggle } from "@/components/ui/toggle"<Toggle>Toggle</Toggle>Use variant="outline" for an outline style.
import { IconBold, IconItalic } from "@tabler/icons-react"
import { Toggle } from "@/components/ui/toggle"
function ToggleOutline() {
return (
<div className="flex flex-wrap items-center gap-2">
<Toggle variant="outline" aria-label="Toggle italic">
<IconItalic />
Italic
</Toggle>
<Toggle variant="outline" aria-label="Toggle bold">
<IconBold />
Bold
</Toggle>
</div>
)
}
export default ToggleOutlineimport { IconItalic } from "@tabler/icons-react"
import { Toggle } from "@/components/ui/toggle"
function ToggleText() {
return (
<Toggle aria-label="Toggle italic">
<IconItalic />
Italic
</Toggle>
)
}
export default ToggleTextUse the size prop to change the size of the toggle.
import { Toggle } from "@/components/ui/toggle"
function ToggleSizes() {
return (
<div className="flex flex-wrap items-center gap-2">
<Toggle variant="outline" aria-label="Toggle small" size="sm">
Small
</Toggle>
<Toggle variant="outline" aria-label="Toggle default" size="default">
Default
</Toggle>
<Toggle variant="outline" aria-label="Toggle large" size="lg">
Large
</Toggle>
</div>
)
}
export default ToggleSizesUse shape="rounded" for a pill, or a circle when the toggle holds only an icon.
import { IconBold, IconItalic } from "@tabler/icons-react"
import { Toggle } from "@/components/ui/toggle"
function ToggleRounded() {
return (
<div className="flex flex-wrap items-center gap-2">
<Toggle variant="outline" shape="rounded" aria-label="Toggle bold">
<IconBold />
</Toggle>
<Toggle variant="outline" shape="rounded" aria-label="Toggle italic">
<IconItalic />
Italic
</Toggle>
</div>
)
}
export default ToggleRoundedimport { Toggle } from "@/components/ui/toggle"
function ToggleDisabled() {
return (
<div className="flex flex-wrap items-center gap-2">
<Toggle aria-label="Toggle disabled" disabled>
Disabled
</Toggle>
<Toggle variant="outline" aria-label="Toggle disabled outline" disabled>
Disabled
</Toggle>
</div>
)
}
export default ToggleDisabled| Prop | Type | Default |
|---|---|---|
variant | "default" | "outline" | "default" |
size | "default" | "sm" | "lg" | "default" |
shape | "default" | "rounded" | "default" |
See the Base UI Toggle documentation for the rest.