sigilUI

Box

Apply token-based spacing and surfaces to a layout container.

@sigil-ui/componentsReact

Preview

Live preview Interactive

Import

import { Box } from "@sigil-ui/components";

Usage

<Box bg="surface" radius="md" p="var(--s-grid-cell)" borderColor="border">
    <div className="font-[family-name:var(--s-font-mono)] text-sm text-[var(--s-text)]">
      Token-backed container
    </div>
  </Box>

Box is a low-level escape hatch for semantic HTML and token-backed surfaces. Prefer higher-level Sigil layout primitives for pages:

<SigilPage rhythm="locked" chrome="rails">
  <SigilSection space="normal">...</SigilSection>
</SigilPage>

Use Box when you need an element polymorphic container (as="aside", as="article") but still want to reference Sigil tokens.

Props

PropTypeDefaultDescription
asElementType——
bgstring—Token name like surface or full CSS value
borderColorstring—Token name like border or full CSS value
radiusstring—Radius key like md, or full CSS value
shadowstring—Shadow key like sm, or full CSS value
pnumber | string——
pxnumber | string——
pynumber | string——
mnumber | string——
mxnumber | string——
mynumber | string——

Token integration

CSS VariablePurpose
--s-radius-Radius
--s-shadow-Shadow
--s-surfaceSurface background
--s-borderBorder color