空状態
検索結果がない場合、ダッシュボードが空白の場合、および初回起動時の画面用のプレースホルダーです。アイコン、タイトル、アクションが、ネオブルータリズム風の枠で囲まれています。
import { IconFolderCode } from "@tabler/icons-react"
import { ArrowUpRightIcon } from "lucide-react"
Empty は、表示するものがないときの空白を埋めます。アイコンやアバター、タイトル、説明、CTA のスロットがあります。組み立て可能な依存なしの div 群で、下層にプリミティブはありません。ネオブルータリストのレシピに沿ってスタイルしており、太い枠線と太字の見出しタイポグラフィです。
次のような場面で使います:
- 検索・フィルタのゼロ件 — なぜ空かを説明し、リセットや条件の拡大手段を示します。
- 初回画面 — 「まだプロジェクトがありません」と、次の一歩へ誘導する作成ボタン。
- 空の受信箱やキュー — 空であることが成功であり、エラーではないことを伝えます。
インストール#
pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/empty.jsonnpx shadcn@latest add https://neobrutalism.com/r/base/empty.jsonyarn dlx shadcn@latest add https://neobrutalism.com/r/base/empty.jsonbunx --bun shadcn@latest add https://neobrutalism.com/r/base/empty.json
以下のコードをコピーして、プロジェクトに貼り付けます。
import { cva, type VariantProps } from "class-variance-authority"
import { cn } from "@/lib/utils"
function Empty({ className, ...props }: React.ComponentProps<"div">) {
return (
<div
data-slot="empty"
className={cn(
"flex w-full min-w-0 flex-1 flex-col items-center justify-center gap-4 rounded border-2 bg-card p-6 text-center text-balance",
className
)}
{...props}
/>
)
}
function EmptyHeader({ className, ...props }: React.ComponentProps<"div">) {
return (
<div
data-slot="empty-header"
className={cn("flex max-w-sm flex-col items-center gap-2", className)}
{...props}
/>
)
}
const emptyMediaVariants = cva(
"mb-2 flex shrink-0 items-center justify-center [&_svg]:pointer-events-none [&_svg]:shrink-0",
{
variants: {
variant: {
default: "bg-transparent",
icon: "flex size-8 shrink-0 items-center justify-center rounded-lg bg-muted text-foreground [&_svg:not([class*='size-'])]:size-4",
},
},
defaultVariants: {
variant: "default",
},
}
)
function EmptyMedia({
className,
variant = "default",
...props
}: React.ComponentProps<"div"> & VariantProps<typeof emptyMediaVariants>) {
return (
<div
data-slot="empty-icon"
data-variant={variant}
className={cn(emptyMediaVariants({ variant, className }))}
{...props}
/>
)
}
function EmptyTitle({ className, ...props }: React.ComponentProps<"div">) {
return (
<div
data-slot="empty-title"
className={cn(
"cn-font-heading text-sm font-medium tracking-tight",
className
)}
{...props}
/>
)
}
function EmptyDescription({ className, ...props }: React.ComponentProps<"p">) {
return (
<div
data-slot="empty-description"
className={cn(
"text-sm/relaxed text-muted-foreground [&>a]:underline [&>a]:underline-offset-4 [&>a:hover]:text-primary",
className
)}
{...props}
/>
)
}
function EmptyContent({ className, ...props }: React.ComponentProps<"div">) {
return (
<div
data-slot="empty-content"
className={cn(
"flex w-full max-w-sm min-w-0 flex-col items-center gap-2.5 text-sm text-balance",
className
)}
{...props}
/>
)
}
export {
Empty,
EmptyHeader,
EmptyTitle,
EmptyDescription,
EmptyContent,
EmptyMedia,
}
インポートのパスをプロジェクトの構成に合わせて更新します。
使い方#
import {
Empty,
EmptyContent,
EmptyDescription,
EmptyHeader,
EmptyMedia,
EmptyTitle,
} from "@/components/ui/empty"<Empty>
<EmptyHeader>
<EmptyMedia variant="icon">
<Icon />
</EmptyMedia>
<EmptyTitle>No data</EmptyTitle>
<EmptyDescription>No data found</EmptyDescription>
</EmptyHeader>
<EmptyContent>
<Button>Add data</Button>
</EmptyContent>
</Empty>コンポジション#
Empty の状態を構築するには、次のコンポジションを使用します。
Empty
├── EmptyHeader
│ ├── EmptyMedia
│ ├── EmptyTitle
│ └── EmptyDescription
└── EmptyContent使用例#
アウトライン#
border ユーティリティクラスを使って、枠線付きの空の状態を作成します。
import { IconCloud } from "@tabler/icons-react"
import { Button } from "@/components/ui/button"背景#
bg-* と bg-gradient-* ユーティリティを使って、空の状態に背景を追加します。
import { IconBell } from "@tabler/icons-react"
import { RefreshCcwIcon } from "lucide-react"
アバター#
EmptyMedia コンポーネントを使って、空の状態にアバターを表示します。
import {
Avatar,
AvatarFallback,アバターグループ#
EmptyMedia コンポーネントを使って、空の状態にアバターグループを表示します。
import { PlusIcon } from "lucide-react"
import {InputGroup#
EmptyContent コンポーネントに InputGroup コンポーネントを追加できます。
import { SearchIcon } from "lucide-react"
import {RTL#
Neobrutalism で RTL を有効にする方法は、RTL 設定ガイドをご覧ください。
"use client"
import * as React from "react"アクセシビリティ#
Empty は見た目専用です。role もキーボード挙動もないプレーンな div なので、配線するものはありません。装飾だけの EmptyMedia アイコンには aria-hidden="true" を付け、EmptyContent 内のアクションは本物の Button やリンクにしてフォーカス可能にしてください。非同期操作のあと(検索結果がゼロ件など)で Empty が内容を置き換える場合は、ライブリージョンで告知してください。DOM の差し替えだけではスクリーンリーダーには伝わりません。
APIリファレンス#
Empty#
空の状態のメインコンポーネントです。EmptyHeader コンポーネントと EmptyContent コンポーネントをラップします。
| Prop | Type | Default |
|---|---|---|
className | string |
<Empty>
<EmptyHeader />
<EmptyContent />
</Empty>EmptyHeader#
EmptyHeader コンポーネントは、空の状態のメディア、タイトル、説明をラップします。
| Prop | Type | Default |
|---|---|---|
className | string |
<EmptyHeader>
<EmptyMedia />
<EmptyTitle />
<EmptyDescription />
</EmptyHeader>EmptyMedia#
EmptyMedia コンポーネントを使って、アイコンや画像など、空の状態のメディアを表示します。アバターなど、ほかのコンポーネントを表示するのにも使えます。
| Prop | Type | Default |
|---|---|---|
variant | "default" | "icon" | default |
className | string |
<EmptyMedia variant="icon">
<Icon />
</EmptyMedia><EmptyMedia>
<Avatar>
<AvatarImage src="..." />
<AvatarFallback>CN</AvatarFallback>
</Avatar>
</EmptyMedia>EmptyTitle#
EmptyTitle コンポーネントを使って、空の状態のタイトルを表示します。
| Prop | Type | Default |
|---|---|---|
className | string |
<EmptyTitle>No data</EmptyTitle>EmptyDescription#
EmptyDescription コンポーネントを使って、空の状態の説明を表示します。
| Prop | Type | Default |
|---|---|---|
className | string |
<EmptyDescription>You do not have any notifications.</EmptyDescription>EmptyContent#
EmptyContent コンポーネントを使って、ボタン、入力欄、リンクなど、空の状態のコンテンツを表示します。
| Prop | Type | Default |
|---|---|---|
className | string |
<EmptyContent>
<Button>Add Project</Button>
</EmptyContent>