Empty State

Shown in place of content when there is nothing to display yet, with a hint about what to do next.

Nothing in your cart yet

Add a product and it will show up here.

Usage

Code
import { EmptyState } from '@leverui/components';
Code
<EmptyState.Root>
  <EmptyState.Content>
    <EmptyState.Indicator />
    <EmptyState.Title />
    <EmptyState.Description />
  </EmptyState.Content>
</EmptyState.Root>

For one component that takes props, see the snippet below.

Examples

Sizes

Use the size prop to set the size of the Empty state.

Nothing in your cart yet

Add a product and it will show up here.

Nothing in your cart yet

Add a product and it will show up here.

Nothing in your cart yet

Add a product and it will show up here.

Action

Here's an example of an empty state with an action button.

No color themes yet

Create a theme or import one you already have.

List

Here's an example of an empty state with a list.

No matching colors

Change your search and try again.

  • Remove a filter
  • Search for a different word

Closed Component

Code
import { Show, omit } from 'solid-js';
import type { JSX } from '@solidjs/web';
import { EmptyState, VStack, type EmptyStateRootProps } from '@leverui/components';

export type ClosedEmptyStateProps = EmptyStateRootProps & {
  title: string;
  description?: string | undefined;
  icon?: JSX.Element;
};

export function ClosedEmptyState(props: ClosedEmptyStateProps) {
  const root = omit(props, 'title', 'description', 'icon', 'children');

  return (
    <EmptyState.Root {...root}>
      <EmptyState.Content>
        <Show when={props.icon}>
          <EmptyState.Indicator>{props.icon}</EmptyState.Indicator>
        </Show>
        <Show
          when={props.description}
          fallback={<EmptyState.Title>{props.title}</EmptyState.Title>}
        >
          <VStack style={{ 'text-align': 'center' }}>
            <EmptyState.Title>{props.title}</EmptyState.Title>
            <EmptyState.Description>{props.description}</EmptyState.Description>
          </VStack>
        </Show>
        {props.children}
      </EmptyState.Content>
    </EmptyState.Root>
  );
}
Code
<ClosedEmptyState title="Nothing in your cart yet" description="Add a product to get started" />

Guides

Structure

Root, Content, and Indicator render a div, Title an h3, and Description a p. Put every part inside Root so it picks up the size.

EmptyState also exports each part by its full name. EmptyStatePropsProvider sets a default size, which can be reactive. A prop on a root wins.

Responsive size

size sets the root padding, the content gap, the indicator size, and the title size. It takes a value per screen size or a Solid signal.

The root sets data-size, plus data-size-* for values set per screen size.

Code
<EmptyState.Root size={{ base: 'sm', md: 'lg' }}>
  <EmptyState.Content>
    <EmptyState.Title>No saved items</EmptyState.Title>
  </EmptyState.Content>
</EmptyState.Root>

Accessibility

No status role by default, so screen readers do not announce it. Set role="status" on Root when it appears after a search or a loading step and should be announced politely.

Keep action buttons inside Content. Mark a decorative indicator aria-hidden="true". The title and description should make sense without the picture.

Props

Root

PropDefaultTypeDescription
size'md''sm' | 'md' | 'lg'Empty state size.
asdivNative tagHTML tag to render.
asChild—Solid render functionRender your own element with the root's props.
unstyled—booleanTurn off the Lever UI styles.

Customize with CSS

Import @leverui/components/styles.css before your own CSS.

Variables, for a whole theme or one root: --leverui-empty-state-padding-inline, --leverui-empty-state-padding-block, --leverui-empty-state-gap, --leverui-empty-state-indicator-size, --leverui-empty-state-title-size.

Classes: .leverui-empty-state__*, one per part. Example: .my-empty-state .leverui-empty-state__title { color: navy; }.

Every part takes class, style, unstyled, HTML attributes, refs, as, and asChild.

Explorer

Click a part name in the sidebar to highlight it in the preview.

Component Anatomy

Hover to highlight, click to select parts