Skip to content
WebJs
Menu

Displays a callout for user attention.

import { html } from '@webjsdev/core';
import { alertClass, alertTitleClass, alertDescriptionClass } from '#components/ui/alert.ts';
import { CheckCircle2Icon, InfoIcon } from '#lib/ui/lucide.ts';

export default function AlertDemo() {
  return html`
    <div class="grid w-full max-w-md items-start gap-4">
      <div data-slot="alert" role="alert" class=${alertClass()}>
        ${CheckCircle2Icon()}
        <div data-slot="alert-title" class=${alertTitleClass()}>Payment successful</div>
        <div data-slot="alert-description" class=${alertDescriptionClass()}>
          Your payment of $29.99 has been processed. A receipt has been sent to
          your email address.
        </div>
      </div>
      <div data-slot="alert" role="alert" class=${alertClass()}>
        ${InfoIcon()}
        <div data-slot="alert-title" class=${alertTitleClass()}>New feature available</div>
        <div data-slot="alert-description" class=${alertDescriptionClass()}>
          We've added dark mode support. You can enable it in your account
          settings.
        </div>
      </div>
    </div>
  `;
}
View Code

Installation

pnpm dlx @webjsdev/ui add alert

Usage

import {
  alertClass,
  alertTitleClass,
  alertDescriptionClass,
} from '#components/ui/alert.ts';
<div data-slot="alert" role="alert" class=${alertClass()}>
  ${InfoIcon()}
  <div data-slot="alert-title" class=${alertTitleClass()}>Heads up!</div>
  <div data-slot="alert-description" class=${alertDescriptionClass()}>
    You can add components and dependencies to your app using the cli.
  </div>
  <div data-slot="alert-action" class="absolute top-2 right-2">
    <button class=${buttonClass({ variant: 'outline' })}>Enable</button>
  </div>
</div>

Composition

Use the following composition to build an alert:

alertClass()
├── Icon
├── alertTitleClass()
├── alertDescriptionClass()
└── data-slot="alert-action"

Basic

A basic alert with an icon, title and description.

import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { alertClass, alertTitleClass, alertDescriptionClass } from '#components/ui/alert.ts';
import { CheckCircle2Icon } from '#lib/ui/lucide.ts';

export default function AlertBasic() {
  return html`
    <div data-slot="alert" role="alert" class=${cn(alertClass(), 'max-w-md')}>
      ${CheckCircle2Icon()}
      <div data-slot="alert-title" class=${alertTitleClass()}>Account updated successfully</div>
      <div data-slot="alert-description" class=${alertDescriptionClass()}>
        Your profile information has been saved. Changes will be reflected
        immediately.
      </div>
    </div>
  `;
}
View Code

Destructive

Use alertClass({ variant: 'destructive' }) to create a destructive alert.

import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { alertClass, alertTitleClass, alertDescriptionClass } from '#components/ui/alert.ts';
import { AlertCircleIcon } from '#lib/ui/lucide.ts';

export default function AlertDestructive() {
  return html`
    <div data-slot="alert" role="alert" class=${cn(alertClass({ variant: 'destructive' }), 'max-w-md')}>
      ${AlertCircleIcon()}
      <div data-slot="alert-title" class=${alertTitleClass()}>Payment failed</div>
      <div data-slot="alert-description" class=${alertDescriptionClass()}>
        Your payment could not be processed. Please check your payment method
        and try again.
      </div>
    </div>
  `;
}
View Code

Action

Add an element marked data-slot="alert-action" to hold a button or other action element. The alert reserves room for it on the inline end, and absolute top-2 right-2 places it in the corner.

import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { buttonClass } from '#components/ui/button.ts';
import { alertClass, alertTitleClass, alertDescriptionClass } from '#components/ui/alert.ts';

// The alert makes room for any child marked data-slot="alert-action"; the
// action itself is positioned in the top corner.
export default function AlertActionExample() {
  return html`
    <div data-slot="alert" role="alert" class=${cn(alertClass(), 'max-w-md')}>
      <div data-slot="alert-title" class=${alertTitleClass()}>Dark mode is now available</div>
      <div data-slot="alert-description" class=${alertDescriptionClass()}>
        Enable it under your profile settings to get started.
      </div>
      <div data-slot="alert-action" class="absolute top-2 right-2">
        <button type="button" data-slot="button" data-variant="default" data-size="xs" class=${buttonClass({ size: 'xs' })}>
          Enable
        </button>
      </div>
    </div>
  `;
}
View Code

