Label

Apply the label patch to a <label> element to get themed text color, inline-flex layout with gap, focus-within highlighting, and a disabled state. Must be used on a <label> element.

Props

Prop	Type	Default	Description
`color`	`ValueOrState<ThemeColor>`	`"neutral"`	Base color tone for the label text.
`accentColor`	`ValueOrState<ThemeColor>`	`"primary"`	Accent color tone applied on focus-within.

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.

label

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

/**
 * Themed form-label primitive: inline-flex layout with gap, themed text color,
 * focus-within highlighting and a disabled (`aria-disabled`) state. Apply to a
 * `<label>` element.
 *
 * @hostTag label
 * @param props - Optional configuration.
 * @param props.color - Base color tone for the label text. Defaults to `"neutral"`.
 * @param props.accentColor - Accent color tone applied on focus-within. Defaults to `"primary"`.
 * @example { label: "Email", htmlFor: "email", $: [label()] }
 */
function label(
  props: {
    color?: ValueOrState<ThemeColor>;
    accentColor?: ValueOrState<ThemeColor>;
  } = {},
): PartialElement {
  const color = toState(props.color ?? "neutral", "color");
  const accentColor = toState(props.accentColor ?? "primary", "accentColor");

  return {
    _onInsert: (node) => {
      if (node.tagName !== "label") {
        console.warn(`"label" primitive patch must use label tag`);
      }
    },
    style: {
      display: "inline-flex",
      alignItems: "center",
      gap: themeSpacing(2),
      fontSize: (listener) => themeSize(listener, "inherit"),
      color: (listener) => themeColor(listener, "text", color.get(listener)),
      cursor: "pointer",
      "&:focus-within": {
        color: (listener) =>
          themeColor(listener, "shift-10", accentColor.get(listener)),
      },
      "&[aria-disabled=true]": {
        opacity: 0.7,
        cursor: "not-allowed",
        color: (listener) => themeColor(listener, "muted", "neutral"),
      },
    },
  };
}

export { label };

Label#

Props#

Label

Props