Skip to content
Domphy

Table

Styles a data table (header/body/footer cells, caption, row hover, borders) on the host <table> element.

Props

PropTypeDefaultDescription
colorValueOrState<ThemeColor>"neutral"Theme color applied across cells and text.

Wide tables

table() styles the <table> element and nothing around it — it never makes the table a scroll container, so a table wider than its column overflows the page. Wrap it instead, and give the wrapper a name so keyboard users can scroll it:

{
  div: [{ table: rows, $: [table()] }],
  $: [scrollArea({ label: "Quarterly revenue" })],
}

Put role="region" on that wrapper, never on the <table>: a role on the table replaces its implicit table role and strips the row/column semantics screen readers announce. See scrollArea.

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,
  textToneOn,
  themeColor,
  themeDensity,
  themeSize,
  themeSpacing,
  themeWeight,
} from "@domphy/theme";

/**
 * Styles a data table (header/body/footer cells, caption, row hover, borders)
 * on the host `<table>` element.
 *
 * @hostTag table
 * @param props.color - Theme color applied across cells and text. Optional, accepts a value or state. Defaults to `"neutral"`.
 * @example { table: null, $: [table()] }
 */
function table(
  props: { color?: ValueOrState<ThemeColor> } = {},
): PartialElement {
  const color = toState(props.color ?? "neutral", "color");

  return {
    _onInsert: (node) => {
      if (node.tagName !== "table") {
        console.warn(`"table" primitive patch must use table tag`);
      }
    },
    style: {
      fontSize: (listener) => themeSize(listener, "inherit"),
      color: (listener) => themeColor(listener, "text", color.get(listener)),
      width: "100%",
      borderCollapse: "collapse",
      "& caption": {
        captionSide: "bottom",
      },
      "& th, & thead td": {
        textAlign: "start",
        fontWeight: themeWeight("medium"),
        paddingInline: (listener) => themeSpacing(themeDensity(listener) * 3),
        paddingBlock: (listener) => themeSpacing(themeDensity(listener) * 1),
        color: (listener) =>
          themeColor(listener, "shift-10", color.get(listener)),
        backgroundColor: (listener) => themeColor(listener, "inherit"),
      },
      "& td": {
        textAlign: "start",
        paddingInline: (listener) => themeSpacing(themeDensity(listener) * 3),
        paddingBlock: (listener) => themeSpacing(themeDensity(listener) * 1),
        color: (listener) => themeColor(listener, "text", color.get(listener)),
        boxShadow: (listener) =>
          `inset 0 1px 0 ${themeColor(listener, "shift-3", color.get(listener))}`,
        fontSize: (listener) => themeSize(listener, "inherit"),
      },
      "& tfoot th, & tfoot td": {
        textAlign: "start",
        fontWeight: themeWeight("medium"),
        paddingInline: (listener) => themeSpacing(themeDensity(listener) * 3),
        paddingBlock: (listener) => themeSpacing(themeDensity(listener) * 1),
        color: (l) => themeColor(l, "shift-10", color.get(l)),
        backgroundColor: (l) => themeColor(l, "inherit"),
        boxShadow: (l) =>
          `inset 0 -1px 0 ${themeColor(l, "shift-4", color.get(l))}`,
      },
      "& tr": {
        backgroundColor: (listener) => themeColor(listener, "inherit"),
      },

      // No !important needed: ".scope tbody tr:hover" (two classes + two
      // elements) already out-specifies any row's own auto-scope class rule.
      "& tbody tr:hover": {
        backgroundColor: (listener) => themeColor(listener, "hover"),
        color: (listener) => themeColor(listener, textToneOn(2)),
      },
      // Cell text tracks the hover fill (+2) — measured in Chromium (axe
      // color-contrast) at 3.57:1 light / 4.37:1 dark while the cells kept the
      // resting "text" tone. It has to be set on the CELLS: `& td` declares its
      // own `color`, and a direct declaration beats anything inherited from the
      // row however specific that row's selector is.
      "& tbody tr:hover td, & tbody tr:hover th": {
        color: (listener) => themeColor(listener, textToneOn(2)),
      },
    },
  };
}

export { table };