Figure

Use figure on a figure element. It arranges media (img, svg, video, canvas) and a figcaption in a column layout. Media elements are made block-level with max-width: 100% and a border radius. The caption uses a smaller font size. The color prop controls the figure and caption text tone.

Props

Prop	Type	Default	Description
`color`	`ValueOrState<ThemeColor>`	`"neutral"`	Theme color tone for the figure and caption text.

Customization

Must see the source of patch at the bottom of each patch page to understand the structure then code it still code as html native element.

There are four levels of customization, in increasing order of effort:

Patch props. Each patch exposes a small, stable set of props—typically fewer than five. Lowest friction.
Context attributes. Use dataTone, dataSize, and dataDensity on a container to shift tone, size, or density for an entire subtree without touching individual elements.
Inline override. Native-wins merge strategy: any property set directly on the element overrides the patch value.
Create a variant. Clone a similar patch and edit it. Use this only when you need a reusable custom version.

Formulas

Unit - U = fontSize / 4 - convert final values with themeSpacing(n).

Size - n = intrinsic text lines, w = wrapping level, d = density factor:

height        = (n * 6 + 2 * d * w) * U
paddingBlock  = d * w * U
paddingInline = ceil(3 / w) * d * w * U
radius        = d * w * U

Base density d = 1.5:

U	w=0	w=1	w=2	w=3
height (`n = 1`)	6	9	12	15
paddingBlock	0	1.5	3	4.5
paddingInline	3	4.5	6	4.5
radius	0	1.5	3	4.5

Tone - K = N / 2 where N is the palette length. For N = 18, K = 9.

Role	Shift	n=0
Background	parent +/- n	0
Text	bg + K	6
Border	bg + K/2	3
Hover	bg + 2K/3	4
Selected / Focus	above +/- K/3	2-4

State shift range: K/3 <= delta <= 2K/3.

figure

import { type PartialElement, toState, type ValueOrState } from "@domphy/core";
import {
  type ThemeColor,
  themeColor,
  themeSize,
  themeSpacing,
} from "@domphy/theme";

/**
 * Lays out a figure as a column with block-level media (img/svg/video/canvas)
 * and a themed `<figcaption>`. Apply to a `<figure>` element.
 *
 * @hostTag figure
 * @param props.color - Theme color tone (`ValueOrState<ThemeColor>`) for the figure/caption text. Defaults to "neutral".
 * @example { figure: [{ img: "", src }, { figcaption: "A caption" }], $: [figure()] }
 */
function figure(
  props: { color?: ValueOrState<ThemeColor> } = {},
): PartialElement {
  const color = toState(props.color ?? "neutral", "color");

  return {
    _onInsert: (node) => {
      if (node.tagName !== "figure") {
        console.warn(`"figure" primitive patch must use figure tag`);
      }
    },
    style: {
      display: "flex",
      flexDirection: "column",
      gap: themeSpacing(2),
      marginInline: 0,
      marginTop: themeSpacing(3),
      marginBottom: themeSpacing(3),
      color: (listener) => themeColor(listener, "text", color.get(listener)),
      "& img, & svg, & video, & canvas": {
        display: "block",
        maxWidth: "100%",
        borderRadius: themeSpacing(2),
      },
      "& figcaption": {
        fontSize: (listener) => themeSize(listener, "decrease-1"),
        color: (listener) => themeColor(listener, "muted", color.get(listener)),
        lineHeight: 1.45,
      },
    },
  };
}

export { figure };

Figure#

Props#

Figure

Props