Skip to content
Domphy

Spinner

Use the spinner patch on a span to show a circular loading indicator.

Props

PropTypeDefaultDescription
colorValueOrState<ThemeColor>"neutral"Theme color tone for the ring and highlight border.
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, StyleObject } from "@domphy/core";
import { hashString, toState, type ValueOrState } from "@domphy/core";
import {
  type ThemeColor,
  themeColor,
  themeSize,
  themeSpacing,
} from "@domphy/theme";

const keyframes = { to: { transform: "rotate(360deg)" } };
const animationName = hashString(JSON.stringify(keyframes));

/**
 * A circular loading spinner: a themed ring with a contrasting top border that rotates
 * continuously. Marked `role="status"` with `aria-label="loading"`.
 *
 * @hostTag span
 * @param props.color - Theme color tone for the ring/highlight. Accepts a value or reactive
 *   state. Defaults to `"neutral"`.
 * @example { span: null, $: [spinner()] }
 */
function spinner(
  props: { color?: ValueOrState<ThemeColor> } = {},
): PartialElement {
  const color = toState(props.color ?? "neutral", "color");

  return {
    role: "status",
    ariaLabel: "loading",
    _onInsert: (node) => {
      if (node.tagName !== "span") {
        console.warn(`"spinner" patch must use span tag`);
      }
    },
    style: {
      fontSize: (listener) => themeSize(listener),
      backgroundColor: (listener) => themeColor(listener),
      color: (listener) => themeColor(listener, "text", color.get(listener)),
      display: "inline-block",
      margin: 0,
      flexShrink: 0,
      width: themeSpacing(6),
      height: themeSpacing(6),
      borderRadius: "50%",
      border: (listener) =>
        `${themeSpacing(0.5)} solid ${themeColor(listener, "border-strong", color.get(listener))}`,
      borderTopColor: (listener) =>
        themeColor(listener, "shift-9", color.get(listener)),
      boxSizing: "border-box",
      padding: 0,
      animation: `${animationName} 0.7s linear infinite`,
      [`@keyframes ${animationName}`]: keyframes,
    } as StyleObject,
  };
}

export { spinner };

Custom spinner variants

The built-in spinner() covers most cases. For more visual variety, use svg-spinners (28+ variants, MIT).

SVG spinners cannot be dropped in as raw HTML — Domphy has no innerHTML. Convert them to element syntax:

  1. Replace the <style> child with CSS-in-JS @keyframes entries on the first animated element.
  2. Replace CSS classes with inline style on each element.
  3. Use hashString (from @domphy/core) to generate a unique animation name — avoids collisions when the same spinner appears multiple times.
  4. Add fill: "currentColor" on the root <svg> and drive color via style.color → themeColor().

Example — 3-dots-bounce:

import { hashString } from "@domphy/core"
import { themeColor } from "@domphy/theme"

const kf = {
  "0%, 57.14%": { animationTimingFunction: "cubic-bezier(.33,.66,.66,1)", transform: "translate(0)" },
  "28.57%": { animationTimingFunction: "cubic-bezier(.33,0,.66,.33)", transform: "translateY(-6px)" },
  "100%": { transform: "translate(0)" },
}
const animName = hashString(JSON.stringify(kf))

export const spinnerDots = {
  svg: [
    { circle: null, cx: "4",  cy: "12", r: "3", style: { animation: `${animName} 1.05s infinite`, [`@keyframes ${animName}`]: kf } },
    { circle: null, cx: "12", cy: "12", r: "3", style: { animation: `${animName} 1.05s infinite`, animationDelay: ".1s" } },
    { circle: null, cx: "20", cy: "12", r: "3", style: { animation: `${animName} 1.05s infinite`, animationDelay: ".2s" } },
  ],
  width: "24", height: "24", viewBox: "0 0 24 24",
  xmlns: "http://www.w3.org/2000/svg",
  fill: "currentColor",
  style: { color: (l) => themeColor(l, "shift-7", "neutral"), display: "inline-block", flexShrink: 0, verticalAlign: "middle" },
}

Apply the same pattern to any variant from svg-spinners — pick the CSS animation version (not SMIL), copy keyframe percentages and per-element delays.