App Shell

Open + Pro variants

Full application shells — collapsible sidebars, org switchers, command search, breadcrumb headers and an inset content area.

4 of 14

resources/views/pages/app-shell-inset.blade.php Blade

@props([
    'title' => 'Workspace',
    'org' => 'Atlas Studio',
    'plan' => 'Team plan',
    'user' => null,
    'nav' => null,
])

@php
    $user ??= ['name' => 'Riley Chen', 'email' => 'riley@atlas.studio', 'initials' => 'RC'];

    $nav ??= [
        [
            'heading' => 'Studio',
            'items' => [
                ['label' => 'Workspace', 'icon' => 'grid', 'href' => '#', 'current' => true],
                ['label' => 'Assets', 'icon' => 'image', 'href' => '#'],
                ['label' => 'Collections', 'icon' => 'folder', 'href' => '#', 'badge' => '4'],
            ],
        ],
        [
            'heading' => 'Insights',
            'items' => [
                ['label' => 'Analytics', 'icon' => 'chart', 'href' => '#'],
                ['label' => 'Audience', 'icon' => 'users', 'href' => '#'],
                ['label' => 'Settings', 'icon' => 'settings', 'href' => '#'],
            ],
        ],
    ];

    // Trusted, developer-authored icon paths rendered inside menu buttons (escaped
    // output would mangle the SVG markup). Never feed user input through this map.
    $icons = [
        'grid' => '<rect width="7" height="7" x="3" y="3" rx="1"/><rect width="7" height="7" x="14" y="3" rx="1"/><rect width="7" height="7" x="14" y="14" rx="1"/><rect width="7" height="7" x="3" y="14" rx="1"/>',
        'image' => '<rect width="18" height="18" x="3" y="3" rx="2" ry="2"/><circle cx="9" cy="9" r="2"/><path d="m21 15-3.086-3.086a2 2 0 0 0-2.828 0L6 21"/>',
        'folder' => '<path d="M20 20a2 2 0 0 0 2-2V8a2 2 0 0 0-2-2h-7.9a2 2 0 0 1-1.69-.9L9.6 3.9A2 2 0 0 0 7.93 3H4a2 2 0 0 0-2 2v13a2 2 0 0 0 2 2Z"/>',
        'chart' => '<path d="M3 3v16a2 2 0 0 0 2 2h16"/><path d="M18 17V9"/><path d="M13 17V5"/><path d="M8 17v-3"/>',
        'users' => '<path d="M16 21v-2a4 4 0 0 0-4-4H6a4 4 0 0 0-4 4v2"/><circle cx="9" cy="7" r="4"/><path d="M22 21v-2a4 4 0 0 0-3-3.87"/><path d="M16 3.13a4 4 0 0 1 0 7.75"/>',
        'settings' => '<path d="M12.22 2h-.44a2 2 0 0 0-2 2v.18a2 2 0 0 1-1 1.73l-.43.25a2 2 0 0 1-2 0l-.15-.08a2 2 0 0 0-2.73.73l-.22.38a2 2 0 0 0 .73 2.73l.15.1a2 2 0 0 1 1 1.72v.51a2 2 0 0 1-1 1.74l-.15.09a2 2 0 0 0-.73 2.73l.22.38a2 2 0 0 0 2.73.73l.15-.08a2 2 0 0 1 2 0l.43.25a2 2 0 0 1 1 1.73V20a2 2 0 0 0 2 2h.44a2 2 0 0 0 2-2v-.18a2 2 0 0 1 1-1.73l.43-.25a2 2 0 0 1 2 0l.15.08a2 2 0 0 0 2.73-.73l.22-.39a2 2 0 0 0-.73-2.73l-.15-.08a2 2 0 0 1-1-1.74v-.5a2 2 0 0 1 1-1.74l.15-.09a2 2 0 0 0 .73-2.73l-.22-.38a2 2 0 0 0-2.73-.73l-.15.08a2 2 0 0 1-2 0l-.43-.25a2 2 0 0 1-1-1.73V4a2 2 0 0 0-2-2z"/><circle cx="12" cy="12" r="3"/>',
    ];

    // Same groups as $nav, with each item's icon key resolved to raw SVG shape
    // markup, so the mobile sidebar part can render icons without knowing this
    // page's icon map.
    $mobileNav = collect($nav)->map(fn ($group) => [
        'heading' => $group['heading'],
        'items' => collect($group['items'])->map(fn ($item) => [
            ...$item,
            'icon' => $icons[$item['icon']] ?? null,
        ])->all(),
    ])->all();
