Skip to Content

Banner

Display prominent notification banners for alerts, announcements, and status messages.

Import

import { Banner } from "@raydenui/ui";

Usage

Basic

<Banner title="New feature available" />

With Description

<Banner title="Update available" description="A new version of the app is ready to install." />

Status Variants

<Banner status="information" title="Information" description="This is an informational message." /> <Banner status="success" title="Success" description="Your changes have been saved." /> <Banner status="warning" title="Warning" description="This action cannot be undone." /> <Banner status="error" title="Error" description="Something went wrong." /> <Banner status="feature" title="New Feature" description="Check out our latest update." /> <Banner status="opportunity" title="Opportunity" description="Limited time offer available." />

Bold Emphasis

Bold banners have a solid background with white text.

<Banner status="success" emphasis="bold" title="Payment successful" description="Your order has been confirmed." />

Sizes

<Banner size="sm" title="Small banner" /> <Banner size="lg" title="Large banner" />

With Action Button

<Banner title="New update available" buttonLabel="Update now" onButtonClick={() => console.log("Update clicked")} />

Non-dismissible

<Banner title="Important notice" dismissible={false} />

Props

PropTypeDefaultDescription
status"information" | "success" | "error" | "warning" | "feature" | "opportunity""information"Color scheme
emphasis"bold" | "subtle""subtle"Bold uses solid background; subtle uses light tinted background
size"sm" | "lg""lg"Banner height: sm (40px), lg (48px)
titlestring—Headline text (required)
descriptionstring—Optional description text
iconReactNode | IconName—Optional leading icon
buttonLabelstring—Action button label
onButtonClick() => void—Action button callback
dismissiblebooleantrueShow close button
onDismiss() => void—Close button callback
classNamestring—Additional CSS classes

Status Colors

StatusBold BackgroundSubtle Background
informationBlue (#4a9fed)Light blue (#f0f7ff)
successsuccess-400success-50
errorerror-400error-50
warningwarning-400warning-50
featuregrey-900grey-50
opportunityIndigo (#475ccc)Light indigo (#f7f8fd)

Accessibility

  • Uses role="alert" for screen reader announcements
  • Close button has aria-label="Dismiss banner"
  • High contrast between text and background colors
Last updated on