Skip to content
Domphy

Textarea

Styles a multi-line text input with themed border, hover, focus, invalid, and disabled states on the host <textarea> element. Optionally auto-resizes to fit content.

Validation styling. Same contract as inputText: the automatic :invalid outline requires a placeholder that is no longer shown, so a pristine untouched required textarea is not painted as an error. Use data-status="error" / data-status="warning" to drive the state explicitly.

Props

PropTypeDefaultDescription
colorValueOrState<ThemeColor>"neutral"Theme color tone for the border and text.
accentColorValueOrState<ThemeColor>"primary"Theme color tone for the hover/focus outline.
autoResizebooleanfalseWhen true, grows the textarea height to fit its content on input and when value updates, and remeasures when the host becomes visible (IntersectionObserver) and when its box size changes (ResizeObserver).
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 BehaviorInstance,
  behavior,
  type PartialElement,
  toState,
  type ValueOrState,
} from "@domphy/core";
import {
  type ThemeColor,
  themeColor,
  themeDensity,
  themeSize,
  themeSpacing,
} from "@domphy/theme";
import { fieldTextStyle } from "../utils/fieldText.js";
import { focusRing } from "../utils/focusRing.js";

/**
 * Styles a multi-line text input (border, focus/hover/invalid/disabled states)
 * on the host `<textarea>` element, with optional auto-resize to content.
 *
 * @hostTag textarea
 * @param props.color - Theme color for the border and text. Optional, accepts a value or state. Defaults to `"neutral"`.
 * @param props.accentColor - Theme color for hover/focus outline. Optional, accepts a value or state. Defaults to `"primary"`.
 * @param props.autoResize - When true, grows the textarea height to fit its content on input and when `value` updates, and remeasures when the host becomes visible (IntersectionObserver) and when its box size changes (ResizeObserver). Optional. Defaults to `false`.
 * @example { textarea: null, $: [textarea({ autoResize: true })] }
 */
function textarea(
  props: {
    color?: ValueOrState<ThemeColor>;
    accentColor?: ValueOrState<ThemeColor>;
    autoResize?: boolean;
  } = {},
): PartialElement {
  const color = toState(props.color ?? "neutral", "color");
  const accentColor = toState(props.accentColor ?? "primary", "accentColor");
  const { autoResize = false } = props;

  return {
    _onInsert: (node) => {
      if (node.tagName !== "textarea") {
        console.warn(`"textarea" primitive patch must use textarea tag`);
      }
    },
    // Resize on mount, on input, and when the host `value` attribute updates
    // (controlled writes skip the input event).
    ...behavior(
      "textarea-auto-resize",
      (node, initial) => {
        const el = node.domElement as HTMLTextAreaElement;
        let enabled = initial.autoResize;
        let measuring = false;
        let intersectionObserver: IntersectionObserver | undefined;
        let resizeObserver: ResizeObserver | undefined;
        const resize = () => {
          if (!enabled || measuring) return;
          measuring = true;
          // Unobserve during the height write so ResizeObserver cannot
          // re-enter from the measure itself (jsdom may deliver RO sync).
          resizeObserver?.unobserve(el);
          el.style.overflow = "hidden";
          el.style.height = "auto";
          el.style.height = `${el.scrollHeight}px`;
          measuring = false;
          if (enabled) resizeObserver?.observe(el);
        };
        const observe = () => {
          if (typeof IntersectionObserver !== "undefined") {
            if (!intersectionObserver) {
              intersectionObserver = new IntersectionObserver((entries) => {
                if (entries.some((entry) => entry.isIntersecting)) resize();
              });
            }
            intersectionObserver.observe(el);
          }
          if (typeof ResizeObserver !== "undefined") {
            if (!resizeObserver) {
              resizeObserver = new ResizeObserver(() => {
                if (measuring) return;
                resize();
              });
            }
            resizeObserver.observe(el);
          }
        };
        const unobserve = () => {
          intersectionObserver?.unobserve(el);
          resizeObserver?.unobserve(el);
        };
        el.addEventListener("input", resize);
        node.attributes.addListener("value", resize);
        if (enabled) {
          observe();
          resize();
        }
        return {
          resize,
          update(next) {
            enabled = next.autoResize;
            node.attributes.addListener("value", resize);
            if (enabled) {
              observe();
              resize();
            } else {
              unobserve();
            }
          },
          destroy() {
            el.removeEventListener("input", resize);
            intersectionObserver?.disconnect();
            resizeObserver?.disconnect();
          },
        };
      },
      { autoResize },
    ),
    _onUpdate: (node) => {
      node
        .getBehavior<
          BehaviorInstance<{ autoResize: boolean }> & { resize: () => void }
        >("textarea-auto-resize")
        ?.resize();
    },
    style: {
      lineHeight: "inherit",
      resize: "vertical",
      paddingInline: (listener) => themeSpacing(themeDensity(listener) * 2),
      paddingBlock: (listener) => themeSpacing(themeDensity(listener) * 1.5),
      border: "none",
      borderRadius: (listener) => themeSpacing(themeDensity(listener) * 1.5),
      fontSize: (listener) => themeSize(listener, "inherit"),
      ...fieldTextStyle(color),
      outlineOffset: "-1px",
      outline: (listener) =>
        `1px solid ${themeColor(listener, "border-strong", color.get(listener))}`,
      backgroundColor: (listener) =>
        themeColor(listener, "inherit", color.get(listener)),
      transition: "outline-color 140ms ease, box-shadow 140ms ease",
      "&:hover:not([disabled]):not([aria-busy=true])": {
        outline: (listener) =>
          `1px solid ${themeColor(listener, "shift-5", accentColor.get(listener))}`,
      },
      "&:focus-visible": {
        boxShadow: (listener) => focusRing(listener, accentColor.get(listener)),
      },
      // Same gate as inputText: a bare `:invalid` painted a pristine untouched
      // `required` textarea red on first paint. `[placeholder]` +
      // `:not(:placeholder-shown)` means "the user left content behind that is
      // invalid"; a textarea with no placeholder uses `data-status` instead.
      "&[placeholder]:invalid:not(:placeholder-shown)": {
        outline: (listener) =>
          `${themeSpacing(0.5)} solid ${themeColor(listener, "shift-5", "error")}`,
      },
      // Explicit validation state, mirroring inputText's contract.
      "&[data-status=error]": {
        outline: (listener) =>
          `${themeSpacing(0.5)} solid ${themeColor(listener, "shift-6", "error")}`,
      },
      "&[data-status=warning]": {
        outline: (listener) =>
          `${themeSpacing(0.5)} solid ${themeColor(listener, "shift-6", "warning")}`,
      },
      "&[disabled]": {
        opacity: 0.7,
        cursor: "not-allowed",
        color: (listener) => themeColor(listener, "muted", "neutral"),
        outline: (listener) =>
          `1px solid ${themeColor(listener, "border-strong", "neutral")}`,
        backgroundColor: (listener) =>
          themeColor(listener, "shift-2", "neutral"),
      },
    },
  };
}

export { textarea };