​

Button Switch

Use the button-switch patch to customize this element.

​
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.

<div class="blocks">
<div class="block active" data-tab="0">
import { type PartialElement, toState, type ValueOrState } from "@domphy/core";
import {
  type ThemeColor,
  themeColor,
  themeSize,
  themeSpacing,
} from "@domphy/theme";

/**
 * A pill-shaped toggle switch with `role="switch"`; clicking flips the bound
 * `checked` state and slides the thumb. Apply to a `<button>` element.
 *
 * @hostTag button
 * @param props.checked - Toggle state. Optional `ValueOrState<boolean>`, default false.
 * @param props.accentColor - Color tone when checked (on). Optional `ValueOrState<ThemeColor>`, default "primary".
 * @param props.color - Color tone when unchecked (off track). Optional `ValueOrState<ThemeColor>`, default "neutral".
 * @example { button: { span: null }, $: [buttonSwitch({ checked: true })] }
 */
function buttonSwitch(
  props: {
    checked?: ValueOrState<boolean>;
    accentColor?: ValueOrState<ThemeColor>;
    color?: ValueOrState<ThemeColor>;
  } = {},
): PartialElement {
  const { checked = false } = props;

  const check = toState(checked);
  const color = toState(props.color ?? "neutral", "color");
  const accentColor = toState(props.accentColor ?? "primary", "accentColor");

  return {
    _onSchedule: (node) => {
      if (node.tagName !== "button") {
        console.warn(`"buttonSwitch" primitive patch must use button tag`);
      }
    },
    role: "switch",
    ariaChecked: (listener) => check.get(listener),
    dataTone: "shift-2",
    onClick: () => check.set(!check.get()),
    style: {
      position: "relative",
      display: "inline-flex",
      alignItems: "center",
      fontSize: (listener) => themeSize(listener),
      border: "none",
      outlineWidth: "1px",
      outline: (listener) =>
        `1px solid ${themeColor(listener, "shift-3", color.get(listener))}`,
      minWidth: themeSpacing(12),
      minHeight: themeSpacing(6),
      borderRadius: themeSpacing(999),
      paddingLeft: themeSpacing(7),
      paddingRight: themeSpacing(2),
      transition: "padding-left 0.3s, padding-right 0.3s",
      backgroundColor: (listener) =>
        themeColor(listener, "inherit", color.get(listener)),
      "& > :first-child": {
        content: '""',
        position: "absolute",
        display: "inline-flex",
        alignItems: "center",
        left: themeSpacing(0.5),
        top: "50%",
        transform: "translateY(-50%)",
        transition: "left 0.3s",
        width: themeSpacing(5),
        height: themeSpacing(5),
        borderRadius: themeSpacing(999),
        color: (listener) => themeColor(listener, "shift-9"),
        backgroundColor: (listener) =>
          themeColor(listener, "decrease-2", color.get(listener)),
      },
      "&[aria-checked=true]": {
        backgroundColor: (listener) =>
          themeColor(listener, "increase-3", accentColor.get(listener)),
        outline: "none",
        color: (listener) => themeColor(listener, "decrease-2"),
        paddingLeft: themeSpacing(2),
        paddingRight: themeSpacing(7),
      },
      "&[aria-checked=true] > :first-child": {
        left: `calc(100% - ${themeSpacing(5.5)})`,
      },
      "&[disabled]": {
        opacity: 0.7,
        cursor: "not-allowed",
      },
    },
  };
}

export { buttonSwitch };
</div>
</div>