@endphp

<section data-surface="admin" {{ $attributes->merge(['class' => 'h-svh bg-muted/40 text-foreground']) }}>
    <x-ui.skip-link />
    <div class="flex h-svh w-full overflow-hidden">
        {{-- Sidebar with collapsible icon rail + user menu in the footer. --}}
        <x-ui.sidebar class="border-e-0 bg-transparent max-md:hidden">
            <x-ui.sidebar.header x-bind:class="expanded ? 'justify-between' : 'justify-center'">
                <a href="#" x-show="expanded" class="flex min-w-0 items-center gap-2">
                    <span class="flex size-8 shrink-0 items-center justify-center rounded-md bg-primary text-sm font-semibold text-primary-foreground" aria-hidden="true">A</span>
                    <span class="flex min-w-0 flex-col items-start">
                        <span class="truncate text-sm font-semibold leading-tight">{{ __($org) }}</span>
                        <span class="truncate text-xs text-muted-foreground">{{ __($plan) }}</span>
                    </span>
                </a>
                <x-ui.sidebar.trigger class="shrink-0" />
            </x-ui.sidebar.header>

            <x-ui.sidebar.content>
                @foreach ($nav as $group)
                    <x-ui.sidebar.group>
                        <x-ui.sidebar.group-label>{{ __($group['heading']) }}</x-ui.sidebar.group-label>
                        <x-ui.sidebar.menu>
                            @foreach ($group['items'] as $item)
                                <x-ui.sidebar.menu-item>
                                    <x-ui.sidebar.menu-button :href="$item['href']" :active="$item['current'] ?? false" x-bind:class="expanded || 'justify-center'" :title="__($item['label'])">
                                        <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">{!! $icons[$item['icon']] ?? '' !!}</svg>
                                        <span x-show="expanded" class="truncate">{{ __($item['label']) }}</span>
                                        @isset($item['badge'])
                                            <x-ui.badge variant="secondary" x-show="expanded" class="ms-auto">{{ $item['badge'] }}</x-ui.badge>
                                        @endisset
                                    </x-ui.sidebar.menu-button>
                                </x-ui.sidebar.menu-item>
                            @endforeach
                        </x-ui.sidebar.menu>
                    </x-ui.sidebar.group>
                @endforeach
            </x-ui.sidebar.content>

            <x-ui.sidebar.footer>
                <x-ui.sidebar.separator />
                {{-- User menu via dropdown. --}}
                <x-ui.dropdown>
                    <x-ui.dropdown.trigger class="w-full gap-2 rounded-md p-2 hover:bg-muted" x-bind:class="expanded || 'justify-center'">
                        <x-ui.avatar size="sm" :fallback="$user['initials']" :alt="$user['name']" />
                        <span x-show="expanded" class="flex min-w-0 flex-col items-start">
                            <span class="truncate text-sm font-medium leading-tight">{{ $user['name'] }}</span>
                            <span class="truncate text-xs text-muted-foreground">{{ $user['email'] }}</span>
                        </span>
                        <svg x-show="expanded" class="ms-auto size-4 shrink-0 text-muted-foreground" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="m7 15 5 5 5-5"/><path d="m7 9 5-5 5 5"/></svg>
                    </x-ui.dropdown.trigger>
                    <x-ui.dropdown.content align="end" class="w-56">
                        <x-ui.dropdown.label>{{ $user['name'] }}</x-ui.dropdown.label>
                        <x-ui.dropdown.separator />
                        <x-ui.dropdown.item href="#">{{ __('Profile') }}</x-ui.dropdown.item>
                        <x-ui.dropdown.item href="#">{{ __('Billing') }}</x-ui.dropdown.item>
                        <x-ui.dropdown.item href="#">{{ __('Settings') }}</x-ui.dropdown.item>
                        <x-ui.dropdown.separator />
                        <x-ui.dropdown.item href="#">{{ __('Sign out') }}</x-ui.dropdown.item>
                    </x-ui.dropdown.content>
                </x-ui.dropdown>
            </x-ui.sidebar.footer>
        </x-ui.sidebar>

        {{-- Inset: the main column sits in a rounded, padded, bordered panel with a margin. --}}
        <div class="flex min-w-0 flex-1 flex-col p-2 sm:ps-0">
            <main id="main-content" class="flex min-h-0 flex-1 flex-col overflow-hidden rounded-lg border border-border bg-background shadow-sm">
                {{-- Mobile navigation: the desktop sidebar is hidden below `md`, so a hamburger opens the full nav in a start-side sheet. --}}
                <x-ui.sidebar.mobile :nav="$mobileNav" :label="$org" id="app-shell-04-mobile-nav" />

                <header class="flex h-16 shrink-0 items-center gap-4 border-b border-border px-4 sm:px-6">
                    <x-ui.breadcrumb class="min-w-0 flex-1">
                        <x-ui.breadcrumb.list>
                            <x-ui.breadcrumb.item class="max-sm:hidden">
                                <x-ui.breadcrumb.link href="#">{{ __($org) }}</x-ui.breadcrumb.link>
                            </x-ui.breadcrumb.item>
                            <x-ui.breadcrumb.separator class="max-sm:hidden" />
                            <x-ui.breadcrumb.item>
                                <x-ui.breadcrumb.page>{{ __($title) }}</x-ui.breadcrumb.page>
                            </x-ui.breadcrumb.item>
                        </x-ui.breadcrumb.list>
                    </x-ui.breadcrumb>

                    <x-ui.button variant="outline" size="sm" class="whitespace-nowrap shrink-0">{{ __('Invite') }}</x-ui.button>
                    <x-ui.button size="sm" class="whitespace-nowrap shrink-0">{{ __('New asset') }}</x-ui.button>

                    <x-ui.dropdown>
                        <x-ui.dropdown.trigger :aria-label="__('Account menu')" class="shrink-0 rounded-full focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 focus-visible:ring-offset-background">
                            <x-ui.avatar size="sm" :fallback="$user['initials']" :alt="$user['name']" />
                        </x-ui.dropdown.trigger>
                        <x-ui.dropdown.content align="end" class="w-56">
                            <x-ui.dropdown.label>{{ $user['name'] }}</x-ui.dropdown.label>
                            <x-ui.dropdown.separator />
                            <x-ui.dropdown.item href="#">{{ __('Profile') }}</x-ui.dropdown.item>
                            <x-ui.dropdown.item href="#">{{ __('Sign out') }}</x-ui.dropdown.item>
                        </x-ui.dropdown.content>
                    </x-ui.dropdown>
                </header>

                {{-- Padded inset content. --}}
                <div data-slot="app-shell-content" class="flex-1 overflow-auto p-4 sm:p-6 lg:p-8">
                    @if (trim($slot) !== '')
                        {{ $slot }}
                    @else
                        <div class="flex flex-col gap-6">
                            <div>
                                <h1 class="text-2xl font-bold tracking-tight">{{ __($title) }}</h1>
                                <p class="mt-2 text-sm text-muted-foreground">{{ __('Your content lives inside a clean, padded inset panel.') }}</p>
                            </div>

                            <div class="grid gap-4 sm:grid-cols-2 lg:grid-cols-3">
                                @foreach ([
                                    ['label' => 'Assets', 'value' => '1,248', 'tone' => 'default'],
                                    ['label' => 'Collections', 'value' => '36', 'tone' => 'secondary'],
                                    ['label' => 'Published', 'value' => '892', 'tone' => 'success'],
                                ] as $card)
                                    <x-ui.card>
                                        <x-ui.card.header>
                                            <div class="flex items-center justify-between">
                                                <x-ui.card.title class="text-sm font-medium text-muted-foreground">{{ __($card['label']) }}</x-ui.card.title>
                                                <x-ui.badge :variant="$card['tone']">{{ __('Live') }}</x-ui.badge>
                                            </div>
                                            <x-ui.card.description class="text-2xl font-bold text-foreground tabular-nums">{{ $card['value'] }}</x-ui.card.description>
                                        </x-ui.card.header>
                                    </x-ui.card>
                                @endforeach
                            </div>

                            <x-ui.card>
                                <x-ui.card.header>
                                    <x-ui.card.title>{{ __('Content area') }}</x-ui.card.title>
                                    <x-ui.card.description>{{ __('The inset panel keeps your views framed and focused.') }}</x-ui.card.description>
                                </x-ui.card.header>
                                <x-ui.card.content>
                                    <div class="flex min-h-64 items-center justify-center rounded-lg border border-dashed border-border bg-muted/30 text-sm text-muted-foreground">
                                        {{ __('Your page content goes here') }}
                                    </div>
                                </x-ui.card.content>
                            </x-ui.card>
                        </div>
                    @endif
                </div>
            </main>
        </div>
    </div>
