コンテンツへスキップ

トグル

ツールバーの書式設定、ミュート、ピン留め機能用の2段階式オン/オフボタン――ネオブルータリズム風の枠線と影の演出が施されています。

import { BookmarkIcon } from "lucide-react"

import { Toggle } from "@/components/ui/toggle"

Toggle は押下/非押下の二状態ボタンで、再度クリックするまでオン状態が分かります。Base UI Toggle コンポーネント上に構築し、ネオブルータリストのレシピに沿ってスタイルしています。太い枠線、硬い影、太字のタイポグラフィです。

次のような場面で使います:

  • エディタの書式 — テキストエディタツールバーの太字、斜体、下線。
  • 単一のオン/オフ — ミュート、お気に入り、ピン、フォロー。押下状態がステータス表示を兼ねます。
  • 表示オプション — グリッド表示、折り返し、分割ビュー。複数をまとめるなら Toggle Group

インストール

pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/toggle.json
npx shadcn@latest add https://neobrutalism.com/r/base/toggle.json
yarn dlx shadcn@latest add https://neobrutalism.com/r/base/toggle.json
bunx --bun shadcn@latest add https://neobrutalism.com/r/base/toggle.json

以下の依存関係をインストールしてください。

pnpm add @base-ui/react
npm install @base-ui/react
yarn add @base-ui/react
bun add @base-ui/react

以下のコードをコピーしてプロジェクトに貼り付けてください。

components/ui/toggle.tsx
"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"

アクセシビリティ

Toggle は WAI-ARIA Button パターン のトグルボタン形に従います。現在状態を反映する aria-pressed 付きのネイティブ <button> を描画するため、スクリーンリーダーは「pressed」または「not pressed」と読み上げます。アイコンのみのトグルには aria-label を付けてください。

キーボード操作:

キー操作
Tab / Shift + Tabトグルへ/からフォーカスを移動
Space / Enter押下状態を切り替え

APIリファレンス

詳しくは Base UI のドキュメントをご覧ください。