Skip to content
WebJs
Menu

Displays a badge or a component that looks like a badge.

Badge Secondary Destructive Outline
import { html } from '@webjsdev/core';
import { badgeClass } from '#components/ui/badge.ts';

export default function BadgeDemo() {
  return html`
    <div class="flex w-full flex-wrap justify-center gap-2">
      <span data-slot="badge" data-variant="default" class=${badgeClass()}>Badge</span>
      <span data-slot="badge" data-variant="secondary" class=${badgeClass({ variant: 'secondary' })}>Secondary</span>
      <span data-slot="badge" data-variant="destructive" class=${badgeClass({ variant: 'destructive' })}>Destructive</span>
      <span data-slot="badge" data-variant="outline" class=${badgeClass({ variant: 'outline' })}>Outline</span>
    </div>
  `;
}
View Code

Installation

pnpm dlx @webjsdev/ui add badge

Usage

import { badgeClass } from '#components/ui/badge.ts';
<span class=${badgeClass({ variant: 'outline' })}>Badge</span>

Variants

Use the variant option to change the variant of the badge.

Default Secondary Destructive Outline Ghost
import { html } from '@webjsdev/core';
import { badgeClass } from '#components/ui/badge.ts';

export default function BadgeVariants() {
  return html`
    <div class="flex flex-wrap gap-2">
      <span data-slot="badge" data-variant="default" class=${badgeClass()}>Default</span>
      <span data-slot="badge" data-variant="secondary" class=${badgeClass({ variant: 'secondary' })}>Secondary</span>
      <span data-slot="badge" data-variant="destructive" class=${badgeClass({ variant: 'destructive' })}>Destructive</span>
      <span data-slot="badge" data-variant="outline" class=${badgeClass({ variant: 'outline' })}>Outline</span>
      <span data-slot="badge" data-variant="ghost" class=${badgeClass({ variant: 'ghost' })}>Ghost</span>
    </div>
  `;
}
View Code

With Icon

You can render an icon inside the badge. Use data-icon="inline-start" to render the icon on the left and data-icon="inline-end" to render the icon on the right.

Verified Bookmark
import { html } from '@webjsdev/core';
import { badgeClass } from '#components/ui/badge.ts';
import { BadgeCheck, BookmarkIcon } from '#lib/ui/lucide.ts';

export default function BadgeWithIconLeft() {
  return html`
    <div class="flex flex-wrap gap-2">
      <span data-slot="badge" data-variant="secondary" class=${badgeClass({ variant: 'secondary' })}>
        ${BadgeCheck()}
        Verified
      </span>
      <span data-slot="badge" data-variant="outline" class=${badgeClass({ variant: 'outline' })}>
        Bookmark
        ${BookmarkIcon()}
      </span>
    </div>
  `;
}
View Code

With Spinner

You can render a spinner() inside the badge. Remember to add the data-icon="inline-start" or data-icon="inline-end" attribute to the spinner.

Deleting Generating
import { html } from '@webjsdev/core';
import { badgeClass } from '#components/ui/badge.ts';
import { spinner } from '#components/ui/spinner.ts';

export default function BadgeWithSpinner() {
  return html`
    <div class="flex flex-wrap gap-2">
      <span data-slot="badge" data-variant="destructive" class=${badgeClass({ variant: 'destructive' })}>
        ${spinner({ decorative: true })}
        Deleting
      </span>
      <span data-slot="badge" data-variant="secondary" class=${badgeClass({ variant: 'secondary' })}>
        Generating
        ${spinner({ decorative: true })}
      </span>
    </div>
  `;
}
View Code

A class helper styles any element, so a link that looks like a badge is an <a> with the badge's classes. The hover styles apply only when the element is a link.

import { html } from '@webjsdev/core';
import { badgeClass } from '#components/ui/badge.ts';
import { ArrowUpRightIcon } from '#lib/ui/lucide.ts';

