Empty

Installation#

pnpmnpmyarnbun
pnpm dlx shadcn@latest add @force-ui-ember/empty
Copy

Usage#

Copyimport {
  Empty,
  EmptyContent,
  EmptyDescription,
  EmptyHeader,
  EmptyMedia,
  EmptyTitle,
} from '@/ember-ui/empty';

Copy<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:

CopyEmpty
├── EmptyHeader
│   ├── EmptyMedia
│   ├── EmptyTitle
│   └── EmptyDescription
└── EmptyContent

Examples#

Outline#

Use the border utility class to create an outline empty state.

Background#

Use the bg-* and bg-gradient-* utilities to add a background to the empty state.

Avatar#

Use the EmptyMedia component to display an avatar in the empty state.

Avatar Group#

Use the EmptyMedia component to display an avatar group in the empty state.

InputGroup#

You can add an InputGroup component to the EmptyContent component.

RTL#

To enable RTL support in Force UI, see the RTL configuration guide.

API Reference#

Empty#

The main component of the empty state. Wraps the EmptyHeader and EmptyContent components.

Copy<Empty>
  <EmptyHeader />
  <EmptyContent />
</Empty>

EmptyHeader#

The EmptyHeader component wraps the empty media, title, and description.

Copy<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.

Copy<EmptyMedia @variant="icon">
  <Icon />
</EmptyMedia>

Copy<EmptyMedia>
  <Avatar>
    <AvatarImage @src="..." />
    <AvatarFallback>CN</AvatarFallback>
  </Avatar>
</EmptyMedia>

EmptyTitle#

Use the EmptyTitle component to display the title of the empty state.

Copy<EmptyTitle>No data</EmptyTitle>

EmptyDescription#

Use the EmptyDescription component to display the description of the empty state.

Copy<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.

Copy<EmptyContent>
  <Button>Add Project</Button>
</EmptyContent>