Alert

A bordered in-page message with `role="alert"`, an optional leading icon, a title and a description, in two tones (default and destructive).

feedbackserveruiv1.1.0

Preview

Alert — live renderprimitives-alert--default

Rendered from the story the storybook (a11y) CI gate runs axe against — the preview can't show something that hasn't been verified.

Install

Two equivalent paths — the URL works in any shadcn-CLI setup; the alias works once you've registered @interlace in your components.json.

Via shadcn URL
npx shadcn@latest add https://ds.interlace.tools/r/alert.json
With the @interlace alias
npx shadcn@latest add @interlace/alert

Behavior

What this component does — the keyboard path, the measured colour, the text equivalent and the states it can be in. Every figure below is read out of the test or the source that enforces it by scripts/build-behavior-map.mjs, so nothing here can outlive the gate that keeps it true.

Every semantic colour pair this component's own source uses, measured against the shipped hexes in all 4 theme × scheme combinations. The tightest is destructive on background at 7.60:1 (harbor · light), against a floor of 3:1.

Measured WCAG contrast ratios per token pair and theme
PairinterlacelightinterlacedarkharborlightharbordarkFloor
destructive on backgrounddestructive tint on the page surface8.31:110.43:17.60:110.03:13.0:1SC 1.4.11
muted-foreground on backgroundsecondary copy9.41:111.32:17.82:19.52:14.5:1SC 1.4.3
destructive on carddestructive tint inside a card8.31:19.66:18.02:19.09:13.0:1SC 1.4.11
muted-foreground on cardsecondary copy in a card9.41:110.48:18.25:18.64:14.5:1SC 1.4.3
card-foreground on cardcopy in a card19.65:115.71:118.72:114.69:14.5:1SC 1.4.3

Text pairs are held to 4.5:1 (WCAG 2.2 SC 1.4.3); borders, rings and chart axes to 3:1 (SC 1.4.11 non-text). Bold is the worst cell in the row — the one a brand fork has to keep an eye on.

Where it renders, how narrow it survives, and whether its lines are inside the coverage gate — three answers a consumer needs before the paste, not after the bug.

Render boundary
server component

Renders during SSR / RSC with no hydration cost. It can be imported from a server component without pulling the page into the client.

Minimum viewport
none declared

No width floor: it takes the width it is given. Its container owns the layout question.

Coverage gate
100% × 4

Inside the v8 gate: lines 100, statements 100, functions 100, branches 100. A threshold under 100 only records how much you stopped caring, so there isn't one.

History

This component is at v1.1.0, first shipped in @interlace/ui 1.0.0. The version is stamped as a banner into the file the install writes, so the copy in your tree says which one you have — compare it with the number above before deciding whether to re-run the install.

Import

4 named exports — pull the parts you need.

Public API
import { Alert, AlertDescription, AlertTitle, alertVariants } from '@/components/ui/alert';

Anatomy

Extracted from the primitive's JSDoc header. The source is the only documentation that can't drift.

Alert                            (div — role=alert, CSS grid)
    ├─ <svg>                       (optional, any icon; sizing is imposed here)
    ├─ AlertTitle                  (div — col-start-2)
    └─ AlertDescription            (div — col-start-2)
The icon is styled by descendant selectors on the root (`[&>svg]:size-4`,
`translate-y-0.5`, `text-current`), so it must be a DIRECT child — an icon
wrapped in a span gets neither the sizing nor the grid column.

Variants

Closed prop unions enforced by class-variance-authority. See Storybook's Variants story for the rendered matrix.

  • variant
    • defaultdefault
    • destructive

API reference

Parsed from the type declarations in the source — the same file the install writes into your tree, so this table can't drift from the component you get.

Alert

Also accepts every <div> attribute. Plus the variant props listed above.

AlertTitle

Also accepts every <div> attribute.

AlertDescription

Also accepts every <div> attribute.

Accessibility

Every story for this component is rendered headlessly and checked with axe-core (wcag2aa, wcag22aa, best-practice, ACT) on every PR. That gate has no continue-on-error, so what ships has zero known violations.

What follows is what static analysis can see. Axe cannot press a key and never sees an overlay open, so the operable-without-a-mouse claim lives in Behavior instead, where the keyboard path is replayed step by step.

Focus + keyboard behaviour
Native element semantics — no interaction layer to get wrong.
Focus ring (WCAG 2.2 SC 2.4.13)
Not focusable — no focus indicator required.
Reduced motion
No animation to gate.
ARIA in the source
  • role="alert"

Examples

1 more state from the same story file.

R-rule compliance

Every primitive in @interlace/ui models to the portable 26-rule floor enforced by the componentApi ESLint preset. The cells below pin exactly where each rule applies in this file.

RuleConceptWhere
R4Extends native el`React.ComponentProps<'div'>` on all three parts
R6data-slot per partalert / alert-title / alert-description
R7cva + cn + ...rest`cn(alertVariants({ variant }), className)` + `{...props}`
R8Enum for tone`variant = default
R19Tokens only`bg-card`, `text-card-foreground`, `text-destructive`
R25Server componentNo hooks → no `'use client'`
R26A11y`role="alert"` on the root; the icon inherits `text-current`

Dependencies

Base UI primitive
Native / no Base UI dependency
Lucide icons
none
NPM dependencies
  • class-variance-authority
Registry dependencies

Source

The full implementation — components/ui/alert.tsx once installed.

111 lines · TypeScript
import * as React from 'react';

// @interlace/alert v1.1.0 — Interlace design system.
// Docs, props and live preview: https://ds.interlace.tools/c/alert
// What changed since: https://ds.interlace.tools/c/alert#history
// Generated banner — keep it, the upgrade diff reads this version.

/**
 * @interlace/ui — Alert
 *
 * A bordered in-page message with `role="alert"`, an optional leading icon, a
 * title and a description, in two tones (default and destructive).
 *
 * The icon column exists only when a direct `<svg>` child does — `has-[>svg]`
 * switches the grid from `[0_1fr]` to two columns — so a text-only alert has
 * no empty gutter.
 *
 * ## Anatomy
 *
 *   Alert                            (div — role=alert, CSS grid)

…91 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.