Skip to content

Banner

SM · 950B gzip budget

Site-wide announcement banner with dismiss and persist.

Category
Feedback & status
Budget
sm, single-purpose control
External runtime
React / React DOM only
axe fixtureSSR rendersource scanbundle budget

Preview

Live fixture
Preview locale
New version available

Try the component here. Locale-aware formatting and direction follow the selected language; example content and labels are not automatically translated. Overlay demos use interactive launchers.

Install

npx shadcn@latest add https://gear5-ui.vercel.app/r/banner.json

Copies the source into your project.

New here? Set up Tailwind and import aliases first →

Source & props

Edit on GitHub ↗

Prop types and inline documentation are included below. This is repository source; the installer rewrites shared imports for your project.

"use client";

import React, { useCallback, useState } from "react";

export interface BannerProps {
  children: React.ReactNode;
  tone?: "info" | "warning" | "error" | "success";
  dismissible?: boolean;
  onDismiss?: () => void;
  ariaLabel?: string;
}

const toneColors: Record<string, { bg: string; color: string }> = {
  info: { bg: "#e3f2fd", color: "#0d47a1" },
  warning: { bg: "#fff3e0", color: "#e65100" },
  error: { bg: "#fdecea", color: "#b71c1c" },
  success: { bg: "#e8f5e9", color: "#1b5e20" },
};

export function Banner({
  children,
  tone = "info",
  dismissible = true,
  onDismiss,
  ariaLabel,
}: BannerProps) {
  const [visible, setVisible] = useState(true);
  const colors = toneColors[tone];

  const handleDismiss = useCallback(() => {
    setVisible(false);
    onDismiss?.();
  }, [onDismiss]);

  if (!visible) return null;

  return (
    <div
      role={tone === "error" ? "alert" : "status"}
      aria-live="polite"
      aria-label={ariaLabel}
      style={{
        width: "100%",
        display: "flex",
        alignItems: "center",
        justifyContent: "center",
        gap: "0.75rem",
        padding: "0.625rem 1rem",
        backgroundColor: colors.bg,
        color: colors.color,
        fontSize: "0.875rem",
        lineHeight: "1.25rem",
        textAlign: "center",
      }}
    >
      <span style={{ flex: 1 }}>{children}</span>
      {dismissible && (
        <button
          onClick={handleDismiss}
          aria-label="Dismiss banner"
          style={{
            background: "none",
            border: "none",
            color: colors.color,
            cursor: "pointer",
            padding: "0.25rem",
            borderRadius: "0.25rem",
            display: "flex",
            alignItems: "center",
            justifyContent: "center",
            flexShrink: 0,
          }}
        >
          <svg width="16" height="16" viewBox="0 0 16 16" fill="none">
            <path
              d="M4 4L12 12M12 4L4 12"
              stroke="currentColor"
              strokeWidth="1.5"
              strokeLinecap="round"
            />
          </svg>
        </button>
      )}
    </div>
  );
}

What CI checks

Quality contract
  • Bundled, minified and gzipped against its tier budget
  • Audited by axe in the state previewed above
  • Rendered through react-dom/server with no browser globals
  • Scanned for network calls, dangerous sinks, and unguarded animation
← All components