import { Badge } from "@/components/ui/badge"
export function BadgeDemo() {Badge はコンパクトなインラインラベルです。下層にプリミティブのないプレーンな <span> で、ネオブルータリストのレシピに沿ってスタイルしています。太い枠線、硬い影、太字のタイポグラフィです。render prop(Base UI の useRender 経由)により、リンクやボタンなど任意の要素にバッジのスタイルを着せられます。
次のような場面で使います:
- ステータス — テーブル行やカードの「Active」「Draft」「Failed」。エラーには
destructive。 - 件数 — 未読メッセージ、カート内商品、ナビラベル横の通知合計など。
- タグとメタデータ — ブログカードのカテゴリ、プラン階層、ドキュメントのバージョンラベル。
インストール#
pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/badge.jsonnpx shadcn@latest add https://neobrutalism.com/r/base/badge.jsonyarn dlx shadcn@latest add https://neobrutalism.com/r/base/badge.jsonbunx --bun shadcn@latest add https://neobrutalism.com/r/base/badge.json
以下のコードをコピーしてプロジェクトに貼り付けます。
import * as React from "react"
import { cva, type VariantProps } from "class-variance-authority"
import { Slot } from "radix-ui"
import { cn } from "@/lib/utils"
const badgeVariants = cva(
"group/badge inline-flex h-5 w-fit shrink-0 items-center justify-center gap-1 overflow-hidden rounded border-2 px-2 py-0.5 text-xs font-head font-medium whitespace-nowrap shadow-sm transition-all focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-primary has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5 aria-invalid:border-destructive [&>svg]:pointer-events-none [&>svg]:size-3!",
{
variants: {
variant: {
default: "bg-primary text-primary-foreground [a]:hover:bg-primary/80",
secondary:
"bg-secondary text-secondary-foreground [a]:hover:bg-secondary/80",
destructive:
"bg-destructive text-destructive-foreground [a]:hover:bg-destructive/90",
outline:
"bg-transparent text-foreground [a]:hover:bg-muted [a]:hover:text-muted-foreground",
ghost:
"border-transparent bg-transparent shadow-none hover:bg-muted hover:text-muted-foreground dark:hover:bg-muted/50",
link: "border-transparent bg-transparent shadow-none text-primary underline-offset-4 hover:underline",
},
},
defaultVariants: {
variant: "default",
},
}
)
function Badge({
className,
variant = "default",
asChild = false,
...props
}: React.ComponentProps<"span"> &
VariantProps<typeof badgeVariants> & { asChild?: boolean }) {
const Comp = asChild ? Slot.Root : "span"
return (
<Comp
data-slot="badge"
data-variant={variant}
className={cn(badgeVariants({ variant }), className)}
{...props}
/>
)
}
export { Badge, badgeVariants }
プロジェクトの構成に合わせてインポートパスを更新します。
使い方#
import { Badge } from "@/components/ui/badge"<Badge variant="default | outline | secondary | destructive">Badge</Badge>使用例#
バリアント#
variant プロパティを使って、バッジのバリアントを変更します。
import { Badge } from "@/components/ui/badge"
export function BadgeVariants() {アイコン付き#
バッジの中にアイコンを表示できます。data-icon="inline-start" でアイコンを左に、data-icon="inline-end" でアイコンを右に表示します。
import { BadgeCheck, BookmarkIcon } from "lucide-react"
import { Badge } from "@/components/ui/badge"スピナー付き#
バッジの中にスピナーを表示できます。スピナーに data-icon="inline-start" または data-icon="inline-end" プロパティを追加することを忘れないでください。
import { Badge } from "@/components/ui/badge"
import { Spinner } from "@/components/ui/spinner"
リンク#
render プロパティを使って、リンクをバッジとして表示します。
import { ArrowUpRightIcon } from "lucide-react"
import { Badge } from "@/components/ui/badge"カスタムカラー#
Badge コンポーネントに bg-chart-2 text-primary-foreground などのカスタムクラスを追加することで、バッジの色をカスタマイズできます。
import { Badge } from "@/components/ui/badge"
export function BadgeCustomColors() {RTL#
Neobrutalism で RTL を有効にする方法は、RTL 設定ガイドをご覧ください。
"use client"
import * as React from "react"アクセシビリティ#
Badge はプレーンな <span> を描画します。スクリーンリーダーが得るのはテキストだけなので、意味を色だけに乗せないでください。variant="destructive" は default と同じように読み上げられるため、文言自体が「Failed」など状態を示す必要があります。件数だけの表示には文脈が要ります。aria-label や視覚的に隠したテキストを足し、「3」が「未読通知 3 件」と読まれるようにします。render prop でリンクとして描画する場合は通常のアンカーになり、リンクのセマンティクスがそのまま適用されます。
APIリファレンス#
Badge#
Badge コンポーネントは、バッジ、またはバッジのように見えるコンポーネントを表示します。
| Prop | Type | Default |
|---|---|---|
variant | "default" | "secondary" | "destructive" | "outline" | "ghost" | "link" | "default" |
className | string | - |