Ballmac UI home

Banner

A page-wide announcement with semantic tones, optional action, and controlled or local dismissal.

A new workspace view is readyYour team can switch to the updated layout at any time.

Installation

$ pnpm dlx shadcn@latest add @ballmac/banner

Usage

import { Banner } from "@/components/ballmac/banner"

The full example is in the Code tab above.

Examples

Everything is syncedAll changes are saved.
Review your connectionUpdates may take longer than usual.

API reference

PropTypeDefault
title*

Short headline that names the announcement.

string—
description

Supporting detail, kept concise for a page-wide banner.

React.ReactNode—
tone

Semantic tone of the announcement.

"info" | "success" | "warning""info"
action

Optional link or button placed after the message.

React.ReactNode—
dismissible

Show a dismiss button.

booleanfalse
visible

Controlled visibility.

boolean—
defaultVisible

Initial visibility when uncontrolled.

booleantrue
onVisibleChange

Called when visibility changes.

(visible: boolean) => void—

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
Tab / EnterFocus and activate the action or dismiss control

Quality scorecard

6/6

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

How we measure
  • Passed: Accessibility scan

    No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).

  • Passed: Small screens

    No sideways scrolling at 360, 390 or 1280 px wide.

  • Passed: Reduced motion

    No endless animation to begin with.

  • Not applicable: Right to left

    Not mirrored by design: A sentence is one line of text, so its words keep their order in the demo's English; the line itself starts on the right. In Arabic or Hebrew the words reverse by themselves.

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Passed: Keyboard

    3 tab stops, each showing a visible change when it takes focus. 1 documented key.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • Passed: Automated tests

    Covered by banner.test.tsx.

  • For information: Footprint

    1.3 KB of source (gzip) in 1 file. Installs lucide-react.

Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.

Use with AI

A page-wide announcement with semantic tones, optional action, and controlled or local dismissal. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Banner (@ballmac/banner) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Announce a page-level update
  • Keep a persistent notice above page content

Not for

  • Use alert for content scoped to one panel

Registry JSON: https://ui.ballmac.com/r/banner.json

Credits

Free to use in personal and commercial projects.

Ballmac UI Pro

Need the whole screen, not one piece?

311 premium blocks (dashboards, settings, calendars, mail, shops, onboarding), a private shadcn registry and Figma tokens. Blocks that show data come with loading, empty and error states built in.

Not ready? Try three Pro blocks free

Leave your email and the blocks appear right here, ready to copy. Yours to use in any project.