Skip to content
GitHub

Announcement

A compound badge designed to display announcements.

Releasev2.1.0 — Dark mode, faster builds, and 12 new components

Installation

Usage

Variants

The variant prop on <AnnouncementBadge /> controls the badge visual style.

Info

MaintenanceScheduled downtime tonight 2–4 AM UTC. No action needed.

Success

Warning

Trial endingYour free trial expires in 3 days. Upgrade to keep access.

Destructive

Payment failedYour last invoice couldn't be processed. Update your billing info.

Examples

With icon

Add icons to the badge or title to provide visual context. Use aria-hidden on decorative icons.

New featuresDark mode and 12 new components available

The asChild prop renders a link with announcement styling.

Without Badge

The announcement supports a title-only layout without the badge component.

New features added, check the logs for more details.

API Reference

Announcement

Root wrapper for announcement banners or notices.

AnnouncementBadge

Optional badge (e.g. New, Sale) shown alongside the title.

AnnouncementTitle

Main title or message of the announcement.