Banners are position: fixed announcements. Use bind:open for dismissible campaigns. Interactive open state should live in your route or in svelte example fences.
Setup
<script lang="ts">
import { Banner } from '.';
</script> Inline preview
Docs preview uses a non-fixed shell so the page stays readable. Production usage is the Banner component below.
New release available — check the changelog.
Top banner
<script lang="ts">
import { Banner } from '.';
let open = $state(true);
</script>
<Banner bind:open type="top" color="blue">
<p class="flex items-center text-sm font-normal text-gray-600 dark:text-gray-300">
New release available — check the changelog.
</p>
</Banner> Bottom banner
<script lang="ts">
import { Banner } from '.';
</script>
<Banner type="bottom" color="green">
<p class="text-sm text-gray-700 dark:text-gray-200">Cookie consent / sticky CTA content.</p>
</Banner> Colors
color tokens: primary, secondary, gray, red, orange, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose.
<script lang="ts">
import { Banner } from '.';
</script>
<Banner color="primary">
<p class="text-sm">Primary announcement</p>
</Banner>
<Banner color="red">
<p class="text-sm">Critical notice</p>
</Banner> Non-dismissable
<script lang="ts">
import { Banner } from '.';
</script>
<Banner dismissable={false} color="amber">
<p class="text-sm">Maintenance window starts at 22:00 UTC.</p>
</Banner> onclose
<script lang="ts">
import { Banner } from '.';
let open = $state(true);
</script>
<Banner
bind:open
color="indigo"
onclose={() => console.log('banner dismissed')}
>
<p class="text-sm">Dismiss me</p>
</Banner> Props
| Prop | Type | Default | Description |
|---|---|---|---|
children | Snippet | — | Banner body |
type | 'top' | 'bottom' | 'top' | Fixed edge placement |
color | color token (see above) | 'gray' | Background tint |
open | boolean | true | Bindable visibility |
dismissable | boolean | true | Show close button |
closeAriaLabel | string | 'Remove banner' | Close button aria-label |
transition | TransitionFunc | fade | Enter/exit transition |
params | transition params | — | Passed to transition |
onclose | (event: MouseEvent) => void | — | Fired after dismiss |
class / classes | theme slots | — | base, content, dismissable overrides |
...rest | HTMLAttributes<HTMLDivElement> | — | Root attributes (color / onclose omitted from HTML) |