Skip to content
View as Markdown

Alert ​

The Alert component is a compound component for displaying contextual status messages. It automatically renders a matching icon for each variant and supports optional action buttons and dismiss behavior.

Import ​

tsx
import { Alert } from "@tailor-platform/app-shell";

The examples below also import useState from react, and Button, Text, and alertVariants from @tailor-platform/app-shell.

Basic Usage ​

tsx
function BasicUsage() {
  return (
    <Alert.Root variant="success">
      <Alert.Title>Saved</Alert.Title>
      <Alert.Description>Your changes have been saved.</Alert.Description>
    </Alert.Root>
  );
}

Sub-components ​

Sub-componentDescription
Alert.RootContainer with variant styling and automatic icon
Alert.TitleBold title line of the alert
Alert.DescriptionAdditional descriptive text below the title

Props ​

Generated from the type surface — first-party props only.

AlertProps ​

PropTypeDefaultDescription
action?React.ReactNode-Action element rendered below the description
dismissible?boolean-Shows a dismiss button; hides the alert when clicked
onDismiss?() => void-Callback invoked when the dismiss button is clicked
variant?"error" | "neutral" | "success" | "warning" | "info" | null"neutral"Visual style and automatic icon

Exports ​

  • Alert — const
  • AlertProps — type
  • alertVariants — const

All standard HTML <div> props are also accepted.

Variants ​

Each variant automatically renders a contextual icon:

tsx
function Variants() {
  return (
    <div className="flex flex-col gap-3">
      <Alert.Root variant="neutral">
        <Alert.Title>Note</Alert.Title>
        <Alert.Description>General information.</Alert.Description>
      </Alert.Root>
      <Alert.Root variant="success">
        <Alert.Title>Success</Alert.Title>
        <Alert.Description>Operation completed successfully.</Alert.Description>
      </Alert.Root>
      <Alert.Root variant="warning">
        <Alert.Title>Warning</Alert.Title>
        <Alert.Description>Proceed with caution.</Alert.Description>
      </Alert.Root>
      <Alert.Root variant="error">
        <Alert.Title>Error</Alert.Title>
        <Alert.Description>Something went wrong.</Alert.Description>
      </Alert.Root>
      <Alert.Root variant="info">
        <Alert.Title>Info</Alert.Title>
        <Alert.Description>Here is some useful information.</Alert.Description>
      </Alert.Root>
    </div>
  );
}
VariantAutomatic IconColor palette
neutralMessage circle iconMuted surface
successCheck circle iconGreen
warningAlert triangle iconYellow
errorX circle iconRed/destructive
infoInfo iconBlue

With Action Button ​

Use the action prop to render an action element below the description:

tsx
function WithAction() {
  return (
    <Alert.Root
      variant="warning"
      action={
        <Button size="sm" variant="outline">
          Review
        </Button>
      }
    >
      <Alert.Title>Review Required</Alert.Title>
      <Alert.Description>This record has pending changes that need review.</Alert.Description>
    </Alert.Root>
  );
}

Dismissible Alert ​

Set dismissible to show a close button. Use onDismiss to react when the alert is dismissed:

tsx
function DismissibleAlert() {
  const [dismissed, setDismissed] = useState(false);

  return (
    <div className="flex flex-col gap-3">
      {dismissed ? (
        <Button variant="outline" onClick={() => setDismissed(false)}>
          Show alert again
        </Button>
      ) : (
        <Alert.Root variant="info" dismissible onDismiss={() => setDismissed(true)}>
          <Alert.Title>New Feature Available</Alert.Title>
          <Alert.Description>Check out the new dashboard layout in Settings.</Alert.Description>
        </Alert.Root>
      )}
      <Text.p role="status">
        {dismissed ? "Alert dismissed." : "Use the close button to dismiss this alert."}
      </Text.p>
    </div>
  );
}

Note: When dismissible is true, clicking the close button hides the alert via internal state. The onDismiss callback fires after the alert is hidden.

Examples ​

Warning with Action ​

This example records the action locally instead of navigating away from the documentation or changing billing information.

tsx
function WarningWithAction() {
  const [requested, setRequested] = useState(false);

  return (
    <div className="flex flex-col gap-3">
      <Alert.Root
        variant="warning"
        action={
          <Button size="sm" variant="outline" onClick={() => setRequested(true)}>
            Update Billing
          </Button>
        }
      >
        <Alert.Title>Payment Method Expiring</Alert.Title>
        <Alert.Description>
          Your credit card on file expires at the end of this month.
        </Alert.Description>
      </Alert.Root>
      <Text.p role="status">
        {requested
          ? "Billing settings would open here."
          : "Click Update Billing to try the action."}
      </Text.p>
    </div>
  );
}

Accessibility ​

  • The root element has role="alert" so screen readers announce the message.
  • The dismiss button has aria-label="Dismiss".
  • Variant icons are marked aria-hidden and are decorative only — the text content carries the meaning.

Styling ​

Alerts are styled with the library's internal astw:-prefixed utilities. Write plain Tailwind utilities in your own markup, and reach for variant rather than restyling what Alert sets itself — see Styling AppShell components. Customize appearance using:

  1. Using className on Alert.Root for additional styles
  2. Using alertVariants utility to apply variant classes to custom elements
tsx
function StylingUtility() {
  return (
    <div role="alert" className={`${alertVariants({ variant: "info" })} my-4`}>
      Custom alert container
    </div>
  );
}
  • Badge - Inline status labels
  • Button - Use as action element inside alerts