Custom Colors

You can customize the alert colors by adding custom classes such as bg-amber-50 dark:bg-amber-950, merged with alertClass() through cn().

import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { alertClass, alertTitleClass, alertDescriptionClass } from '#components/ui/alert.ts';
import { AlertTriangleIcon } from '#lib/ui/lucide.ts';

export default function AlertColors() {
  return html`
    <div data-slot="alert" role="alert" class=${cn(alertClass(), 'max-w-md border-amber-200 bg-amber-50 text-amber-900 dark:border-amber-900 dark:bg-amber-950 dark:text-amber-50')}>
      ${AlertTriangleIcon()}
      <div data-slot="alert-title" class=${alertTitleClass()}>Your subscription will expire in 3 days.</div>
      <div data-slot="alert-description" class=${alertDescriptionClass()}>
        Renew now to avoid service interruption or upgrade to a paid plan to
        continue using the service.
      </div>
    </div>
  `;
}
View Code

RTL

To enable RTL support, see the RTL configuration guide.

import { html } from '@webjsdev/core';
import { alertClass, alertTitleClass, alertDescriptionClass } from '#components/ui/alert.ts';
import { CheckCircle2Icon, InfoIcon } from '#lib/ui/lucide.ts';

const translations = {
  en: {
    dir: 'ltr',
    values: {
      paymentTitle: 'Payment successful',
      paymentDescription:
        'Your payment of $29.99 has been processed. A receipt has been sent to your email address.',
      featureTitle: 'New feature available',
      featureDescription:
        "We've added dark mode support. You can enable it in your account settings.",
    },
  },
  ar: {
    dir: 'rtl',
    values: {
      paymentTitle: 'تم الدفع بنجاح',
      paymentDescription:
        'تمت معالجة دفعتك البالغة 29.99 دولارًا. تم إرسال إيصال إلى عنوان بريدك الإلكتروني.',
      featureTitle: 'ميزة جديدة متاحة',
      featureDescription:
        'لقد أضفنا دعم الوضع الداكن. يمكنك تفعيله في إعدادات حسابك.',
    },
  },
  he: {
    dir: 'rtl',
    values: {
      paymentTitle: 'התשלום בוצע בהצלחה',
      paymentDescription:
        'התשלום שלך בסך 29.99 דולר עובד. קבלה נשלחה לכתובת האימייל שלך.',
      featureTitle: 'תכונה חדשה זמינה',
      featureDescription:
        'הוספנו תמיכה במצב כהה. אתה יכול להפעיל אותו בהגדרות החשבון שלך.',
    },
  },
};

const alerts = [
  { icon: CheckCircle2Icon, titleKey: 'paymentTitle', descriptionKey: 'paymentDescription' },
  { icon: InfoIcon, titleKey: 'featureTitle', descriptionKey: 'featureDescription' },
] as const;

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

  return html`
    <div class="grid w-full max-w-md items-start gap-4" dir=${dir} lang=${lang}>
      ${alerts.map((alert) => html`
        <div data-slot="alert" role="alert" class=${alertClass()}>
          ${alert.icon()}
          <div data-slot="alert-title" class=${alertTitleClass()}>${t[alert.titleKey]}</div>
          <div data-slot="alert-description" class=${alertDescriptionClass()}>${t[alert.descriptionKey]}</div>
        </div>
      `)}
    </div>
  `;
}
View Code

API Reference

An alert is a native <div> with the classes below. The helpers set no role, so put role="alert" on an urgent, interrupting message, or role="status" on a polite, non-urgent update.

alertClass

alertClass() returns the classes for the alert container, which displays a callout for user attention.

OptionTypeDefault
variant"default" | "destructive""default"

alertTitleClass

alertTitleClass() returns the classes for the title of the alert. It takes no options. Mark the element data-slot="alert-title".

alertDescriptionClass

alertDescriptionClass() returns the classes for the description or content of the alert. It takes no options. Mark the element data-slot="alert-description".

Alert action

An action element (like a button) positioned absolutely in the top-right corner of the alert. Mark the element data-slot="alert-action" and position it with absolute top-2 right-2.