Skip to main content

Layout

PageShell

The page column of a site: centred content with a side gutter that grows with the screen, and a wider column on big screens. Sizes are in rem, so the larger root text size that ouro-base sets on big screens widens the column with it, and a huge display is not a thin strip of text in a sea of margin.

Work
Notes

Install

Hand it to your agent
Add PageShell from Ouro UI to this app. Read https://ui.ouroboros.bot/docs/page-shell.md first and follow it.

Or by hand. Once per app, with Tailwind CSS v4 and an @/* path alias (Ouro HX is built on Base UI, so --base base; skip -t in an existing app):

npx shadcn@latest init --base base --preset nova --yes --no-monorepo
npx shadcn@latest add ourostack/ouro-ui/ouro-base#v1.3.344

Then the component. From v0.8.0 it installs only the helpers it imports and never touches your stylesheet (Installing):

npx shadcn@latest add ourostack/ouro-ui/page-shell#v1.3.344

Or, with the @ouro namespace set up:

npx shadcn@latest add @ouro/ouro-base @ouro/page-shell

Its tests, stories and Playwright spec are optional. They need Vitest 4.1.11 or later, and from v0.8.0 never change a version your app has (Testing):

npx shadcn@latest add ourostack/ouro-ui/page-shell#v1.3.344 ourostack/ouro-ui/page-shell-tests#v1.3.344
import { PageShell } from "@/components/ouro/page-shell/page-shell";

Paths use shadcn's default @/ alias; the CLI rewrites them to yours.

Example

<PageShell>
  <PageSection>
    <h2>Work</h2>
  </PageSection>
</PageShell>

Use instead when

  • Use PageSection inside it for the vertical rhythm between a page's sections, and Stack instead for spacing inside a column.

Props

Type: PageShellProps.

className
Type: string
Layout only: margins, grid placement. Appearance classes warn in development.
ref
Type: Ref<HTMLDivElement>
Reaches the rendered element.

Native attributes

Also accepts the attributes in React's HTMLAttributes (id, aria-*, event handlers), passed to the rendered element, except those named on this page.

className is for layout only

Pass margins, width and grid placement (mt-4, w-full, col-span-2). Your classes always win over Ouro UI's: PageShell merges className last with cn (tailwind-merge), so a class that conflicts with its own replaces it.layout-classes

Appearance comes from props, not classes. In development, a class that sets appearance logs one warning per component instance, naming the prop to use instead. A class sets appearance when, after its variants (hover:, sm:) and any ! are removed, it starts with bg-, text-, border-, rounded-, shadow-, font-, ring-, from-, via-, to-, fill- or stroke-, or is border, rounded, shadow or ring, or has a dark: variant. Text wrapping, overflow and table layout classes (text-wrap, text-ellipsis, border-collapse) are layout and do not warn.

Alignment classes (text-center) warn too: set alignment on a parent element.

Claim sources