</section>

Installation

terminal

php artisan ui:add pages/app-shell-inset

Installs these dependencies automatically:

sidebar sheet breadcrumb button avatar badge dropdown card skip-link

Registry contract

Install confidence

php artisan ui:add pages/app-shell-inset writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version: 1.2.3
License: open
Stability: stable
Contract: v1
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/pages/app-shell-inset.blade.php

Registry dependencies

sidebar sheet breadcrumb button avatar badge dropdown card skip-link

Package dependencies

composer: jml/brok:^0.2

Use with AI

A brief for your coding agent: what the page is, the install command, how to render it, its props and the rules. Copy it, or open a prompt about this page in an assistant.

app-shell-inset.md

# Brok UI page: App Shell 04 (`app-shell-inset`)

Inset sidebar layout with collapsible navigation, a user menu, and a padded main shell.

Brok UI is a Laravel Blade registry. `ui:add` copies this page into the app as plain Blade the app owns; it composes installed `<brok:*>` primitives and semantic design tokens.

## Install

```bash
php artisan ui:add pages/app-shell-inset
```

## Render it

```blade
<x-pages.app-shell-inset />
```

## Props

- `title` (string, default `Workspace`) — Section heading.
- `org` (string, default `Atlas Studio`) — Organisation name shown in the sidebar header.
- `plan` (string, default `Team plan`) — Plan label shown under the organisation name.
- `user` (mixed|null, default `null`) — Signed-in user shown in the sidebar footer menu ({name, email, initials}); null falls back to sample data.
- `nav` (mixed|null, default `null`) — Grouped sidebar navigation sections; null falls back to sample data.