export default function BadgeAsLink() {
  return html`
    <a href="#link" data-slot="badge" data-variant="default" class=${badgeClass()}>
      Open Link ${ArrowUpRightIcon()}
    </a>
  `;
}
View Code

Custom Colors

You can customize the colors of a badge by adding custom classes such as bg-green-50 dark:bg-green-800, merged with the helper's through cn().

Blue Green Sky Purple Red
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { badgeClass } from '#components/ui/badge.ts';

export default function BadgeCustomColors() {
  return html`
    <div class="flex flex-wrap gap-2">
      <span data-slot="badge" data-variant="default" class=${cn(badgeClass(), 'bg-blue-50 text-blue-700 dark:bg-blue-950 dark:text-blue-300')}>
        Blue
      </span>
      <span data-slot="badge" data-variant="default" class=${cn(badgeClass(), 'bg-green-50 text-green-700 dark:bg-green-950 dark:text-green-300')}>
        Green
      </span>
      <span data-slot="badge" data-variant="default" class=${cn(badgeClass(), 'bg-sky-50 text-sky-700 dark:bg-sky-950 dark:text-sky-300')}>
        Sky
      </span>
      <span data-slot="badge" data-variant="default" class=${cn(badgeClass(), 'bg-purple-50 text-purple-700 dark:bg-purple-950 dark:text-purple-300')}>
        Purple
      </span>
      <span data-slot="badge" data-variant="default" class=${cn(badgeClass(), 'bg-red-50 text-red-700 dark:bg-red-950 dark:text-red-300')}>
        Red
      </span>
    </div>
  `;
}
View Code

RTL

To enable RTL support, see the RTL configuration guide.

شارة ثانوي مدمر مخطط متحقق إشارة مرجعية
import { html } from '@webjsdev/core';
import { badgeClass } from '#components/ui/badge.ts';
import { BadgeCheck, BookmarkIcon } from '#lib/ui/lucide.ts';

const translations = {
  en: {
    dir: 'ltr',
    values: {
      badge: 'Badge',
      secondary: 'Secondary',
      destructive: 'Destructive',
      outline: 'Outline',
      verified: 'Verified',
      bookmark: 'Bookmark',
    },
  },
  ar: {
    dir: 'rtl',
    values: {
      badge: 'شارة',
      secondary: 'ثانوي',
      destructive: 'مدمر',
      outline: 'مخطط',
      verified: 'متحقق',
      bookmark: 'إشارة مرجعية',
    },
  },
  he: {
    dir: 'rtl',
    values: {
      badge: 'תג',
      secondary: 'משני',
      destructive: 'הרסני',
      outline: 'קווי מתאר',
      verified: 'מאומת',
      bookmark: 'סימנייה',
    },
  },
};

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

  return html`
    <div class="flex w-full flex-wrap justify-center gap-2" dir=${dir} lang=${lang}>
      <span data-slot="badge" data-variant="default" class=${badgeClass()}>${t.badge}</span>
      <span data-slot="badge" data-variant="secondary" class=${badgeClass({ variant: 'secondary' })}>${t.secondary}</span>
      <span data-slot="badge" data-variant="destructive" class=${badgeClass({ variant: 'destructive' })}>${t.destructive}</span>
      <span data-slot="badge" data-variant="outline" class=${badgeClass({ variant: 'outline' })}>${t.outline}</span>
      <span data-slot="badge" data-variant="secondary" class=${badgeClass({ variant: 'secondary' })}>
        ${BadgeCheck()}
        ${t.verified}
      </span>
      <span data-slot="badge" data-variant="outline" class=${badgeClass({ variant: 'outline' })}>
        ${t.bookmark}
        ${BookmarkIcon()}
      </span>
    </div>
  `;
}
View Code

API Reference

badgeClass

badgeClass() returns the classes for a badge or an element that looks like a badge. Put them on a <span> for a static badge, or on an <a> or <button> for an interactive one. badgeVariants() is an alias of badgeClass() that also merges a className.

OptionTypeDefault
variant"default" | "secondary" | "destructive" | "outline" | "ghost" | "link""default"