Ballmac UI home

App Shell

The frame of an application page: skip link, sticky header, sidebar that becomes a sheet on small screens, main area, optional aside and footer.

Skip to content
AcmeQ3 planning

Overview

Header and side panels stay put; the page scrolls in the middle.

Open tasks

24

Shipped this week

9

Blocked

2

Due soon

6

Acme workspace · all systems normal

Installation

$ pnpm dlx shadcn@latest add @ballmac/app-shell

Usage

import { AppShell, AppShellSkipLink, AppShellHeader, AppShellSidebarTrigger, AppShellSidebar, AppShellMain, AppShellAside, AppShellFooter, useAppShell } from "@/components/ballmac/app-shell"

The full example is in the Code tab above.

Examples

Compact shell

Compact shell

Narrower header and sidebar through props. Below the lg breakpoint the sidebar opens from the menu button.

Footer

API reference

<AppShell>

PropTypeDefault
headerHeight

Height of the header, used to offset sticky side panels. Any CSS length.

string"3.5rem"
sidebarWidth

Width of the sidebar column from the `lg` breakpoint up.

string"15rem"
asideWidth

Width of the aside column from the `xl` breakpoint up.

string"18rem"

<AppShellSidebar>

PropTypeDefault
label

Accessible name of the landmark and the mobile sheet.

string—

<AppShellAside>

PropTypeDefault
labelstring—

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
TabThe first stop is the skip link; it jumps to the main content
Screen readersHeader, sidebar, main, aside and footer are landmarks
EscapeCloses the mobile sidebar

Quality scorecard

7/7

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

How we measure
  • Passed: Accessibility scan

    No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).

  • Passed: Small screens

    No sideways scrolling at 360, 390 or 1280 px wide.

  • Passed: Reduced motion

    No endless animation to begin with.

  • Passed: Right to left

    Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Passed: Keyboard

    9 tab stops, each showing a visible change when it takes focus. 3 documented keys.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • Passed: Automated tests

    Covered by app-shell.test.tsx.

  • For information: Footprint

    2.2 KB of source (gzip) in 1 file. Installs lucide-react.

Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.

Use with AI

AppShell > AppShellSkipLink, AppShellHeader (with AppShellSidebarTrigger), AppShellSidebar, AppShellMain, AppShellAside, AppShellFooter. Sizes are CSS variables set by props. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI App Shell (@ballmac/app-shell) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Admin and dashboard pages
  • Any page with a sidebar, a main column and optional details

Not for

  • A collapsible icon-rail sidebar; use sidebar
  • Marketing pages; use navbar

Registry JSON: https://ui.ballmac.com/r/app-shell.json

Credits

Free to use in personal and commercial projects.

Ballmac UI Pro

Need the whole screen, not one piece?

311 premium blocks (dashboards, settings, calendars, mail, shops, onboarding), a private shadcn registry and Figma tokens. Blocks that show data come with loading, empty and error states built in.

Not ready? Try three Pro blocks free

Leave your email and the blocks appear right here, ready to copy. Yours to use in any project.