章节
组件
import { IconFolderCode } from "@tabler/icons-react"
import { ArrowUpRightIcon } from "lucide-react"
空状态用来填补「没有可渲染内容」时的空白——预留图标或头像、标题、描述,以及行动号召的位置。它是一组可组合、无依赖的 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"无障碍#
空状态是表现层组件——普通 div,没有角色或键盘行为,因此无需额外接线。纯装饰性的 EmptyMedia 图标请标上 aria-hidden="true";EmptyContent 里的操作应使用真正的 Button 或链接,以便保持可聚焦。当空状态在异步操作后替换内容时(例如搜索返回无结果),请通过 live region 播报——仅做 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>