Skip to content
WebJs
Menu

Use the Empty component to display an empty state.

No Projects Yet
You haven't created any projects yet. Get started by creating your first project.
Learn More
import { html, svg } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
  emptyClass, emptyHeaderClass, emptyMediaClass, emptyTitleClass,
  emptyDescriptionClass, emptyContentClass,
} from '#components/ui/empty.ts';
import { ArrowUpRightIcon } from '#lib/ui/lucide.ts';

// Tabler's folder-code icon, the one shadcn's demo imports from
// @tabler/icons-react.
const IconFolderCode = () =>
  svg`<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" class="tabler-icon tabler-icon-folder-code"><path d="M11 19h-6a2 2 0 0 1 -2 -2v-11a2 2 0 0 1 2 -2h4l3 3h7a2 2 0 0 1 2 2v4"></path><path d="M20 21l2 -2l-2 -2"></path><path d="M17 17l-2 2l2 2"></path></svg>`;

export default function EmptyDemo() {
  return html`
    <div data-slot="empty" class=${emptyClass()}>
      <div data-slot="empty-header" class=${emptyHeaderClass()}>
        <div data-slot="empty-icon" data-variant="icon" class=${emptyMediaClass({ variant: 'icon' })}>
          ${IconFolderCode()}
        </div>
        <div data-slot="empty-title" class=${emptyTitleClass()}>No Projects Yet</div>
        <div data-slot="empty-description" class=${emptyDescriptionClass()}>
          You haven&apos;t created any projects yet. Get started by creating
          your first project.
        </div>
      </div>
      <div data-slot="empty-content" class=${cn(emptyContentClass(), 'flex-row justify-center gap-2')}>
        <button type="button" data-slot="button" data-variant="default" data-size="default" class=${buttonClass()}>Create Project</button>
        <button type="button" data-slot="button" data-variant="outline" data-size="default" class=${buttonClass({ variant: 'outline' })}>Import Project</button>
      </div>
      <a href="#" data-slot="button" data-variant="link" data-size="sm" class=${cn(buttonClass({ variant: 'link', size: 'sm' }), 'text-muted-foreground')}>
        Learn More ${ArrowUpRightIcon()}
      </a>
    </div>
  `;
}
View Code

Installation

pnpm dlx @webjsdev/ui add empty

Usage

import {
  emptyClass,
  emptyContentClass,
  emptyDescriptionClass,
  emptyHeaderClass,
  emptyMediaClass,
  emptyTitleClass,
} from '#components/ui/empty.ts';
<div data-slot="empty" class=${emptyClass()}>
  <div data-slot="empty-header" class=${emptyHeaderClass()}>
    <div data-slot="empty-icon" data-variant="icon" class=${emptyMediaClass({ variant: 'icon' })}>
      <svg aria-hidden="true">...</svg>
    </div>
    <h3 data-slot="empty-title" class=${emptyTitleClass()}>No data</h3>
    <p data-slot="empty-description" class=${emptyDescriptionClass()}>No data found</p>
  </div>
  <div data-slot="empty-content" class=${emptyContentClass()}>
    <button class=${buttonClass()}>Add data</button>
  </div>
</div>

Composition

Use the following composition to build an empty state:

emptyClass
├── emptyHeaderClass
│   ├── emptyMediaClass
│   ├── emptyTitleClass
│   └── emptyDescriptionClass
└── emptyContentClass

Outline

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

Cloud Storage Empty
Upload files to your cloud storage to access them anywhere.
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
  emptyClass, emptyHeaderClass, emptyMediaClass, emptyTitleClass,
  emptyDescriptionClass, emptyContentClass,
} from '#components/ui/empty.ts';
import { IconCloud } from '#lib/ui/tabler.ts';

export default function EmptyOutline() {
  return html`
    <div data-slot="empty" class=${cn(emptyClass(), 'border border-dashed')}>
      <div data-slot="empty-header" class=${emptyHeaderClass()}>
        <div data-slot="empty-icon" data-variant="icon" class=${emptyMediaClass({ variant: 'icon' })}>
          ${IconCloud()}
        </div>
        <div data-slot="empty-title" class=${emptyTitleClass()}>Cloud Storage Empty</div>
        <div data-slot="empty-description" class=${emptyDescriptionClass()}>
          Upload files to your cloud storage to access them anywhere.
        </div>
      </div>
      <div data-slot="empty-content" class=${emptyContentClass()}>
        <button type="button" data-slot="button" data-variant="outline" data-size="sm" class=${buttonClass({ variant: 'outline', size: 'sm' })}>
          Upload Files
        </button>
      </div>
    </div>
  `;
}
View Code

