章节
组件
import { BookmarkIcon } from "lucide-react"
import { Toggle } from "@/components/ui/toggle"切换按钮是一个双状态按钮——按下或未按下——它会一直显示自己的开启状态,直到再次被点击。它基于 Base UI Toggle 组件构建,并按新粗野主义的配方设计:粗边框、硬阴影、加粗字体。
适合以下场景:
- 编辑器格式设置——文本编辑器工具栏里的加粗、斜体、下划线按钮。
- 单个开关式操作——静音、收藏、置顶、关注;按下状态同时充当状态指示。
- 视图选项——显示网格、自动换行、分屏;需要好几个时,就用 Toggle Group 把它们编成一组。
安装#
pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/toggle.jsonnpx shadcn@latest add https://neobrutalism.com/r/base/toggle.jsonyarn dlx shadcn@latest add https://neobrutalism.com/r/base/toggle.jsonbunx --bun shadcn@latest add https://neobrutalism.com/r/base/toggle.json
安装以下依赖:
pnpm add @base-ui/reactnpm install @base-ui/reactyarn add @base-ui/reactbun add @base-ui/react
将以下代码复制并粘贴到您的项目中。
"use client"
import * as React from "react"
import { cva, type VariantProps } from "class-variance-authority"
import { Toggle as TogglePrimitive } from "radix-ui"
import { cn } from "@/lib/utils"
const toggleVariants = cva(
"group/toggle inline-flex items-center justify-center gap-1 rounded border-2 text-sm font-head font-medium whitespace-nowrap shadow-sm transition-all outline-none hover:bg-accent hover:text-accent-foreground hover:translate-y-0.5 active:translate-y-1 active:shadow-none focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-primary disabled:pointer-events-none disabled:opacity-50 aria-invalid:border-destructive aria-pressed:bg-primary aria-pressed:text-primary-foreground data-[state=on]:bg-primary data-[state=on]:text-primary-foreground [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
{
variants: {
variant: {
default: "bg-background",
outline: "bg-background",
},
size: {
default:
"h-8 min-w-8 px-2.5 has-data-[icon=inline-end]:pr-2 has-data-[icon=inline-start]:pl-2",
sm: "h-7 min-w-7 rounded-[min(var(--radius-md),12px)] px-2.5 text-[0.8rem] has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5 [&_svg:not([class*='size-'])]:size-3.5",
lg: "h-9 min-w-9 px-2.5 has-data-[icon=inline-end]:pr-2 has-data-[icon=inline-start]:pl-2",
},
},
defaultVariants: {
variant: "default",
size: "default",
},
}
)
function Toggle({
className,
variant = "default",
size = "default",
...props
}: React.ComponentProps<typeof TogglePrimitive.Root> &
VariantProps<typeof toggleVariants>) {
return (
<TogglePrimitive.Root
data-slot="toggle"
className={cn(toggleVariants({ variant, size, className }))}
{...props}
/>
)
}
export { Toggle, toggleVariants }
更新导入路径以匹配您的项目设置。
用法#
import { Toggle } from "@/components/ui/toggle"<Toggle>Toggle</Toggle>示例#
描边#
描边样式请使用 variant="outline"。
import { BoldIcon, ItalicIcon } from "lucide-react"
import { Toggle } from "@/components/ui/toggle"带文本#
import { ItalicIcon } from "lucide-react"
import { Toggle } from "@/components/ui/toggle"尺寸#
使用 size 属性来更改切换按钮的尺寸。
import { Toggle } from "@/components/ui/toggle"
export function ToggleSizes() {禁用#
import { Toggle } from "@/components/ui/toggle"
export function ToggleDisabled() {RTL#
要在 Neobrutalism 中启用 RTL 支持,请参阅 RTL 配置指南。
"use client"
import * as React from "react"无障碍#
切换按钮遵循 WAI-ARIA Button 模式 中的切换按钮变体:它渲染一个原生 <button>,并用 aria-pressed 反映当前状态,于是屏幕阅读器会播报「已按下」或「未按下」。请确保纯图标的切换按钮带有 aria-label。
键盘交互:
| 按键 | 操作 |
|---|---|
Tab / Shift + Tab | 把焦点移到切换按钮上或移开 |
Space / Enter | 切换按下状态 |
API 参考#
请参阅 Base UI Toggle 文档。