Skip to content
Domphy

Card

Use card on a div (any block container). It creates a grid surface with six named regions: img (image), heading elements (title), p (description), aside (aside), div (content), and footer (footer). Children are auto-placed by element type. The surface uses a low elevation shadow plus a strong border; titles use heading-level contrast (shift-11).

Props

PropTypeDefault
colorValueOrState<ThemeColor>"neutral"
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:

  1. Patch props. Each patch exposes a small, stable set of props—typically fewer than five. Lowest friction.
  2. Context attributes. Use dataTone, dataSize, and dataDensity on a container to shift tone, size, or density for an entire subtree without touching individual elements.
  3. Inline override. Native-wins merge strategy: any property set directly on the element overrides the patch value.
  4. 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:

Uw=0w=1w=2w=3
height (n = 1)691215
paddingBlock01.534.5
paddingInline34.564.5
radius01.534.5

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

RoleShiftn=0
Backgroundparent +/- n0
Textbg + K6
Borderbg + K/23
Hoverbg + 2K/34
Selected / Focusabove +/- K/32-4

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

import { type PartialElement, toState, type ValueOrState } from "@domphy/core";
import {
  type ThemeColor,
  themeColor,
  themeDensity,
  themeSpacing,
} from "@domphy/theme";
import { elevation } from "../utils/elevation.js";

/**
 * A grid-based card surface that auto-places known child elements into named
 * regions: `<img>` (image), headings (title), `<p>` (description), `<aside>`
 * (aside), `<div>` (content), and `<footer>` (footer). Typically applied to a
 * `<div>` (any block container).
 *
 * @param props.color - Surface/border color tone. Optional `ValueOrState<ThemeColor>`, default "neutral".
 * @example { div: { h3: "Title", p: "Body" }, $: [card({ color: "neutral" })] }
 */
function card(
  props: { color?: ValueOrState<ThemeColor> } = {},
): PartialElement {
  const color = toState(props.color ?? "neutral", "color");
  return {
    // Title weight is design-system chrome for the card region layout.
    _doctorDisable: "inline-typography",
    style: {
      display: "grid",
      gridTemplateColumns: "1fr auto",
      gridTemplateAreas:
        '"image image" "title aside" "desc aside" "content content" "footer footer"',
      borderRadius: (listener) => themeSpacing(themeDensity(listener) * 2),
      backgroundColor: (listener) =>
        themeColor(listener, "inherit", color.get(listener)),
      color: (listener) =>
        themeColor(listener, "shift-10", color.get(listener)),
      outline: (listener) =>
        `1px solid ${themeColor(listener, "border-strong", color.get(listener))}`,
      outlineOffset: "-1px",
      // Soft lift so cards separate from the page without looking like dialogs.
      boxShadow: elevation("low"),
      overflow: "hidden",
      "& > img": {
        gridArea: "image",
        width: "100%",
        height: "auto",
        display: "block",
      },
      "& > :is(h1,h2,h3,h4,h5,h6)": {
        gridArea: "title",
        paddingBlock: (listener) => themeSpacing(themeDensity(listener) * 2),
        paddingInline: (listener) => themeSpacing(themeDensity(listener) * 4),
        fontWeight: "600",
        color: (listener) =>
          themeColor(listener, "shift-11", color.get(listener)),
        margin: 0,
      },
      "& > p": {
        gridArea: "desc",
        paddingInline: (listener) => themeSpacing(themeDensity(listener) * 4),
        paddingBottom: (listener) => themeSpacing(themeDensity(listener) * 2),
        color: (listener) => themeColor(listener, "text", color.get(listener)),
        margin: 0,
      },
      "& > aside": {
        gridArea: "aside",
        alignSelf: "center",
        padding: (listener) => themeSpacing(themeDensity(listener) * 2),
        height: "auto",
      },
      "& > div": {
        gridArea: "content",
        padding: (listener) => themeSpacing(themeDensity(listener) * 4),
        color: (listener) =>
          themeColor(listener, "shift-10", color.get(listener)),
      },
      "& > footer": {
        gridArea: "footer",
        display: "flex",
        gap: themeSpacing(2),
        paddingBlock: (listener) => themeSpacing(themeDensity(listener) * 2),
        paddingInline: (listener) => themeSpacing(themeDensity(listener) * 4),
        borderTop: (listener) =>
          `1px solid ${themeColor(listener, "border", color.get(listener))}`,
      },
    },
  };
}

export { card };