Background

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

No Notifications
You're all caught up. New notifications will appear here.
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
  emptyClass, emptyHeaderClass, emptyMediaClass, emptyTitleClass,
  emptyDescriptionClass, emptyContentClass,
} from '#components/ui/empty.ts';
import { IconBell } from '#lib/ui/tabler.ts';
import { RefreshCcwIcon } from '#lib/ui/lucide.ts';

export default function EmptyMuted() {
  return html`
    <div data-slot="empty" class=${cn(emptyClass(), 'h-full bg-muted/30')}>
      <div data-slot="empty-header" class=${emptyHeaderClass()}>
        <div data-slot="empty-icon" data-variant="icon" class=${emptyMediaClass({ variant: 'icon' })}>
          ${IconBell()}
        </div>
        <div data-slot="empty-title" class=${emptyTitleClass()}>No Notifications</div>
        <div data-slot="empty-description" class=${cn(emptyDescriptionClass(), 'max-w-xs text-pretty')}>
          You&apos;re all caught up. New notifications will appear here.
        </div>
      </div>
      <div data-slot="empty-content" class=${emptyContentClass()}>
        <button type="button" data-slot="button" data-variant="outline" data-size="default" class=${buttonClass({ variant: 'outline' })}>
          ${RefreshCcwIcon()}
          Refresh
        </button>
      </div>
    </div>
  `;
}
View Code

Avatar

Use emptyMediaClass() to display an avatar in the empty state.

VK
User Offline
This user is currently offline. You can leave a message to notify them or try again later.
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { avatarClass, avatarImageClass, avatarFallbackClass } from '#components/ui/avatar.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
  emptyClass, emptyHeaderClass, emptyMediaClass, emptyTitleClass,
  emptyDescriptionClass, emptyContentClass,
} from '#components/ui/empty.ts';

export default function EmptyAvatar() {
  return html`
    <div data-slot="empty" class=${emptyClass()}>
      <div data-slot="empty-header" class=${emptyHeaderClass()}>
        <div data-slot="empty-icon" data-variant="default" class=${emptyMediaClass({ variant: 'default' })}>
          <span data-slot="avatar" data-size="default" class=${cn(avatarClass(), 'size-12')}>
            <img data-slot="avatar-image" src="/avatars/vivek.jpg" alt="" class=${cn(avatarImageClass(), 'grayscale')}>
            <span data-slot="avatar-fallback" class=${avatarFallbackClass()}>VK</span>
          </span>
        </div>
        <div data-slot="empty-title" class=${emptyTitleClass()}>User Offline</div>
        <div data-slot="empty-description" class=${emptyDescriptionClass()}>
          This user is currently offline. You can leave a message to notify them
          or try again later.
        </div>
      </div>
      <div data-slot="empty-content" class=${emptyContentClass()}>
        <button type="button" data-slot="button" data-variant="default" data-size="sm" class=${buttonClass({ size: 'sm' })}>Leave Message</button>
      </div>
    </div>
  `;
}
View Code

Avatar Group

Use emptyMediaClass() to display an avatar group in the empty state.

@vivek VK @maxleiter LR @evilrabbit ER
No Team Members
Invite your team to collaborate on this project.
import { html } from '@webjsdev/core';
import { avatarClass, avatarImageClass, avatarFallbackClass } from '#components/ui/avatar.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
  emptyClass, emptyHeaderClass, emptyMediaClass, emptyTitleClass,
  emptyDescriptionClass, emptyContentClass,
} from '#components/ui/empty.ts';
import { PlusIcon } from '#lib/ui/lucide.ts';

