Skip to contentKino
Skip to Content

App shell

The frame of an app. A sidebar with the workspaces and the person signed in, a header with the breadcrumb, search and notifications, and the page with its title and actions. The page sits as a card, on one plane, or under a bar across the top.

Preview

The page is a card on the sidebar’s tint, its header inside it. The toggle collapses the sidebar to its icons, and on a phone the sidebar is a sheet. In your app, ⌘B and ⌘K do the same as the toggle and the search.

npx shadcn add https://kinoui.com/r/app-shell.json
Skip to content

Billing revamp

New invoices and tax rules · Due 12 Dec

Examples

Flat

The sidebar and the page share one plane, split by a line, for an app whose pages are dense tables and lists.

npx shadcn add https://kinoui.com/r/app-shell.json
Skip to content

Billing revamp

New invoices and tax rules · Due 12 Dec

Top bar

A bar across the top holds the workspaces, the search, the notifications and the person, and the sidebar under it holds only the pages.

npx shadcn add https://kinoui.com/r/app-shell.json
Skip to content

Billing revamp

New invoices and tax rules · Due 12 Dec

Installation

npx shadcn@latest add https://kinoui.com/r/app-shell.json
Files
lib/reduce-motion.tslib/scroll.tslib/refs.tslib/resize.tslib/swap.tsxlib/popup.tslib/glide.tsxcomponents/kino/tooltip.tsxlib/cut.tsxlib/run-progress.tslib/highlight.tslib/flow.tslib/roll.tsxcomponents/kino/avatar.tsxcomponents/kino/separator.tsxlib/menu.tsxcomponents/kino/dropdown-menu.tsxcomponents/kino/breadcrumb.tsxcomponents/kino/spinner.tsxcomponents/kino/button.tsxcomponents/kino/input.tsxcomponents/kino/select.tsxlib/filter-list.tsxlib/panel.tsxcomponents/kino/dialog.tsxcomponents/kino/command.tsxlib/keys.tsxcomponents/kino/kbd.tsxlib/number-format.tscomponents/kino/animated-number.tsxcomponents/kino/badge.tsxcomponents/kino/empty.tsxlib/pill.tscomponents/kino/tabs.tsxlib/announce.tsxlib/controllable.tslib/dates.tslib/grip.tscomponents/kino/sheet.tsxcomponents/kino/drawer.tsxcomponents/kino/popover.tsxlib/roomy.tslib/popover-sheet.tsxlib/settle.tscomponents/kino/notification-center/notification-center.tsxcomponents/kino/notification-center/notification-parts.tsxcomponents/kino/notification-center/notification-bell.tsxcomponents/kino/notification-center/notification-list.tscomponents/kino/collapsible.tsxcomponents/kino/scroll-area.tsxcomponents/kino/sidebar.tsxlib/placeholder.tscomponents/kino/skeleton.tsxlib/menu-sheet.tsxcomponents/kino/preferences.tsxcomponents/kino/segmented-control.tsxcomponents/kino/theme-switcher.tsxcomponents/kino/user-menu.tsxcomponents/kino/app-shell/app-shell.tsx
Packages
@base-ui/reactclass-variance-authority

New to Kino? Installation covers what your project needs first and the @kino namespace.

API reference

AppShell

PropTypeDefaultDescription
variant'inset''flat''top-bar''inset'inset: the page is a card on the sidebar’s tint. flat: the sidebar and the page share one plane, split by a line. top-bar: the header runs across the top, over the sidebar.
sidebarReactNodeNoneThe AppShellSidebar.
headerReactNodeNoneThe AppShellHeader: over the page, or across the top in top-bar.
side'start''end''start'The edge the sidebar docks to, which follows the text direction. The header’s toggle goes to the same side.
collapsible'icon''offcanvas''icon'How the sidebar collapses: to its icons, or out of sight, coming back over the page while the pointer rests on the edge.
openbooleanNoneWhether the sidebar is docked open on a wide screen. With onOpenChange to own it, or defaultOpen.
shortcutstring[]null['Mod', 'B']The keys that collapse the sidebar, or null for none.
landmarksbooleantrueWhether the header and the page are the page’s banner and main. Turn it off inside a page that has its own.
skipLabelstring'Skip to content'The skip link’s words.

AppShellHeader

PropTypeDefaultDescription
actionsReactNodeNoneAt the end: AppShellSearch, the NotificationCenter and, in top-bar, AppShellUser.
PropTypeDefaultDescription
openbooleanNoneWhether the dialog is open. With onOpenChange to own it, so a command that runs can close it, or defaultOpen.
shortcutstring[]null['Mod', 'K']The keys that open it, or null for none.
labelstring'Search'The button’s words, and its name.
titlestring'Search'Names the dialog for a screen reader.
classNamestringNoneFor layout, on the button in either of its looks.

AppShellWorkspaces

PropTypeDefaultDescription
workspacesAppShellWorkspace[]None{ value, name, description?, logo } for each: the logo as tall as a small control.
valuestringNoneThe workspace you are in. With onValueChange to own it, or defaultValue; the first by default.
labelstring'Workspaces'Names the menu and the sheet on a phone, and is read after the workspace’s name on its button.

AppShellUser

PropTypeDefaultDescription
namestringNoneTheir name.
emailstringNoneTheir email, under the name.
avatarReactNodeNoneTheir Avatar, at sm.
labelstring'Account'Names the menu, and the sheet on a phone.

AppShellPageHeader

PropTypeDefaultDescription
titleReactNodeNoneThe page’s title.
descriptionReactNodeNoneA line under the title.
actionsReactNodeNoneButtons for what the page does, the main one last.
heading'h1''h2''h1'The title’s level: the page’s h1, lower inside another page.

Accessibility

  • A skip link is the first tab stop: it shows when focused and takes focus past the header and the sidebar to the page.
  • The header is the page’s banner, the sidebar a navigation landmark named by its aria-label, and the page its main. Each row marks the current page with aria-current.
  • The toggle says what it does, “Collapse sidebar” or “Open sidebar”, with aria-expanded, and names its shortcut. In the rail each row is named by its tooltip.
  • The search button’s keys are read as aria-keyshortcuts, not as its name. ⌘K is left alone while another dialog covers the page.
  • The header stays put as the page scrolls, and what takes focus stops below it. On a phone the sidebar is a sheet that holds focus, and a link inside closes it.