filipebraida/adonisjs-starter-kit/layout-shells

Layout shells

Every page imports the shell it needs; there is no runtime chooser. Variant / collapsible / direction / max-width are hardcoded inside the shell file — not props, not user-facing settings. If a project spun from this template doesn't need one of the shells (e.g. no marketing area), the shell file is deleted, not "disabled by config". The philosophy is starting clean over configuring at runtime — configurability adds branches that need to be tested, translated, permissioned; deletion doesn't.

Rules

• Every page imports its shell explicitly at the top of the page file. No wrapper picks the shell based on route, role, or props.

``tsx import AppLayout from '#common/ui/components/app_layout' export default function Page() { return <AppLayout>...</AppLayout> } ``

• Shell decisions are hardcoded: variant, collapsible, direction, max-width live inside the shell file. Do not accept them as props.
• Header widgets are shared across shells that need them (<NotificationBell />, <ToggleTheme />, <LanguageSwitcher />, <NavUser />) — same visual identity, imported directly by each shell that mounts them.
• Nav configs live in a single file and are exposed as functions (getMainNav(t), getFooterNav(t), getNavUser(t), getMobileFab(t)). Nav items support a can: 'permissionKey' field for RBAC gating — see [[authorization]]. Nav items are never hardcoded inside the shell file.
• Providers stay at the root client entry, not inside shells. Theme, i18n, Tuyau, modal stack are mounted once so every shell renders inside them.
• Adding a shell is only worth it when the shape is genuinely new (installer wizard chrome, kiosk, checkout). Otherwise reuse an existing shell — the same page can render inside two different shells if two contexts need it.

Shell inventory (typical set)

Every app spun from this template starts with two:

• `AppLayout` — the logged-in shell. Sidebar on desktop, bottom nav + top notification bar on mobile. Wraps every internal page (dashboard, users, settings, feature modules).
• `AuthLayout` — the pre-login shell (sign-in, sign-up, password flows). Simpler, no nav.

Public marketing pages typically do not use a shell — they compose their own sections (<Hero>, <Features>, <Footer>) directly, because their chrome has nothing in common with the app.

Any additional shell (checkout, kiosk, print-friendly) is added only when its chrome is truly distinct.

Repo refs

• The four shells: app/common/ui/components/admin_layout.tsx, app/common/ui/components/authenticated_layout.tsx, app/auth/ui/components/auth_layout.tsx, app/marketing/ui/components/marketing_layout.tsx.
• Nav config (single file): app/common/ui/config/navigation.config.ts.

Doc refs

• shadcn/ui Sidebar block (typical upstream of the sidebar primitive) — https://ui.shadcn.com/blocks#sidebar

Workflow

Pick the shell for a new page

• Login / sign-up / password reset → AuthLayout.
• Any other logged-in page → AppLayout.
• Public marketing page (landing, about, blog) → no shell; compose sections directly.
• Any other context (checkout, installer, kiosk) → add a new shell only if its chrome shares nothing with the existing ones.

Add a nav item

Edit the navigation config file — getMainNav(t) for the primary nav, getFooterNav(t) for footer/utility items, getNavUser(t) for the user dropdown (shared across logged-in shells). Set can: 'permissionKey' to gate visibility. Do not put the item inside the shell file.

Delete an unused shell in a downstream project

For a project that doesn't need one of the shells:

1. Delete the shell file.
2. Delete any pages that used it.
3. Delete the nav config section that fed it (a section that only its shell reads).

Nothing else references the shells — no runtime config, no feature flag.

Add a new shell (rare)

Only when the shape is genuinely new. Copy the closest existing shell, hardcode the new decisions (variant / direction / max-width), keep the same widget row in the header (bell + theme + lang + user) if the shell is authenticated.

Anti-patterns

• ❌ Adding variant / collapsible / direction as props on a shell — hardcode them; if the project needs a different shape, add a different shell.
• ❌ Wrapping a shell in a context provider to switch behavior at runtime.
• ❌ Configuring shells via user preferences (theme + language are user prefs; layout choice is not).
• ❌ Nesting one shell inside another.
• ❌ A wrapper component that picks a shell based on the route or role — the page picks. Explicit beats magic.
• ❌ Hardcoding nav items inside the shell file — always go through the nav config functions.
• ❌ Adding page-only providers inside a shell — providers belong at the root client entry so every page and every shell sees them.

Related skills

[[inertia]] · [[authorization]] · [[i18n]] · [[notifications]]