export default function EmptyAvatarGroup() {
  return html`
    <div data-slot="empty" class=${emptyClass()}>
      <div data-slot="empty-header" class=${emptyHeaderClass()}>
        <div data-slot="empty-icon" data-variant="default" class=${emptyMediaClass()}>
          <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">
            <span data-slot="avatar" data-size="default" class=${avatarClass()}>
              <img data-slot="avatar-image" src="/avatars/vivek.jpg" alt="@vivek" class=${avatarImageClass()}>
              <span data-slot="avatar-fallback" class=${avatarFallbackClass()}>VK</span>
            </span>
            <span data-slot="avatar" data-size="default" class=${avatarClass()}>
              <img data-slot="avatar-image" src="https://github.com/maxleiter.png" alt="@maxleiter" class=${avatarImageClass()}>
              <span data-slot="avatar-fallback" class=${avatarFallbackClass()}>LR</span>
            </span>
            <span data-slot="avatar" data-size="default" class=${avatarClass()}>
              <img data-slot="avatar-image" src="https://github.com/evilrabbit.png" alt="@evilrabbit" class=${avatarImageClass()}>
              <span data-slot="avatar-fallback" class=${avatarFallbackClass()}>ER</span>
            </span>
          </div>
        </div>
        <div data-slot="empty-title" class=${emptyTitleClass()}>No Team Members</div>
        <div data-slot="empty-description" class=${emptyDescriptionClass()}>
          Invite your team to collaborate on this project.
        </div>
      </div>
      <div data-slot="empty-content" class=${emptyContentClass()}>
        <button type="button" data-slot="button" data-variant="default" data-size="sm" class=${buttonClass({ size: 'sm' })}>
          ${PlusIcon()}
          Invite Members
        </button>
      </div>
    </div>
  `;
}
View Code

InputGroup

You can add an Input Group to the element with emptyContentClass().

404 - Not Found
The page you're looking for doesn't exist. Try searching for what you need below.
Need help? Contact support
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import {
  emptyClass, emptyHeaderClass, emptyTitleClass, emptyDescriptionClass, emptyContentClass,
} from '#components/ui/empty.ts';
import {
  inputGroupClass, inputGroupAddonClass, inputGroupInputClass,
} from '#components/ui/input-group.ts';
import { kbdClass } from '#components/ui/kbd.ts';
import { SearchIcon } from '#lib/ui/lucide.ts';

export default function EmptyInputGroup() {
  return html`
    <div data-slot="empty" class=${emptyClass()}>
      <div data-slot="empty-header" class=${emptyHeaderClass()}>
        <div data-slot="empty-title" class=${emptyTitleClass()}>404 - Not Found</div>
        <div data-slot="empty-description" class=${emptyDescriptionClass()}>
          The page you&apos;re looking for doesn&apos;t exist. Try searching for
          what you need below.
        </div>
      </div>
      <div data-slot="empty-content" class=${emptyContentClass()}>
        <div data-slot="input-group" role="group" class=${cn(inputGroupClass(), 'sm:w-3/4')}>
          <input data-slot="input-group-control" id="empty-input-group-search" placeholder="Try searching for pages..." aria-label="Search pages" class=${inputGroupInputClass()}>
          <label data-slot="input-group-addon" data-align="inline-start" for="empty-input-group-search" class=${inputGroupAddonClass()}>
            ${SearchIcon()}
          </label>
          <label data-slot="input-group-addon" data-align="inline-end" for="empty-input-group-search" class=${inputGroupAddonClass({ align: 'inline-end' })}>
            <kbd data-slot="kbd" class=${kbdClass()}>/</kbd>
          </label>
        </div>
        <div data-slot="empty-description" class=${emptyDescriptionClass()}>
          Need help? <a href="#">Contact support</a>
        </div>
      </div>
    </div>
  `;
}
View Code

RTL

To enable RTL support, see the RTL configuration guide.

لا توجد مشاريع بعد
لم تقم بإنشاء أي مشاريع بعد. ابدأ بإنشاء مشروعك الأول.
تعرف على المزيد
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
  emptyClass, emptyHeaderClass, emptyMediaClass, emptyTitleClass,
  emptyDescriptionClass, emptyContentClass,
} from '#components/ui/empty.ts';
import { IconFolderCode } from '#lib/ui/tabler.ts';
import { ArrowUpRightIcon } from '#lib/ui/lucide.ts';

