@krizaka/ui 2.0.0-beta.5 → 2.0.0

package/registry/slider.json

@@ -1,12 +1,186 @@
 {
   "name": "slider",
   "type": "primitive",
-  "description": "`Slider` (one value or a range), `slider` (the slots). Client (\"use client\").",
+  "title": "Slider",
+  "summary": "A value or a range chosen by dragging a thumb along a track, with arrows and Page keys.",
+  "description": "A value or a range chosen by dragging a thumb along a track, with arrows and Page keys.",
+  "status": "beta",
+  "category": "forms",
+  "platforms": "web",
+  "whenToUse": [
+    "For a value chosen by feel within bounds: volume, speed, brightness.",
+    "Two thumbs for a range: a price, a duration."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "For an exact number the user knows: an input of type number.",
+      "use": "field"
+    },
+    {
+      "when": "For a few named options.",
+      "use": "radio-group"
+    }
+  ],
+  "bestPractices": [
+    "Show the value (`showLabel`) when it matters, formatted by `formatValue`.",
+    "Choose a `step` people can reach with the arrows; `origin` to fill from a centre on a ± range."
+  ],
+  "accessibility": {
+    "keyboard": [
+      {
+        "keys": "Arrow keys",
+        "action": "Move by one step."
+      },
+      {
+        "keys": "Page Up / Page Down",
+        "action": "Move by a larger step."
+      },
+      {
+        "keys": "Home / End",
+        "action": "Go to the minimum or the maximum."
+      }
+    ],
+    "notes": [
+      "Radix Slider: each thumb is a `slider` named by `label` (or `thumbLabels` for a range).",
+      "`formatValue` also gives `aria-valuetext`: the value as it is read."
+    ]
+  },
+  "related": [
+    "field",
+    "progress",
+    "switch"
+  ],
+  "web": {
+    "entry": "@krizaka/ui/slider",
+    "import": "import { Slider } from \"@krizaka/ui/slider\";",
+    "props": [
+      {
+        "component": "Slider",
+        "description": "A slider on one value or a range: `value`/`defaultValue` + `onValueChange`, `min`, `max`, `step`.",
+        "props": [
+          {
+            "name": "label",
+            "type": "string",
+            "default": null,
+            "description": "The accessible name — of the thumb, or of both thumbs of a range — passed translated.",
+            "required": true
+          },
+          {
+            "name": "defaultValue",
+            "type": "SliderValue",
+            "default": null,
+            "description": "The value at first, uncontrolled: one number, or two for a range.",
+            "required": false
+          },
+          {
+            "name": "formatValue",
+            "type": "((value: number) => string)",
+            "default": null,
+            "description": "The value as words (aria-valuetext) and as shown: \"1.5×\", \"−12 %\", \"3 min\".",
+            "required": false
+          },
+          {
+            "name": "onValueChange",
+            "type": "((value: V) => void)",
+            "default": null,
+            "description": "Called on every move, with one number or two.",
+            "required": false
+          },
+          {
+            "name": "onValueCommit",
+            "type": "((value: V) => void)",
+            "default": null,
+            "description": "Called once the drag or the key press ends.",
+            "required": false
+          },
+          {
+            "name": "origin",
+            "type": "number",
+            "default": null,
+            "description": "Fills from this value instead of the minimum (a ±range from 0: brightness, balance). One thumb only.",
+            "required": false
+          },
+          {
+            "name": "showLabel",
+            "type": "boolean",
+            "default": null,
+            "description": "Shows the label and the value above the track. Without it, `label` only names the thumb.",
+            "required": false
+          },
+          {
+            "name": "thumbLabels",
+            "type": "[string, string]",
+            "default": null,
+            "description": "For a range: each thumb's own name ([\"Minimum\", \"Maximum\"]), passed translated.",
+            "required": false
+          },
+          {
+            "name": "value",
+            "type": "SliderValue",
+            "default": null,
+            "description": "One number (a thumb) or two (a range). Controlled with `onValueChange`.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "default",
+        "title": "Default",
+        "description": "The thumb alone, named by `label`.",
+        "path": "examples/slider/default.tsx",
+        "module": "@krizaka/ui/registry/examples/slider/default",
+        "code": "import { Slider } from \"@krizaka/ui/slider\";\n\nexport default function SliderDefault() {\n  return <Slider label=\"Volume\" defaultValue={60} />;\n}\n"
+      },
+      {
+        "name": "with-label",
+        "title": "With a label",
+        "description": "`showLabel`: the label and the formatted value above the track.",
+        "path": "examples/slider/with-label.tsx",
+        "module": "@krizaka/ui/registry/examples/slider/with-label",
+        "code": "\"use client\";\n\nimport { Slider } from \"@krizaka/ui/slider\";\n\n// `showLabel`: the label and the formatted value above the track.\nexport default function SliderWithLabel() {\n  return <Slider label=\"Speed\" showLabel defaultValue={1.5} min={0.5} max={2} step={0.25} formatValue={(v) => `${v}×`} />;\n}\n"
+      },
+      {
+        "name": "centred",
+        "title": "Centred",
+        "description": "`origin={0}` on a ± range.",
+        "path": "examples/slider/centred.tsx",
+        "module": "@krizaka/ui/registry/examples/slider/centred",
+        "code": "\"use client\";\n\nimport { Slider } from \"@krizaka/ui/slider\";\n\n// `origin={0}` on a ±range: the fill starts at the centre.\nexport default function SliderCentred() {\n  return <Slider label=\"Brightness\" showLabel defaultValue={-30} min={-100} max={100} origin={0} formatValue={(v) => `${v > 0 ? \"+\" : \"\"}${v} %`} />;\n}\n"
+      },
+      {
+        "name": "range",
+        "title": "Range",
+        "description": "Two thumbs, each named.",
+        "path": "examples/slider/range.tsx",
+        "module": "@krizaka/ui/registry/examples/slider/range",
+        "code": "\"use client\";\n\nimport { Slider } from \"@krizaka/ui/slider\";\n\n// Two thumbs, each named by `thumbLabels`.\nexport default function SliderRange() {\n  return (\n    <Slider<[number, number]>\n      label=\"Price\"\n      thumbLabels={[\"Minimum price\", \"Maximum price\"]}\n      showLabel\n      defaultValue={[10, 60]}\n      max={100}\n      step={5}\n      formatValue={(v) => `$${v}`}\n    />\n  );\n}\n"
+      },
+      {
+        "name": "disabled",
+        "title": "Disabled",
+        "description": "Not available.",
+        "path": "examples/slider/disabled.tsx",
+        "module": "@krizaka/ui/registry/examples/slider/disabled",
+        "code": "import { Slider } from \"@krizaka/ui/slider\";\n\nexport default function SliderDisabled() {\n  return <Slider label=\"Volume\" defaultValue={60} disabled />;\n}\n"
+      }
+    ]
+  },
+  "native": null,
   "files": [
+    {
+      "path": "meta.ts",
+      "content": "// The documentation of a component, carried by its code: each primitive has a `meta.ts` beside its source\n// (`src/<name>/meta.ts`; a component that exists only in React Native: `src/native/meta/<name>.ts`). Never built into\n// the package: `scripts/build-registry.mjs` reads them into `registry/<name>.json`, which krizaka.com renders as\n// /docs/ui/<name>, and `scripts/registry.test.mjs` fails when one is missing or incomplete.\n//\n// Why a typed module and not JSDoc tags: the fields are lists and links (`related`, `whenNotToUse[].use`, examples),\n// which a type checks and a comment does not; the file is plain data (erasable TypeScript), so Node reads it without a\n// compiler, and an editor completes it.\n\n/** Every documented component: the web primitives (one entry of the package each) and the native-only ones. */\nexport type ComponentName =\n  | \"alert\"\n  | \"avatar\"\n  | \"badge\"\n  | \"button\"\n  | \"card\"\n  | \"checkbox\"\n  | \"chip\"\n  | \"cn\"\n  | \"command\"\n  | \"confirm-button\"\n  | \"countdown\"\n  | \"dialog\"\n  | \"dropdown-menu\"\n  | \"empty-state\"\n  | \"field\"\n  | \"kbd\"\n  | \"page-header\"\n  | \"popover\"\n  | \"progress\"\n  | \"radio-group\"\n  | \"section-backdrop\"\n  | \"segmented\"\n  | \"separator\"\n  | \"skeleton\"\n  | \"slider\"\n  | \"slot\"\n  | \"spinner\"\n  | \"stat\"\n  | \"switch\"\n  | \"tabs\"\n  | \"theme\"\n  | \"toast\"\n  | \"tooltip\"\n  | \"txt\";\n\n/** Where a component exists: `@krizaka/ui/<name>` (web), `@krizaka/ui/native` (React Native), or both. */\nexport type Platform = \"web\" | \"native\" | \"both\";\n\n/** `stable`: its API only changes in a major. `beta`: it may still change in a minor. */\nexport type Status = \"stable\" | \"beta\";\n\n/** The group of the catalogue. */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"layout\" | \"foundations\";\n\n/**\n * A named example: the file `registry/examples/<component>/<name>.tsx` (web) or\n * `registry/examples/<component>/native/<name>.tsx` (React Native) — at most 40 lines, imported by the stories and\n * shown (live, with its code) by the documentation.\n */\nexport interface Example {\n  /** The file name, kebab-case (`primary`, `icon-button`). */\n  readonly name: string;\n  /** A short title (`Primary`, `Icon button`). */\n  readonly title: string;\n  /** One or two sentences: when this variant is the right one. */\n  readonly description: string;\n}\n\n/** One platform's side of a component. */\nexport interface PlatformDocs {\n  /** The names to import (`[\"Button\", \"IconButton\"]`): from `@krizaka/ui/<name>` on the web, `@krizaka/ui/native` in React Native. */\n  readonly imports: readonly string[];\n  /** The examples, in reading order; the first one is the component's preview. */\n  readonly examples: readonly Example[];\n}\n\n/** The React Native side: the same concept, and what differs from the web API. */\nexport interface NativeDocs extends PlatformDocs {\n  /** What differs from the web API (`label` instead of children…); empty for a native-only component. */\n  readonly differences: readonly string[];\n}\n\nexport interface KeyboardInteraction {\n  /** The keys, as written on a keyboard: `Space`, `Enter`, `Arrow keys`, `Esc`, `Tab`. */\n  readonly keys: string;\n  /** What they do. */\n  readonly action: string;\n}\n\nexport interface ComponentMeta {\n  /** The display name: `Button`, `Dropdown menu`. */\n  readonly title: string;\n  /** One sentence: what it is. */\n  readonly summary: string;\n  readonly status: Status;\n  readonly category: Category;\n  /** Must match the sides below: `both` ⇔ `web` and `native`. */\n  readonly platforms: Platform;\n  /** When to reach for it: concrete situations, one per item. */\n  readonly whenToUse: readonly string[];\n  /** When not to — and what to use instead (`use`), when another component is the answer. */\n  readonly whenNotToUse: readonly { readonly when: string; readonly use?: ComponentName }[];\n  /** How to use it well: wording, placement, composition. */\n  readonly bestPractices: readonly string[];\n  readonly accessibility: {\n    /** The keyboard, when it does more than Tab and Enter. */\n    readonly keyboard: readonly KeyboardInteraction[];\n    /** Roles, names and announcements: what the component does, what the app must provide. */\n    readonly notes: readonly string[];\n  };\n  /** The components a reader of this page should know about. */\n  readonly related: readonly ComponentName[];\n  readonly web?: PlatformDocs;\n  readonly native?: NativeDocs;\n}\n"
+    },
     {
       "path": "slider/index.ts",
       "content": "/** @krizaka/ui/slider — `Slider` (one value or a range), `slider` (the slots). Client (\"use client\"). */\nexport { Slider, slider, type SliderProps, type SliderValue } from \"./slider\";\n"
     },
+    {
+      "path": "slider/meta.ts",
+      "content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n  title: \"Slider\",\n  summary: \"A value or a range chosen by dragging a thumb along a track, with arrows and Page keys.\",\n  status: \"beta\",\n  category: \"forms\",\n  platforms: \"web\",\n  whenToUse: [\"For a value chosen by feel within bounds: volume, speed, brightness.\", \"Two thumbs for a range: a price, a duration.\"],\n  whenNotToUse: [\n    { when: \"For an exact number the user knows: an input of type number.\", use: \"field\" },\n    { when: \"For a few named options.\", use: \"radio-group\" },\n  ],\n  bestPractices: [\n    \"Show the value (`showLabel`) when it matters, formatted by `formatValue`.\",\n    \"Choose a `step` people can reach with the arrows; `origin` to fill from a centre on a ± range.\",\n  ],\n  accessibility: {\n    keyboard: [\n      { keys: \"Arrow keys\", action: \"Move by one step.\" },\n      { keys: \"Page Up / Page Down\", action: \"Move by a larger step.\" },\n      { keys: \"Home / End\", action: \"Go to the minimum or the maximum.\" },\n    ],\n    notes: [\n      \"Radix Slider: each thumb is a `slider` named by `label` (or `thumbLabels` for a range).\",\n      \"`formatValue` also gives `aria-valuetext`: the value as it is read.\",\n    ],\n  },\n  related: [\"field\", \"progress\", \"switch\"],\n  web: {\n    imports: [\"Slider\"],\n    examples: [\n      { name: \"default\", title: \"Default\", description: \"The thumb alone, named by `label`.\" },\n      { name: \"with-label\", title: \"With a label\", description: \"`showLabel`: the label and the formatted value above the track.\" },\n      { name: \"centred\", title: \"Centred\", description: \"`origin={0}` on a ± range.\" },\n      { name: \"range\", title: \"Range\", description: \"Two thumbs, each named.\" },\n      { name: \"disabled\", title: \"Disabled\", description: \"Not available.\" },\n    ],\n  },\n} satisfies ComponentMeta;\n"
+    },
     {
       "path": "slider/slider.tsx",
       "content": "// Client. Radix Slider: role=\"slider\" on each thumb, arrows / Page Up / Page Down / Home / End, a range with two\n// thumbs. The words arrive as props: `label` names the thumb(s), `formatValue` gives the aria-valuetext and the value\n// shown next to a visible label.\nimport { Slider as SliderPrimitive } from \"radix-ui\";\nimport * as React from \"react\";\nimport { tv } from \"tailwind-variants\";\n\nexport const slider = tv({\n  slots: {\n    root: \"flex flex-col gap-2\",\n    header: \"flex items-baseline justify-between gap-3 text-xs font-semibold text-fg-secondary\",\n    value: \"font-mono text-[11px] tabular-nums text-fg-secondary\",\n    control:\n      \"relative flex h-6 w-full touch-none select-none items-center data-disabled:cursor-not-allowed data-disabled:opacity-40\",\n    track: \"relative h-1.5 w-full grow overflow-hidden rounded-full bg-surface-3\",\n    range: \"absolute h-full rounded-full bg-linear-to-r from-accent to-accent-2\",\n    thumb:\n      \"block h-5 w-5 cursor-grab rounded-full border border-border-strong bg-fg-on-media shadow-md transition-[box-shadow] \" +\n      \"focus-visible:outline-hidden focus-visible:ring-4 focus-visible:ring-ring/50 active:cursor-grabbing\",\n  },\n});\n\nexport type SliderValue = number | [number, number];\n\nexport type SliderProps<V extends SliderValue = number> = Omit<\n  React.ComponentProps<typeof SliderPrimitive.Root>,\n  \"value\" | \"defaultValue\" | \"onValueChange\" | \"onValueCommit\" | \"children\"\n> & {\n  /** One number (a thumb) or two (a range). Controlled with `onValueChange`. */\n  value?: V;\n  /** The value at first, uncontrolled: one number, or two for a range. */\n  defaultValue?: V;\n  /** Called on every move, with one number or two. */\n  onValueChange?: (value: V) => void;\n  /** Called once the drag or the key press ends. */\n  onValueCommit?: (value: V) => void;\n  /** The accessible name — of the thumb, or of both thumbs of a range — passed translated. */\n  label: string;\n  /** For a range: each thumb's own name ([\"Minimum\", \"Maximum\"]), passed translated. */\n  thumbLabels?: [string, string];\n  /** The value as words (aria-valuetext) and as shown: \"1.5×\", \"−12 %\", \"3 min\". */\n  formatValue?: (value: number) => string;\n  /** Shows the label and the value above the track. Without it, `label` only names the thumb. */\n  showLabel?: boolean;\n  /** Fills from this value instead of the minimum (a ±range from 0: brightness, balance). One thumb only. */\n  origin?: number;\n};\n\nconst toArray = (v: SliderValue | undefined) => (v === undefined ? undefined : typeof v === \"number\" ? [v] : v);\n\n/** A slider on one value or a range: `value`/`defaultValue` + `onValueChange`, `min`, `max`, `step`. */\nexport function Slider<V extends SliderValue = number>({\n  value,\n  defaultValue,\n  onValueChange,\n  onValueCommit,\n  label,\n  thumbLabels,\n  formatValue = String,\n  showLabel,\n  origin,\n  min = 0,\n  max = 100,\n  className,\n  ...props\n}: SliderProps<V>) {\n  const s = slider();\n  const range = Array.isArray(value ?? defaultValue);\n  const [inner, setInner] = React.useState(() => toArray(defaultValue) ?? [min]);\n  const current = toArray(value) ?? inner;\n  const out = (next: number[]) => (range ? next : next[0]) as V;\n  const pct = (v: number) => ((v - min) / (max - min || 1)) * 100;\n  const fill =\n    origin !== undefined && !range\n      ? { left: `${Math.min(pct(origin), pct(current[0]))}%`, right: `${100 - Math.max(pct(origin), pct(current[0]))}%` }\n      : undefined;\n  const id = React.useId();\n  return (\n    <div className={s.root({ className })} data-range={range ? \"\" : undefined}>\n      {showLabel && (\n        <div className={s.header()}>\n          <span id={`${id}-label`}>{label}</span>\n          <span className={s.value()} aria-hidden>\n            {current.map(formatValue).join(\" – \")}\n          </span>\n        </div>\n      )}\n      <SliderPrimitive.Root\n        min={min}\n        max={max}\n        value={current}\n        onValueChange={(next) => {\n          if (value === undefined) setInner(next);\n          onValueChange?.(out(next));\n        }}\n        onValueCommit={onValueCommit && ((next) => onValueCommit(out(next)))}\n        className={s.control()}\n        {...props}\n      >\n        <SliderPrimitive.Track className={s.track()}>\n          {fill ? <span data-origin=\"\" className={s.range()} style={fill} /> : <SliderPrimitive.Range className={s.range()} />}\n        </SliderPrimitive.Track>\n        {current.map((v, i) => (\n          <SliderPrimitive.Thumb\n            key={i}\n            aria-label={range ? (thumbLabels?.[i] ?? label) : showLabel ? undefined : label}\n            aria-labelledby={!range && showLabel ? `${id}-label` : undefined}\n            aria-valuetext={formatValue(v)}\n            className={s.thumb()}\n          />\n        ))}\n      </SliderPrimitive.Root>\n    </div>\n  );\n}\n"
@@ -18,8 +192,8 @@
   ],
   "registryDependencies": [],
   "demo": {
-    "path": "demos/slider.tsx",
-    "content": "import { Slider } from \"@krizaka/ui/slider\";\n\nexport default function SliderDemo() {\n  return <Slider label=\"Volume\" defaultValue={60} />;\n}\n"
+    "path": "examples/slider/default.tsx",
+    "content": "import { Slider } from \"@krizaka/ui/slider\";\n\nexport default function SliderDefault() {\n  return <Slider label=\"Volume\" defaultValue={60} />;\n}\n"
   },
   "props": [
     {

package/registry/slot.json

@@ -1,11 +1,87 @@
 {
   "name": "slot",
   "type": "primitive",
-  "description": "`Slot` (what `asChild` renders) and `VisuallyHidden` (a name for assistive technology only), from Radix.",
+  "title": "Slot",
+  "summary": "`Slot` merges its props and classes into its only child — the engine of `asChild` — and `VisuallyHidden` names things for screen readers only.",
+  "description": "`Slot` merges its props and classes into its only child — the engine of `asChild` — and `VisuallyHidden` names things for screen readers only.",
+  "status": "stable",
+  "category": "foundations",
+  "platforms": "web",
+  "whenToUse": [
+    "To give your own component an `asChild` prop.",
+    "`VisuallyHidden` for words that only assistive technology needs: an icon button's name, a table caption."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "To style a link like a button: `asChild` on the button does it.",
+      "use": "button"
+    },
+    {
+      "when": "To hide something from everyone: use `hidden`."
+    }
+  ],
+  "bestPractices": [
+    "`Slot` takes exactly one child element.",
+    "Prefer a visible label to `VisuallyHidden` when there is room for one."
+  ],
+  "accessibility": {
+    "keyboard": [],
+    "notes": [
+      "`VisuallyHidden` is read by screen readers and not shown.",
+      "`Slot` keeps the child's element: a link stays a link, with its role and keyboard."
+    ]
+  },
+  "related": [
+    "button",
+    "cn"
+  ],
+  "web": {
+    "entry": "@krizaka/ui/slot",
+    "import": "import { Slot, VisuallyHidden } from \"@krizaka/ui/slot\";",
+    "props": [
+      {
+        "component": "Slot",
+        "description": "Merges its props, `className` and `ref` into its only child: the engine of every `asChild`.",
+        "props": []
+      },
+      {
+        "component": "VisuallyHidden",
+        "description": "Hidden on screen, read by assistive technology.",
+        "props": []
+      }
+    ],
+    "examples": [
+      {
+        "name": "as-child",
+        "title": "Slot",
+        "description": "The link is rendered, styled by the Slot.",
+        "path": "examples/slot/as-child.tsx",
+        "module": "@krizaka/ui/registry/examples/slot/as-child",
+        "code": "import { Slot, VisuallyHidden } from \"@krizaka/ui/slot\";\n\nexport default function SlotAsChild() {\n  // Slot merges its props and classes into its only child: the link is rendered, styled by the Slot.\n  return (\n    <Slot className=\"text-sm font-semibold text-fg underline underline-offset-4\">\n      <a href=\"#docs\">\n        Read the docs\n        <VisuallyHidden> about Slot</VisuallyHidden>\n      </a>\n    </Slot>\n  );\n}\n"
+      },
+      {
+        "name": "visually-hidden",
+        "title": "VisuallyHidden",
+        "description": "An icon button named for screen readers.",
+        "path": "examples/slot/visually-hidden.tsx",
+        "module": "@krizaka/ui/registry/examples/slot/visually-hidden",
+        "code": "import { VisuallyHidden } from \"@krizaka/ui/slot\";\n\n// A name for assistive technology only: the icon is seen, the words are read.\nexport default function SlotVisuallyHidden() {\n  return (\n    <button type=\"button\" className=\"inline-flex h-10 w-10 items-center justify-center rounded-lg border border-border-default text-fg\">\n      <svg viewBox=\"0 0 24 24\" className=\"h-4 w-4\" fill=\"none\" stroke=\"currentColor\" strokeWidth=\"2\" strokeLinecap=\"round\" aria-hidden>\n        <path d=\"M18 6 6 18M6 6l12 12\" />\n      </svg>\n      <VisuallyHidden>Close</VisuallyHidden>\n    </button>\n  );\n}\n"
+      }
+    ]
+  },
+  "native": null,
   "files": [
+    {
+      "path": "meta.ts",
+      "content": "// The documentation of a component, carried by its code: each primitive has a `meta.ts` beside its source\n// (`src/<name>/meta.ts`; a component that exists only in React Native: `src/native/meta/<name>.ts`). Never built into\n// the package: `scripts/build-registry.mjs` reads them into `registry/<name>.json`, which krizaka.com renders as\n// /docs/ui/<name>, and `scripts/registry.test.mjs` fails when one is missing or incomplete.\n//\n// Why a typed module and not JSDoc tags: the fields are lists and links (`related`, `whenNotToUse[].use`, examples),\n// which a type checks and a comment does not; the file is plain data (erasable TypeScript), so Node reads it without a\n// compiler, and an editor completes it.\n\n/** Every documented component: the web primitives (one entry of the package each) and the native-only ones. */\nexport type ComponentName =\n  | \"alert\"\n  | \"avatar\"\n  | \"badge\"\n  | \"button\"\n  | \"card\"\n  | \"checkbox\"\n  | \"chip\"\n  | \"cn\"\n  | \"command\"\n  | \"confirm-button\"\n  | \"countdown\"\n  | \"dialog\"\n  | \"dropdown-menu\"\n  | \"empty-state\"\n  | \"field\"\n  | \"kbd\"\n  | \"page-header\"\n  | \"popover\"\n  | \"progress\"\n  | \"radio-group\"\n  | \"section-backdrop\"\n  | \"segmented\"\n  | \"separator\"\n  | \"skeleton\"\n  | \"slider\"\n  | \"slot\"\n  | \"spinner\"\n  | \"stat\"\n  | \"switch\"\n  | \"tabs\"\n  | \"theme\"\n  | \"toast\"\n  | \"tooltip\"\n  | \"txt\";\n\n/** Where a component exists: `@krizaka/ui/<name>` (web), `@krizaka/ui/native` (React Native), or both. */\nexport type Platform = \"web\" | \"native\" | \"both\";\n\n/** `stable`: its API only changes in a major. `beta`: it may still change in a minor. */\nexport type Status = \"stable\" | \"beta\";\n\n/** The group of the catalogue. */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"layout\" | \"foundations\";\n\n/**\n * A named example: the file `registry/examples/<component>/<name>.tsx` (web) or\n * `registry/examples/<component>/native/<name>.tsx` (React Native) — at most 40 lines, imported by the stories and\n * shown (live, with its code) by the documentation.\n */\nexport interface Example {\n  /** The file name, kebab-case (`primary`, `icon-button`). */\n  readonly name: string;\n  /** A short title (`Primary`, `Icon button`). */\n  readonly title: string;\n  /** One or two sentences: when this variant is the right one. */\n  readonly description: string;\n}\n\n/** One platform's side of a component. */\nexport interface PlatformDocs {\n  /** The names to import (`[\"Button\", \"IconButton\"]`): from `@krizaka/ui/<name>` on the web, `@krizaka/ui/native` in React Native. */\n  readonly imports: readonly string[];\n  /** The examples, in reading order; the first one is the component's preview. */\n  readonly examples: readonly Example[];\n}\n\n/** The React Native side: the same concept, and what differs from the web API. */\nexport interface NativeDocs extends PlatformDocs {\n  /** What differs from the web API (`label` instead of children…); empty for a native-only component. */\n  readonly differences: readonly string[];\n}\n\nexport interface KeyboardInteraction {\n  /** The keys, as written on a keyboard: `Space`, `Enter`, `Arrow keys`, `Esc`, `Tab`. */\n  readonly keys: string;\n  /** What they do. */\n  readonly action: string;\n}\n\nexport interface ComponentMeta {\n  /** The display name: `Button`, `Dropdown menu`. */\n  readonly title: string;\n  /** One sentence: what it is. */\n  readonly summary: string;\n  readonly status: Status;\n  readonly category: Category;\n  /** Must match the sides below: `both` ⇔ `web` and `native`. */\n  readonly platforms: Platform;\n  /** When to reach for it: concrete situations, one per item. */\n  readonly whenToUse: readonly string[];\n  /** When not to — and what to use instead (`use`), when another component is the answer. */\n  readonly whenNotToUse: readonly { readonly when: string; readonly use?: ComponentName }[];\n  /** How to use it well: wording, placement, composition. */\n  readonly bestPractices: readonly string[];\n  readonly accessibility: {\n    /** The keyboard, when it does more than Tab and Enter. */\n    readonly keyboard: readonly KeyboardInteraction[];\n    /** Roles, names and announcements: what the component does, what the app must provide. */\n    readonly notes: readonly string[];\n  };\n  /** The components a reader of this page should know about. */\n  readonly related: readonly ComponentName[];\n  readonly web?: PlatformDocs;\n  readonly native?: NativeDocs;\n}\n"
+    },
     {
       "path": "slot/index.ts",
       "content": "/** @krizaka/ui/slot — `Slot` (what `asChild` renders) and `VisuallyHidden` (a name for assistive technology only), from Radix. */\nimport { Slot as SlotPrimitive, VisuallyHidden as VisuallyHiddenPrimitive } from \"radix-ui\";\n\n/** Merges its props, `className` and `ref` into its only child: the engine of every `asChild`. */\nexport const Slot = SlotPrimitive.Root;\n/** Hidden on screen, read by assistive technology. */\nexport const VisuallyHidden = VisuallyHiddenPrimitive.Root;\n"
+    },
+    {
+      "path": "slot/meta.ts",
+      "content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n  title: \"Slot\",\n  summary: \"`Slot` merges its props and classes into its only child — the engine of `asChild` — and `VisuallyHidden` names things for screen readers only.\",\n  status: \"stable\",\n  category: \"foundations\",\n  platforms: \"web\",\n  whenToUse: [\"To give your own component an `asChild` prop.\", \"`VisuallyHidden` for words that only assistive technology needs: an icon button's name, a table caption.\"],\n  whenNotToUse: [\n    { when: \"To style a link like a button: `asChild` on the button does it.\", use: \"button\" },\n    { when: \"To hide something from everyone: use `hidden`.\" },\n  ],\n  bestPractices: [\"`Slot` takes exactly one child element.\", \"Prefer a visible label to `VisuallyHidden` when there is room for one.\"],\n  accessibility: {\n    keyboard: [],\n    notes: [\"`VisuallyHidden` is read by screen readers and not shown.\", \"`Slot` keeps the child's element: a link stays a link, with its role and keyboard.\"],\n  },\n  related: [\"button\", \"cn\"],\n  web: {\n    imports: [\"Slot\", \"VisuallyHidden\"],\n    examples: [\n      { name: \"as-child\", title: \"Slot\", description: \"The link is rendered, styled by the Slot.\" },\n      { name: \"visually-hidden\", title: \"VisuallyHidden\", description: \"An icon button named for screen readers.\" },\n    ],\n  },\n} satisfies ComponentMeta;\n"
     }
   ],
   "dependencies": [
@@ -13,8 +89,8 @@
   ],
   "registryDependencies": [],
   "demo": {
-    "path": "demos/slot.tsx",
-    "content": "import { Slot, VisuallyHidden } from \"@krizaka/ui/slot\";\n\nexport default function SlotDemo() {\n  // Slot merges its props and classes into its only child: the link is rendered, styled by the Slot.\n  return (\n    <Slot className=\"text-sm font-semibold text-fg underline underline-offset-4\">\n      <a href=\"#docs\">\n        Read the docs\n        <VisuallyHidden> about Slot</VisuallyHidden>\n      </a>\n    </Slot>\n  );\n}\n"
+    "path": "examples/slot/as-child.tsx",
+    "content": "import { Slot, VisuallyHidden } from \"@krizaka/ui/slot\";\n\nexport default function SlotAsChild() {\n  // Slot merges its props and classes into its only child: the link is rendered, styled by the Slot.\n  return (\n    <Slot className=\"text-sm font-semibold text-fg underline underline-offset-4\">\n      <a href=\"#docs\">\n        Read the docs\n        <VisuallyHidden> about Slot</VisuallyHidden>\n      </a>\n    </Slot>\n  );\n}\n"
   },
   "props": [
     {

package/registry/spinner.json

@@ -1,12 +1,153 @@
 {
   "name": "spinner",
   "type": "primitive",
-  "description": "`Spinner`, `spinnerVariants`. Server-safe.",
+  "title": "Spinner",
+  "summary": "An indeterminate wait: a turning ring named by `label`.",
+  "description": "An indeterminate wait: a turning ring named by `label`.",
+  "status": "stable",
+  "category": "feedback",
+  "platforms": "both",
+  "whenToUse": [
+    "For a short wait of unknown length: a search, a refresh, an infinite list loading more."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "When the layout of what is loading is known.",
+      "use": "skeleton"
+    },
+    {
+      "when": "When the progress is known.",
+      "use": "progress"
+    },
+    {
+      "when": "Inside a button that runs an action: set `loading` on the button.",
+      "use": "button"
+    }
+  ],
+  "bestPractices": [
+    "One spinner per region: never a page full of them.",
+    "Pass `label` translated (“Loading”, “Searching”)."
+  ],
+  "accessibility": {
+    "keyboard": [],
+    "notes": [
+      "`role=\"status\"` named by `label`: announced politely.",
+      "It stops turning under `prefers-reduced-motion`."
+    ]
+  },
+  "related": [
+    "skeleton",
+    "progress",
+    "button"
+  ],
+  "web": {
+    "entry": "@krizaka/ui/spinner",
+    "import": "import { Spinner } from \"@krizaka/ui/spinner\";",
+    "props": [
+      {
+        "component": "Spinner",
+        "description": "A turning ring with `role=\"status\"` (it stops turning under prefers-reduced-motion).",
+        "props": [
+          {
+            "name": "label",
+            "type": "string",
+            "default": null,
+            "description": "The accessible name of the wait, e.g. \"Loading\" — passed translated.",
+            "required": true
+          },
+          {
+            "name": "size",
+            "type": "\"sm\" | \"md\" | \"lg\"",
+            "default": "md",
+            "description": "sm · md · lg.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "default",
+        "title": "Default",
+        "description": "Named by `label`.",
+        "path": "examples/spinner/default.tsx",
+        "module": "@krizaka/ui/registry/examples/spinner/default",
+        "code": "import { Spinner } from \"@krizaka/ui/spinner\";\n\nexport default function SpinnerDefault() {\n  return <Spinner label=\"Loading\" />;\n}\n"
+      },
+      {
+        "name": "sizes",
+        "title": "Sizes",
+        "description": "`sm`, `md`, `lg`.",
+        "path": "examples/spinner/sizes.tsx",
+        "module": "@krizaka/ui/registry/examples/spinner/sizes",
+        "code": "import { Spinner } from \"@krizaka/ui/spinner\";\n\nexport default function SpinnerSizes() {\n  return (\n    <div className=\"flex items-center gap-4\">\n      <Spinner label=\"Loading\" size=\"sm\" />\n      <Spinner label=\"Loading\" size=\"md\" />\n      <Spinner label=\"Loading\" size=\"lg\" />\n    </div>\n  );\n}\n"
+      },
+      {
+        "name": "muted",
+        "title": "Muted",
+        "description": "The colour follows `className`.",
+        "path": "examples/spinner/muted.tsx",
+        "module": "@krizaka/ui/registry/examples/spinner/muted",
+        "code": "import { Spinner } from \"@krizaka/ui/spinner\";\n\n// The colour follows `className` (here a text role).\nexport default function SpinnerMuted() {\n  return <Spinner label=\"Loading\" className=\"text-fg-secondary\" />;\n}\n"
+      }
+    ]
+  },
+  "native": {
+    "entry": "@krizaka/ui/native",
+    "import": "import { Spinner } from \"@krizaka/ui/native\";",
+    "differences": [
+      "The platform's `ActivityIndicator`, in the accent."
+    ],
+    "props": [
+      {
+        "component": "Spinner",
+        "description": "An indeterminate wait: the platform's activity indicator in the accent, named by `label`.",
+        "props": [
+          {
+            "name": "label",
+            "type": "string",
+            "default": null,
+            "description": "The accessible name of the wait, e.g. \"Loading\" — passed translated.",
+            "required": true
+          },
+          {
+            "name": "size",
+            "type": "\"sm\" | \"md\" | \"lg\"",
+            "default": "md",
+            "description": "sm · md (default) · lg.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "sizes",
+        "title": "Sizes",
+        "description": "`sm`, `md`, `lg`, named by `label`.",
+        "path": "examples/spinner/native/sizes.tsx",
+        "module": "@krizaka/ui/registry/examples/spinner/native/sizes",
+        "code": "import { Spinner } from \"@krizaka/ui/native\";\nimport { View } from \"react-native\";\n\n// The platform's indicator in the accent, named by `label`.\nexport default function NativeSpinnerSizes() {\n  return (\n    <View style={{ flexDirection: \"row\", gap: 16, alignItems: \"center\" }}>\n      <Spinner label=\"Loading\" size=\"sm\" />\n      <Spinner label=\"Loading\" size=\"md\" />\n      <Spinner label=\"Loading\" size=\"lg\" />\n    </View>\n  );\n}\n",
+        "screenshots": {
+          "dark": "examples/spinner/native/sizes.dark.png",
+          "light": "examples/spinner/native/sizes.light.png"
+        }
+      }
+    ]
+  },
   "files": [
+    {
+      "path": "meta.ts",
+      "content": "// The documentation of a component, carried by its code: each primitive has a `meta.ts` beside its source\n// (`src/<name>/meta.ts`; a component that exists only in React Native: `src/native/meta/<name>.ts`). Never built into\n// the package: `scripts/build-registry.mjs` reads them into `registry/<name>.json`, which krizaka.com renders as\n// /docs/ui/<name>, and `scripts/registry.test.mjs` fails when one is missing or incomplete.\n//\n// Why a typed module and not JSDoc tags: the fields are lists and links (`related`, `whenNotToUse[].use`, examples),\n// which a type checks and a comment does not; the file is plain data (erasable TypeScript), so Node reads it without a\n// compiler, and an editor completes it.\n\n/** Every documented component: the web primitives (one entry of the package each) and the native-only ones. */\nexport type ComponentName =\n  | \"alert\"\n  | \"avatar\"\n  | \"badge\"\n  | \"button\"\n  | \"card\"\n  | \"checkbox\"\n  | \"chip\"\n  | \"cn\"\n  | \"command\"\n  | \"confirm-button\"\n  | \"countdown\"\n  | \"dialog\"\n  | \"dropdown-menu\"\n  | \"empty-state\"\n  | \"field\"\n  | \"kbd\"\n  | \"page-header\"\n  | \"popover\"\n  | \"progress\"\n  | \"radio-group\"\n  | \"section-backdrop\"\n  | \"segmented\"\n  | \"separator\"\n  | \"skeleton\"\n  | \"slider\"\n  | \"slot\"\n  | \"spinner\"\n  | \"stat\"\n  | \"switch\"\n  | \"tabs\"\n  | \"theme\"\n  | \"toast\"\n  | \"tooltip\"\n  | \"txt\";\n\n/** Where a component exists: `@krizaka/ui/<name>` (web), `@krizaka/ui/native` (React Native), or both. */\nexport type Platform = \"web\" | \"native\" | \"both\";\n\n/** `stable`: its API only changes in a major. `beta`: it may still change in a minor. */\nexport type Status = \"stable\" | \"beta\";\n\n/** The group of the catalogue. */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"layout\" | \"foundations\";\n\n/**\n * A named example: the file `registry/examples/<component>/<name>.tsx` (web) or\n * `registry/examples/<component>/native/<name>.tsx` (React Native) — at most 40 lines, imported by the stories and\n * shown (live, with its code) by the documentation.\n */\nexport interface Example {\n  /** The file name, kebab-case (`primary`, `icon-button`). */\n  readonly name: string;\n  /** A short title (`Primary`, `Icon button`). */\n  readonly title: string;\n  /** One or two sentences: when this variant is the right one. */\n  readonly description: string;\n}\n\n/** One platform's side of a component. */\nexport interface PlatformDocs {\n  /** The names to import (`[\"Button\", \"IconButton\"]`): from `@krizaka/ui/<name>` on the web, `@krizaka/ui/native` in React Native. */\n  readonly imports: readonly string[];\n  /** The examples, in reading order; the first one is the component's preview. */\n  readonly examples: readonly Example[];\n}\n\n/** The React Native side: the same concept, and what differs from the web API. */\nexport interface NativeDocs extends PlatformDocs {\n  /** What differs from the web API (`label` instead of children…); empty for a native-only component. */\n  readonly differences: readonly string[];\n}\n\nexport interface KeyboardInteraction {\n  /** The keys, as written on a keyboard: `Space`, `Enter`, `Arrow keys`, `Esc`, `Tab`. */\n  readonly keys: string;\n  /** What they do. */\n  readonly action: string;\n}\n\nexport interface ComponentMeta {\n  /** The display name: `Button`, `Dropdown menu`. */\n  readonly title: string;\n  /** One sentence: what it is. */\n  readonly summary: string;\n  readonly status: Status;\n  readonly category: Category;\n  /** Must match the sides below: `both` ⇔ `web` and `native`. */\n  readonly platforms: Platform;\n  /** When to reach for it: concrete situations, one per item. */\n  readonly whenToUse: readonly string[];\n  /** When not to — and what to use instead (`use`), when another component is the answer. */\n  readonly whenNotToUse: readonly { readonly when: string; readonly use?: ComponentName }[];\n  /** How to use it well: wording, placement, composition. */\n  readonly bestPractices: readonly string[];\n  readonly accessibility: {\n    /** The keyboard, when it does more than Tab and Enter. */\n    readonly keyboard: readonly KeyboardInteraction[];\n    /** Roles, names and announcements: what the component does, what the app must provide. */\n    readonly notes: readonly string[];\n  };\n  /** The components a reader of this page should know about. */\n  readonly related: readonly ComponentName[];\n  readonly web?: PlatformDocs;\n  readonly native?: NativeDocs;\n}\n"
+    },
     {
       "path": "spinner/index.ts",
       "content": "/** @krizaka/ui/spinner — `Spinner`, `spinnerVariants`. Server-safe. */\nexport { Spinner, type SpinnerProps, spinnerVariants } from \"./spinner\";\n"
     },
+    {
+      "path": "spinner/meta.ts",
+      "content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n  title: \"Spinner\",\n  summary: \"An indeterminate wait: a turning ring named by `label`.\",\n  status: \"stable\",\n  category: \"feedback\",\n  platforms: \"both\",\n  whenToUse: [\"For a short wait of unknown length: a search, a refresh, an infinite list loading more.\"],\n  whenNotToUse: [\n    { when: \"When the layout of what is loading is known.\", use: \"skeleton\" },\n    { when: \"When the progress is known.\", use: \"progress\" },\n    { when: \"Inside a button that runs an action: set `loading` on the button.\", use: \"button\" },\n  ],\n  bestPractices: [\"One spinner per region: never a page full of them.\", \"Pass `label` translated (“Loading”, “Searching”).\"],\n  accessibility: {\n    keyboard: [],\n    notes: [\"`role=\\\"status\\\"` named by `label`: announced politely.\", \"It stops turning under `prefers-reduced-motion`.\"],\n  },\n  related: [\"skeleton\", \"progress\", \"button\"],\n  web: {\n    imports: [\"Spinner\"],\n    examples: [\n      { name: \"default\", title: \"Default\", description: \"Named by `label`.\" },\n      { name: \"sizes\", title: \"Sizes\", description: \"`sm`, `md`, `lg`.\" },\n      { name: \"muted\", title: \"Muted\", description: \"The colour follows `className`.\" },\n    ],\n  },\n  native: {\n    imports: [\"Spinner\"],\n    differences: [\"The platform's `ActivityIndicator`, in the accent.\"],\n    examples: [{ name: \"sizes\", title: \"Sizes\", description: \"`sm`, `md`, `lg`, named by `label`.\" }],\n  },\n} satisfies ComponentMeta;\n"
+    },
     {
       "path": "spinner/spinner.tsx",
       "content": "// Server-safe. An indeterminate wait: an SVG ring, announced as a status with its `label`.\nimport type * as React from \"react\";\nimport { tv, type VariantProps } from \"tailwind-variants\";\n\nexport const spinnerVariants = tv({\n  base: \"shrink-0 text-accent motion-safe:animate-spin\",\n  variants: { size: { sm: \"h-4 w-4\", md: \"h-6 w-6\", lg: \"h-10 w-10\" } },\n  defaultVariants: { size: \"md\" },\n});\n\nexport type SpinnerProps = Omit<React.ComponentProps<\"svg\">, \"children\"> &\n  VariantProps<typeof spinnerVariants> & {\n    /**\n     * sm · md · lg.\n     * @default \"md\"\n     */\n    size?: VariantProps<typeof spinnerVariants>[\"size\"];\n    /** The accessible name of the wait, e.g. \"Loading\" — passed translated. */\n    label: string;\n  };\n\n/** A turning ring with `role=\"status\"` (it stops turning under prefers-reduced-motion). */\nexport function Spinner({ label, size, className, ...props }: SpinnerProps) {\n  return (\n    <svg\n      role=\"status\"\n      aria-label={label}\n      viewBox=\"0 0 24 24\"\n      fill=\"none\"\n      data-size={size ?? \"md\"}\n      className={spinnerVariants({ size, className })}\n      {...props}\n    >\n      <circle cx=\"12\" cy=\"12\" r=\"9\" stroke=\"currentColor\" strokeOpacity=\"0.2\" strokeWidth=\"3\" />\n      <path d=\"M21 12a9 9 0 0 0-9-9\" stroke=\"currentColor\" strokeWidth=\"3\" strokeLinecap=\"round\" />\n    </svg>\n  );\n}\n"
@@ -17,8 +158,8 @@
   ],
   "registryDependencies": [],
   "demo": {
-    "path": "demos/spinner.tsx",
-    "content": "import { Spinner } from \"@krizaka/ui/spinner\";\n\nexport default function SpinnerDemo() {\n  return <Spinner label=\"Loading\" />;\n}\n"
+    "path": "examples/spinner/default.tsx",
+    "content": "import { Spinner } from \"@krizaka/ui/spinner\";\n\nexport default function SpinnerDefault() {\n  return <Spinner label=\"Loading\" />;\n}\n"
   },
   "props": [
     {