Skip to content

Shell header

Sticky top application bar that composes a logo slot, optional breadcrumbs, a search input, a command-palette trigger (Cmd+K), and an account-menu slot. Pure layout — no data fetching.

Installation

First install? Complete the one-time host setup.

Live preview

A sticky, data-free top app bar that composes logo, breadcrumbs, search, and account-menu slots. A compact header; try the ⌘K trigger and sidebar toggle.

Loading preview…

Built with Button, Input, Separator.

Props

PropTypeDefaultDescription
logoReact.ReactNodeLogo or wordmark rendered at the left edge, separated from breadcrumbs by a vertical divider.
breadcrumbsSlotReact.ReactNodeSlot for a breadcrumbs component (e.g. `shell-breadcrumbs`). Fills the center-left flex region when `showBreadcrumbs` is true.
accountMenuSlotReact.ReactNodeSlot for an account-menu component pinned to the right edge.
showSearchbooleanfalseRender the search input (hidden on small screens via `sm:block`).
showCommandPalettebooleantrueRender the Cmd+K trigger button.
onCommandPaletteOpen() => voidFires when the Cmd+K button is clicked or the keyboard shortcut is pressed.
showSidebarTogglebooleantrueRender the hamburger toggle (visible only below the `lg` breakpoint).
sidebarOpenbooleanfalsePassed as `aria-expanded` on the hamburger — parent owns drawer state.
onSidebarToggle() => voidFires when the hamburger is clicked; parent updates `sidebarOpen`.
messagesShellHeaderMessageOverridesPartial override for aria labels, search placeholder, and the command-palette shortcut hint.

Messages

copy

KeyDefault copy
headerAriaLabelApplication header
sidebarToggleAriaLabelToggle sidebar
commandPaletteAriaLabelOpen command palette
commandPaletteShortcut⌘K
searchPlaceholderSearch…

errors

CodeDefault copy
UNKNOWN_ERRORSomething went wrong. Please try again.