sigilUI

Sigil Frame

A structural-visibility frame that displays the underlying token grid — cross marks, rail lines, and measurement labels — around its children.

@sigil-ui/componentsReact

Preview

Live preview Interactive

Import

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

Usage

SigilFrame wraps content in the structural-visibility system — showing cross marks at corners, rail lines along edges, and optional measurement labels. This is the signature visual language of the Sigil design system.

<SigilFrame>
  <Card>
    <CardHeader>
      <CardTitle>Token-driven</CardTitle>
    </CardHeader>
  </Card>
</SigilFrame>

With labels

<SigilFrame label="fig.01" caption="Component preview">
  <Button variant="primary">Primary action</Button>
</SigilFrame>

Token integration

CSS VariableUsed for
--s-cross-armCross mark arm length
--s-cross-strokeCross mark stroke width
--s-borderRail line color
--s-border-mutedGrid line color
--s-text-mutedLabel text color
--s-font-monoLabel font family

Props

PropTypeDefaultDescription
labelstring—Figure label (e.g. "fig.01")
captionstring—Caption text below the frame
showCrossbooleantrueShow cross marks at corners
showRailsbooleantrueShow rail lines along edges
classNamestring—Additional CSS classes
childrenReactNode—Content to frame