Empty
Empty state placeholder with icon, title, description, and action slots.
No files found
Upload a file to get started or browse existing ones.
import { FolderOpenIcon } from "lucide-react";
import { Button } from "@/components/ui/button";
import {
Empty,
EmptyContent,
EmptyDescription,
EmptyHeader,
EmptyMedia,
EmptyTitle,
} from "@/components/ui/empty";
const EmptyDemo = () => {
return (
<Empty>
<EmptyHeader>
<EmptyMedia variant="icon">
<FolderOpenIcon />
</EmptyMedia>
<EmptyTitle>No files found</EmptyTitle>
<EmptyDescription>
Upload a file to get started or <a href="#">browse existing ones</a>.
</EmptyDescription>
</EmptyHeader>
<EmptyContent>
<Button size="sm">Upload file</Button>
</EmptyContent>
</Empty>
);
};
export default EmptyDemo;
Installation
npx shadcn@latest add @ark-cn/emptyInstall the dependency required by this primitive:
npm install @ark-ui/react class-variance-authorityCopy the component source into your app:
TSXcomponents/ui/empty.tsx
"use client";
import { ark } from "@ark-ui/react/factory";
import { cva, type VariantProps } from "class-variance-authority";
import type { ComponentProps } from "react";
import { cn } from "@/lib/utils";
export const Empty = ({
className,
...props
}: ComponentProps<typeof ark.div>) => {
return (
<ark.div
data-slot="empty"
className={cn(
"flex w-full min-w-0 flex-1 flex-col items-center justify-center gap-4 rounded-xl border border-dashed p-6 text-center text-balance",
className,
)}
{...props}
/>
);
};
export const EmptyHeader = ({
className,
...props
}: ComponentProps<typeof ark.div>) => {
return (
<ark.div
data-slot="empty-header"
className={cn("flex max-w-sm flex-col items-center gap-2", className)}
{...props}
/>
);
};
export 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",
},
},
);
export interface EmptyMediaProps
extends ComponentProps<typeof ark.div>,
VariantProps<typeof emptyMediaVariants> {}
export const EmptyMedia = ({
className,
variant = "default",
...props
}: EmptyMediaProps) => {
return (
<ark.div
data-slot="empty-media"
data-variant={variant}
className={cn(emptyMediaVariants({ variant, className }))}
{...props}
/>
);
};
export const EmptyTitle = ({
className,
...props
}: ComponentProps<typeof ark.div>) => {
return (
<ark.div
data-slot="empty-title"
className={cn("text-sm font-medium tracking-tight", className)}
{...props}
/>
);
};
export const EmptyDescription = ({
className,
...props
}: ComponentProps<typeof ark.div>) => {
return (
<ark.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}
/>
);
};
export const EmptyContent = ({
className,
...props
}: ComponentProps<typeof ark.div>) => {
return (
<ark.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}
/>
);
};
Update import aliases to match your project setup.
Usage
import {
Empty,
EmptyContent,
EmptyDescription,
EmptyHeader,
EmptyMedia,
EmptyTitle,
} from "@/components/ui/empty"<Empty>
<EmptyHeader>
<EmptyMedia variant="icon">
<FolderOpenIcon />
</EmptyMedia>
<EmptyTitle>No results</EmptyTitle>
<EmptyDescription>Try adjusting your search.</EmptyDescription>
</EmptyHeader>
<EmptyContent>
<Button size="sm">Take action</Button>
</EmptyContent>
</Empty>Examples
Default
No files found
Upload a file to get started or browse existing ones.
import { FolderOpenIcon } from "lucide-react";
import { Button } from "@/components/ui/button";
import {
Empty,
EmptyContent,
EmptyDescription,
EmptyHeader,
EmptyMedia,
EmptyTitle,
} from "@/components/ui/empty";
const EmptyDemo = () => {
return (
<Empty>
<EmptyHeader>
<EmptyMedia variant="icon">
<FolderOpenIcon />
</EmptyMedia>
<EmptyTitle>No files found</EmptyTitle>
<EmptyDescription>
Upload a file to get started or <a href="#">browse existing ones</a>.
</EmptyDescription>
</EmptyHeader>
<EmptyContent>
<Button size="sm">Upload file</Button>
</EmptyContent>
</Empty>
);
};
export default EmptyDemo;
Icon Variant
No results found
Try different keywords or clear your filters.
import { SearchXIcon } from "lucide-react";
import { Button } from "@/components/ui/button";
import {
Empty,
EmptyContent,
EmptyDescription,
EmptyHeader,
EmptyMedia,
EmptyTitle,
} from "@/components/ui/empty";
const EmptyIconVariant = () => {
return (
<Empty>
<EmptyHeader>
<EmptyMedia>
<SearchXIcon className="size-16 text-muted-foreground" />
</EmptyMedia>
<EmptyTitle>No results found</EmptyTitle>
<EmptyDescription>
Try different keywords or <a href="#">clear your filters</a>.
</EmptyDescription>
</EmptyHeader>
<EmptyContent>
<Button variant="outline" size="sm">
Clear filters
</Button>
</EmptyContent>
</Empty>
);
};
export default EmptyIconVariant;
API reference
This component is an ark-cn composition. All props and DOM behavior are defined by the underlying ark factory elements.