## Use when

- An app shell with an inset sidebar, collapsible navigation and a user menu in the sidebar footer.
- It composes sidebar, sheet, breadcrumb, avatar and dropdown primitives as the wrapper around admin screens that want an icon-rail-style collapsible sidebar.

## Avoid when

- Needing a full-width sidebar with a breadcrumb navbar instead of an inset one; use app-shell-full-viewport or app-shell-scrollable instead.

## Rules

- Render the installed page with `<x-pages.app-shell-inset />` and pass data through its props; edit the copied file only for structural changes.
- Keep the semantic design tokens (`bg-background`, `text-muted-foreground`); never swap in raw colour utilities.
- Keep the `data-slot` attributes and the logical (start/end) spacing so the markup still mirrors under `dir="rtl"`.

## Links

- Docs: https://brokui.dev/pages/app-shell-inset
- Registry JSON (files, props, contract): https://brokui.dev/r/open/pages/app-shell-inset.json

Ask about App Shell 04 in

Working in Claude Code, Cursor or Codex? Give the agent the whole registry through the MCP server or the Brok UI skill.

Guidance

Use when

An app shell with an inset sidebar, collapsible navigation and a user menu in the sidebar footer.
It composes sidebar, sheet, breadcrumb, avatar and dropdown primitives as the wrapper around admin screens that want an icon-rail-style collapsible sidebar.

Avoid when

Needing a full-width sidebar with a breadcrumb navbar instead of an inset one; use app-shell-full-viewport or app-shell-scrollable instead.

Anti-patterns

Do not replace semantic props with conflicting utility classes.
Do not remove labels, focus styles, or state attributes.

Anatomy: root app-shell-content

Usage

Render the page as a component, or wire it to a route. Pass data where useful:

resources/views/welcome.blade.php Blade

<x-pages.app-shell-inset />

Built from blocks & primitives

This page composes installed <brok:*> primitives and semantic design tokens only — it does not reimplement any primitive. Re-theme it (light, dark, admin, customer) by editing CSS variables; flip the preview to RTL to confirm it mirrors.

Source

The exact, editable file ui:add writes into your app. The preview above renders this same source — there are no preview-only pages.