Empty
Use the Empty component to display an empty state.
import { ArrowUpRightIcon, FolderCodeIcon } from "lucide-solid";import { Button } from "~/components/ui/button";import { Empty, EmptyContent, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle,} from "~/components/ui/empty";
export default function EmptyDemo() { return ( <Empty> <EmptyHeader> <EmptyMedia variant="icon"> <FolderCodeIcon /> </EmptyMedia> <EmptyTitle>No Projects Yet</EmptyTitle> <EmptyDescription> You haven't created any projects yet. Get started by creating your first project. </EmptyDescription> </EmptyHeader> <EmptyContent class="flex-row justify-center gap-2"> <Button>Create Project</Button> <Button variant="outline">Import Project</Button> </EmptyContent> <Button variant="link" as="a" href="#" class="text-muted-foreground" size="sm"> Learn More <ArrowUpRightIcon /> </Button> </Empty> );}Installation
Usage
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>Composition
Use the following composition to build an Empty state:
Empty├── EmptyHeader│ ├── EmptyMedia│ ├── EmptyTitle│ └── EmptyDescription└── EmptyContentOutline
Use the border utility class to create an outline empty state.
import { CloudIcon } from "lucide-solid";import { Button } from "~/components/ui/button";import { Empty, EmptyContent, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle,} from "~/components/ui/empty";
export default function EmptyOutline() { return ( <Empty class="border border-dashed"> <EmptyHeader> <EmptyMedia variant="icon"> <CloudIcon /> </EmptyMedia> <EmptyTitle>Cloud Storage Empty</EmptyTitle> <EmptyDescription> Upload files to your cloud storage to access them anywhere. </EmptyDescription> </EmptyHeader> <EmptyContent> <Button variant="outline" size="sm"> Upload Files </Button> </EmptyContent> </Empty> );}Background
Use the bg-* and bg-gradient-* utilities to add a background to the empty state.
import { BellIcon, RefreshCcwIcon } from "lucide-solid";import { Button } from "~/components/ui/button";import { Empty, EmptyContent, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle,} from "~/components/ui/empty";
export default function EmptyBackground() { return ( <Empty class="h-full bg-muted/30"> <EmptyHeader> <EmptyMedia variant="icon"> <BellIcon /> </EmptyMedia> <EmptyTitle>No Notifications</EmptyTitle> <EmptyDescription class="max-w-xs text-pretty"> You're all caught up. New notifications will appear here. </EmptyDescription> </EmptyHeader> <EmptyContent> <Button variant="outline"> <RefreshCcwIcon data-icon="inline-start" /> Refresh </Button> </EmptyContent> </Empty> );}Avatar
Use the EmptyMedia component to display an avatar in the empty state.
import { Avatar, AvatarFallback, AvatarImage } from "~/components/ui/avatar";import { Button } from "~/components/ui/button";import { Empty, EmptyContent, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle,} from "~/components/ui/empty";
export default function EmptyAvatar() { return ( <Empty> <EmptyHeader> <EmptyMedia variant="default"> <Avatar class="size-12"> <AvatarImage src="https://github.com/shadcn.png" class="grayscale" /> <AvatarFallback>LR</AvatarFallback> </Avatar> </EmptyMedia> <EmptyTitle>User Offline</EmptyTitle> <EmptyDescription> This user is currently offline. You can leave a message to notify them or try again later. </EmptyDescription> </EmptyHeader> <EmptyContent> <Button size="sm">Leave Message</Button> </EmptyContent> </Empty> );}Avatar Group
Use the EmptyMedia component to display an avatar group in the empty state.
import { PlusIcon } from "lucide-solid";import { Avatar, AvatarFallback, AvatarImage } from "~/components/ui/avatar";import { Button } from "~/components/ui/button";import { Empty, EmptyContent, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle,} from "~/components/ui/empty";
export default function EmptyAvatarGroup() { return ( <Empty> <EmptyHeader> <EmptyMedia> <div class="flex -space-x-2 *:data-[slot=avatar]:size-12 *:data-[slot=avatar]:ring-2 *:data-[slot=avatar]:ring-background *:data-[slot=avatar]:grayscale"> <Avatar> <AvatarImage src="https://github.com/carere.png" alt="@carere" /> <AvatarFallback>CR</AvatarFallback> </Avatar> <Avatar> <AvatarImage src="https://github.com/shadcn.png" alt="@shadcn" /> <AvatarFallback>CN</AvatarFallback> </Avatar> <Avatar> <AvatarImage src="https://github.com/evilrabbit.png" alt="@evilrabbit" /> <AvatarFallback>ER</AvatarFallback> </Avatar> </div> </EmptyMedia> <EmptyTitle>No Team Members</EmptyTitle> <EmptyDescription>Invite your team to collaborate on this project.</EmptyDescription> </EmptyHeader> <EmptyContent> <Button size="sm"> <PlusIcon /> Invite Members </Button> </EmptyContent> </Empty> );}InputGroup
You can add an InputGroup component to the EmptyContent component.
/** biome-ignore-all lint/a11y/useValidAnchor: <example file> */import { SearchIcon } from "lucide-solid";import { Empty, EmptyContent, EmptyDescription, EmptyHeader, EmptyTitle,} from "~/components/ui/empty";import { InputGroup, InputGroupAddon, InputGroupInput } from "~/components/ui/input-group";import { Kbd } from "~/components/ui/kbd";
export default function EmptyInputGroup() { return ( <Empty> <EmptyHeader> <EmptyTitle>404 - Not Found</EmptyTitle> <EmptyDescription> The page you're looking for doesn't exist. Try searching for what you need below. </EmptyDescription> </EmptyHeader> <EmptyContent> <InputGroup class="sm:w-3/4"> <InputGroupInput placeholder="Try searching for pages..." /> <InputGroupAddon> <SearchIcon /> </InputGroupAddon> <InputGroupAddon align="inline-end"> <Kbd>/</Kbd> </InputGroupAddon> </InputGroup> <EmptyDescription> Need help? <a href="#">Contact support</a> </EmptyDescription> </EmptyContent> </Empty> );}API Reference
Empty
The main component of the empty state. Wraps the EmptyHeader and EmptyContent components.
<Empty> <EmptyHeader /> <EmptyContent /></Empty>EmptyHeader
The EmptyHeader component wraps the empty media, title, and description.
<EmptyHeader> <EmptyMedia /> <EmptyTitle /> <EmptyDescription /></EmptyHeader>EmptyMedia
Use the EmptyMedia component to display the media of the empty state such as an icon or an image. You can also use it to display other components such as an avatar.
<EmptyMedia variant="icon"> <Icon /></EmptyMedia><EmptyMedia> <Avatar> <AvatarImage src="..." /> <AvatarFallback>CN</AvatarFallback> </Avatar></EmptyMedia>EmptyTitle
Use the EmptyTitle component to display the title of the empty state.
<EmptyTitle>No data</EmptyTitle>EmptyDescription
Use the EmptyDescription component to display the description of the empty state.
<EmptyDescription>You do not have any notifications.</EmptyDescription>EmptyContent
Use the EmptyContent component to display the content of the empty state such as a button, input or a link.
<EmptyContent> <Button>Add Project</Button></EmptyContent>