Skip to content
Domphy

Badge

Apply the badge patch to any inline container (typically a <span> wrapping an icon or button) to render a small count bubble pinned to its top-right corner via a ::after pseudo-element. The pill is compact, bold, and ringed with a light hairline so it reads on same-hue surfaces.

Props

PropTypeDefault
colorValueOrState<ThemeColor>"danger"
labelValueOrState<string | number>999
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,
  themeSize,
  themeSpacing,
} from "@domphy/theme";

/**
 * Renders a small count/label bubble pinned to the top-right corner of its host
 * (via a `::after` pseudo-element). Typically applied to an inline container such
 * as a `<span>` wrapping an icon or element.
 *
 * @param props.color - Badge color tone. Optional `ValueOrState<ThemeColor>`, default "danger".
 * @param props.label - Text/number shown in the badge. Optional `ValueOrState<string | number>`, default 999.
 * @example { span: "🔔", $: [badge({ label: 3, color: "danger" })] }
 */
function badge(
  props: {
    color?: ValueOrState<ThemeColor>;
    label?: ValueOrState<string | number>;
  } = {},
): PartialElement {
  const { label = 999 } = props;
  const state = toState(label);
  const color = toState(props.color ?? "danger", "color");
  return {
    // Badge ::after uses a fixed size scale for the pill chrome.
    _doctorDisable: "inline-typography",
    style: {
      position: "relative",
      "&::after": {
        content: (l) => `"${state.get(l)}"`,
        position: "absolute",
        top: 0,
        right: 0,
        transform: "translate(50%,-50%)",
        paddingInline: themeSpacing(1.5),
        minWidth: themeSpacing(5),
        height: themeSpacing(5),
        display: "inline-flex",
        alignItems: "center",
        justifyContent: "center",
        fontSize: (l) => themeSize(l, "decrease-2"),
        fontWeight: "600",
        lineHeight: 1,
        borderRadius: themeSpacing(999),
        backgroundColor: (l) => themeColor(l, "shift-9", color.get(l)),
        color: (l) => themeColor(l, "shift-0", color.get(l)),
        // Hairline ring so the pill pops on same-hue surfaces.
        boxShadow: (l) => `0 0 0 1px ${themeColor(l, "shift-0", color.get(l))}`,
      },
    },
  };
}

export { badge };