const translations = {
  en: {
    dir: 'ltr',
    values: {
      title: 'No Projects Yet',
      description:
        "You haven't created any projects yet. Get started by creating your first project.",
      createProject: 'Create Project',
      importProject: 'Import Project',
      learnMore: 'Learn More',
    },
  },
  ar: {
    dir: 'rtl',
    values: {
      title: 'لا توجد مشاريع بعد',
      description: 'لم تقم بإنشاء أي مشاريع بعد. ابدأ بإنشاء مشروعك الأول.',
      createProject: 'إنشاء مشروع',
      importProject: 'استيراد مشروع',
      learnMore: 'تعرف على المزيد',
    },
  },
  he: {
    dir: 'rtl',
    values: {
      title: 'אין פרויקטים עדיין',
      description:
        'עדיין לא יצרת פרויקטים. התחל על ידי יצירת הפרויקט הראשון שלך.',
      createProject: 'צור פרויקט',
      importProject: 'ייבא פרויקט',
      learnMore: 'למד עוד',
    },
  },
};

export default function EmptyRtl() {
  const lang = 'ar';
  const { dir, values: t } = translations[lang];

  return html`
    <div data-slot="empty" dir=${dir} lang=${lang} class=${emptyClass()}>
      <div data-slot="empty-header" class=${emptyHeaderClass()}>
        <div data-slot="empty-icon" data-variant="icon" class=${emptyMediaClass({ variant: 'icon' })}>
          ${IconFolderCode()}
        </div>
        <div data-slot="empty-title" class=${emptyTitleClass()}>${t.title}</div>
        <div data-slot="empty-description" class=${emptyDescriptionClass()}>${t.description}</div>
      </div>
      <div data-slot="empty-content" class=${cn(emptyContentClass(), 'flex-row justify-center gap-2')}>
        <button type="button" data-slot="button" data-variant="default" data-size="default" class=${buttonClass()}>${t.createProject}</button>
        <button type="button" data-slot="button" data-variant="outline" data-size="default" class=${buttonClass({ variant: 'outline' })}>${t.importProject}</button>
      </div>
      <a href="#" data-slot="button" data-variant="link" data-size="sm" class=${cn(buttonClass({ variant: 'link', size: 'sm' }), 'text-muted-foreground')}>
        ${t.learnMore} ${ArrowUpRightIcon('rtl:rotate-270')}
      </a>
    </div>
  `;
}
View Code

API Reference

Every part is a class helper you put on a native element. None takes options except emptyMediaClass(); merge your own classes with cn().

emptyClass

The root of the empty state. Wraps the header and the content. It carries border-dashed but no border width, so it renders borderless until you add border. When the empty state appears in response to a search or a filter, put role="status" on it so the change is announced.

<div data-slot="empty" class=${emptyClass()}>
  <div data-slot="empty-header" class=${emptyHeaderClass()}>...</div>
  <div data-slot="empty-content" class=${emptyContentClass()}>...</div>
</div>

emptyHeaderClass

Wraps the empty media, title, and description.

<div data-slot="empty-header" class=${emptyHeaderClass()}>
  <div data-slot="empty-icon" class=${emptyMediaClass()}>...</div>
  <h3 data-slot="empty-title" class=${emptyTitleClass()}>...</h3>
  <p data-slot="empty-description" class=${emptyDescriptionClass()}>...</p>
</div>

emptyMediaClass

Displays 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. Set data-variant to the same variant. The media is decorative, so mark the icon aria-hidden="true".

OptionTypeDefault
variant"default" | "icon""default"
<div data-slot="empty-icon" data-variant="icon" class=${emptyMediaClass({ variant: 'icon' })}>
  <svg aria-hidden="true">...</svg>
</div>
<div data-slot="empty-icon" data-variant="default" class=${emptyMediaClass()}>
  <span data-slot="avatar" class=${avatarClass()}>
    <img data-slot="avatar-image" src="..." alt="" class=${avatarImageClass()}>
    <span data-slot="avatar-fallback" class=${avatarFallbackClass()}>CN</span>
  </span>
</div>

emptyTitleClass

Displays the title of the empty state. Put it on a real heading, at the level the surrounding document wants.

<h3 data-slot="empty-title" class=${emptyTitleClass()}>No data</h3>

emptyDescriptionClass

Displays the description of the empty state. A link inside it is underlined.

<p data-slot="empty-description" class=${emptyDescriptionClass()}>You do not have any notifications.</p>

emptyContentClass

Displays the content of the empty state, such as a button, an input or a link.

<div data-slot="empty-content" class=${emptyContentClass()}>
  <button class=${buttonClass()}>Add Project</button>
</div>