Installation
Included in the starter. Every new site has it in src/components/ui/banner/. Import it where you need it, or register it in src/components.ts to use it on every page. If your site predates it, install it:
npx @cloudflare/nimbus-docs add banneryarn nimbus-docs add bannerpnpm nimbus-docs add bannerbunx @cloudflare/nimbus-docs add bannerPreview
<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.
| Prop | Type |
|---|---|
contentrequired | string |
variant | "note" | "tip" | "caution" | "danger" |
dismissible | { id: string; days?: number } |