Skip to content

Banner

Announcement strip — semantic types, sanitised HTML content, optional persistent dismiss.

Installation

npx @cloudflare/nimbus-docs add banner

Preview

<Banner variant="tip" content="We're hiring — say hi at <a href='#'>jobs@nimbus.dev</a>." />

Examples

Dismissible

Set dismissible to add a close button. The dismissal persists across page loads.

<Banner
variant="caution"
content="Maintenance window: API reads are read-only from 18:00 UTC."
dismissible={{ id: "maint-2026-06", days: 1 }}
/>

API reference

Every prop the component accepts, sourced from a single declaration.

PropType
contentrequired
string
variant
"note" | "tip" | "caution" | "danger"
dismissible
{ id: string; days?: number }
Components

Type to search…

↑↓ navigate↵ selectEsc close