Skip to the content

Layout

container

Centres content at the page width with the page gutter on both sides. Four sizes: narrow, page, wide, full.

When to use it

Around the content of every page band so edges line up down the page. "narrow" for reading text, "wide" for galleries and dashboards, "full" to keep only the gutter. Section already wraps its children in one.

Add it

npx shadcn@latest add @rivier-ui/container

The registry is named once in components.json: see Installation.

Example

Import it from @/components/layout/container.

<Container>
  <h1>Pricing</h1>
</Container>
<Container size="narrow" asChild>
  <article>Long-form text…</article>
</Container>

What it needs

Plain markup: it can stay a server component. Packages: class-variance-authority, radix-ui.

It imports

It is used by

Source

The whole file. Once copied it is yours: the registry item holds the same text.

src/components/layout/container.tsx
/**
 * @name container
 * @category layout
 * @description Centres content at the page width with the page gutter on both sides. Four sizes: narrow, page, wide, full.
 * @when Around the content of every page band so edges line up down the page. "narrow" for reading text, "wide" for galleries and dashboards, "full" to keep only the gutter. Section already wraps its children in one.
 * @example
 * <Container>
 *   <h1>Pricing</h1>
 * </Container>
 * <Container size="narrow" asChild>
 *   <article>Long-form text…</article>
 * </Container>
 */
import { Slot } from "radix-ui";
import { cva, type VariantProps } from "class-variance-authority";
import type { ComponentProps } from "react";
import { cn } from "@/lib/cn";

export const containerVariants = cva("mx-auto w-full px-(--gutter)", {
  variants: {
    size: {
      narrow: "max-w-3xl",
      page: "max-w-page",
      wide: "max-w-[96rem]",
      full: "max-w-none",
    },
  },
  defaultVariants: { size: "page" },
});

export type ContainerProps = ComponentProps<"div"> &
  VariantProps<typeof containerVariants> & {
    /** Render the child element (main, article, header) with the container's width and gutter. */
    asChild?: boolean;
  };

export function Container({ className, size, asChild = false, ...props }: ContainerProps) {
  const Comp = asChild ? Slot.Root : "div";
  return <Comp data-slot="container" className={cn(containerVariants({ size }), className)} {...props} />;
}