@krizaka/ui 2.9.0 → 3.0.0

package/registry/how-it-works-page.json

@@ -0,0 +1,242 @@
+{
+  "name": "how-it-works-page",
+  "type": "primitive",
+  "title": "How-it-works page",
+  "summary": "How a product works, told in steps along a numbered line — each step its words beside its visual, the sides alternating on a wide screen.",
+  "description": "How a product works, told in steps along a numbered line — each step its words beside its visual, the sides alternating on a wide screen.",
+  "status": "beta",
+  "category": "templates",
+  "platforms": "web",
+  "whenToUse": [
+    "The journey of a request, an onboarding, an installation.",
+    "Any process told in three to seven steps."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "For a product's overview.",
+      "use": "product-page"
+    },
+    {
+      "when": "For a step the user is on right now.",
+      "use": "stepper"
+    }
+  ],
+  "bestPractices": [
+    "Three to seven steps; a step's title says what happens, in a few words.",
+    "Each visual shows the step for real: a command, a schema, a screen.",
+    "Words and content arrive as props; the motion is the platform's (`[data-reveal]`, still under reduced motion)."
+  ],
+  "accessibility": {
+    "keyboard": [],
+    "notes": [
+      "The steps are an ordered list; each title an `h2`.",
+      "The line and the numbers are decorative: the list says the order."
+    ]
+  },
+  "related": [
+    "stepper",
+    "product-page",
+    "code-block"
+  ],
+  "web": {
+    "entry": "@krizaka/ui/how-it-works-page",
+    "import": "import { HowItWorksPage } from \"@krizaka/ui/how-it-works-page\";",
+    "props": [
+      {
+        "component": "HowItWorksPage",
+        "description": "How a product works: the hero, a numbered timeline of steps with their visuals, then the details.",
+        "props": [
+          {
+            "name": "steps",
+            "type": "readonly HowStep[]",
+            "default": null,
+            "description": "The steps, in order.",
+            "required": true
+          },
+          {
+            "name": "stepsLabel",
+            "type": "string",
+            "default": null,
+            "description": "The steps' accessible name (`The steps`).",
+            "required": true
+          },
+          {
+            "name": "title",
+            "type": "ReactNode",
+            "default": null,
+            "description": "The page's `h1`.",
+            "required": true
+          },
+          {
+            "name": "aside",
+            "type": "ReactNode",
+            "default": null,
+            "description": "Beside the hero: the page's bird or an illustration.",
+            "required": false
+          },
+          {
+            "name": "back",
+            "type": "{ href: string; label: string; }",
+            "default": null,
+            "description": "The way back to the product.",
+            "required": false
+          },
+          {
+            "name": "brand",
+            "type": "string",
+            "default": null,
+            "description": "The brand the page wears (`.brand-<id>`).",
+            "required": false
+          },
+          {
+            "name": "closing",
+            "type": "{ title: ReactNode; body?: ReactNode; actions: ReactNode; }",
+            "default": null,
+            "description": "The closing call.",
+            "required": false
+          },
+          {
+            "name": "eyebrow",
+            "type": "ReactNode",
+            "default": null,
+            "description": "A mono line above the title.",
+            "required": false
+          },
+          {
+            "name": "lead",
+            "type": "ReactNode",
+            "default": null,
+            "description": "One or two sentences under it.",
+            "required": false
+          },
+          {
+            "name": "linkAs",
+            "type": "LinkComponent",
+            "default": null,
+            "description": "The app's link component (Next's `Link`).",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "orazaka",
+        "title": "Orazaka's journey",
+        "description": "Install, guard, answer — each with its command.",
+        "template": true,
+        "path": "examples/how-it-works-page/orazaka.tsx",
+        "module": "@krizaka/ui/registry/examples/how-it-works-page/orazaka",
+        "code": "import { CodeBlock } from \"@krizaka/ui/code-block\";\nimport { HowItWorksPage } from \"@krizaka/ui/how-it-works-page\";\nimport { Mascot } from \"@krizaka/ui/mascots\";\n\nconst copy = { copyLabel: \"Copy\", copiedLabel: \"Copied\" };\n\n// TEMPLATE — how a product works, in steps along a line (Orazaka's journey of a request): each step its words beside\n// its visual, the sides alternating on a wide screen, one column on a phone.\nexport default function HowItWorksPageOrazaka() {\n  return (\n    <HowItWorksPage\n      brand=\"orazaka\"\n      back={{ href: \"#orazaka\", label: \"Orazaka\" }}\n      eyebrow=\"How it works\"\n      title=\"The journey of a request\"\n      lead=\"Six stages, the same for every request — and none of them leaves your server.\"\n      aside={<Mascot bird=\"duck\" mood=\"thinking\" size={112} />}\n      stepsLabel=\"The steps\"\n      steps={[\n        { id: \"install\", title: \"Install\", text: \"One command pulls the engine, the models you choose and the console.\", visual: <CodeBlock code=\"npx orazaka install\" language=\"bash\" file=\"Terminal\" {...copy} /> },\n        { id: \"guard\", title: \"Guard\", text: \"Every request crosses the same interceptors: identity, quotas, the rules of your workspace.\", visual: <CodeBlock code=\"orazaka rules add --deny pii-export\" language=\"bash\" file=\"Terminal\" {...copy} /> },\n        { id: \"answer\", title: \"Answer\", text: \"The best local model answers; the answer is checked before it is shown.\", visual: <CodeBlock code=\"orazaka chat --model llama3.3\" language=\"bash\" file=\"Terminal\" {...copy} /> },\n      ]}\n    />\n  );\n}\n"
+      }
+    ]
+  },
+  "native": null,
+  "files": [
+    {
+      "path": "how-it-works-page/how-it-works-page.tsx",
+      "content": "// Server-safe. How a product works, told in steps (blocks.css `.kz-tpl-timeline`): the hero, then a numbered line\n// down the page — each step its words beside its visual (a command, a schema, a screen), the sides alternating on a\n// wide screen, one column on a phone — then what is under the hood and the closing call.\nimport { CtaPanel } from \"@krizaka/ui/cta-panel\";\nimport { Section } from \"@krizaka/ui/page\";\nimport type { LinkComponent } from \"@krizaka/ui/page-hero\";\nimport { PageHero } from \"@krizaka/ui/page-hero\";\nimport type * as React from \"react\";\n\nimport { cn } from \"../cn\";\n\nexport interface HowStep {\n  /** A stable key (the step's anchor). */\n  id: string;\n  /** What happens, in a few words. */\n  title: React.ReactNode;\n  /** How, in two or three sentences. */\n  text: React.ReactNode;\n  /** Beside the words: a code block, a schema, a screen. */\n  visual?: React.ReactNode;\n}\n\nexport type HowItWorksPageProps = Omit<React.HTMLAttributes<HTMLElement>, \"title\"> & {\n  /** The brand the page wears (`.brand-<id>`). */\n  brand?: string;\n  /** The way back to the product. */\n  back?: { href: string; label: string };\n  /** A mono line above the title. */\n  eyebrow?: React.ReactNode;\n  /** The page's `h1`. */\n  title: React.ReactNode;\n  /** One or two sentences under it. */\n  lead?: React.ReactNode;\n  /** Beside the hero: the page's bird or an illustration. */\n  aside?: React.ReactNode;\n  /** The steps' accessible name (`The steps`). */\n  stepsLabel: string;\n  /** The steps, in order. */\n  steps: readonly HowStep[];\n  /** After the steps: architecture, guarantees, a module map. */\n  children?: React.ReactNode;\n  /** The closing call. */\n  closing?: { title: React.ReactNode; body?: React.ReactNode; actions: React.ReactNode };\n  /** The app's link component (Next's `Link`). */\n  linkAs?: LinkComponent;\n};\n\n/** How a product works: the hero, a numbered timeline of steps with their visuals, then the details. */\nexport function HowItWorksPage({ brand, back, eyebrow, title, lead, aside, stepsLabel, steps, closing, linkAs, className, children, ...props }: HowItWorksPageProps) {\n  return (\n    <div className={cn(brand && \"brand-\" + brand, className)} {...props}>\n      <PageHero back={back} linkAs={linkAs} eyebrow={eyebrow} title={title} lead={lead} aside={aside} />\n      <Section aria-label={stepsLabel}>\n        <ol className=\"kz-tpl-timeline\">\n          {steps.map((step, i) => (\n            <li key={step.id} id={step.id} className=\"kz-tpl-step\" data-reveal=\"\">\n              <span className=\"kz-tpl-step-n\" aria-hidden>\n                {i + 1}\n              </span>\n              <div className=\"kz-tpl-step-text\">\n                <h2>{step.title}</h2>\n                <p>{step.text}</p>\n              </div>\n              {step.visual && <div className=\"kz-tpl-step-visual\">{step.visual}</div>}\n            </li>\n          ))}\n        </ol>\n      </Section>\n      {children}\n      {closing && (\n        <Section spacing=\"sm\" aria-labelledby=\"how-closing\">\n          <CtaPanel id=\"how-closing\" title={closing.title} body={closing.body} reveal>\n            {closing.actions}\n          </CtaPanel>\n        </Section>\n      )}\n    </div>\n  );\n}\n"
+    },
+    {
+      "path": "how-it-works-page/index.ts",
+      "content": "/** @krizaka/ui/how-it-works-page — `HowItWorksPage`: How a product works: a numbered timeline of steps, each with its visual. Server-safe; a page template. */\nexport { HowItWorksPage, type HowItWorksPageProps, type HowStep } from \"./how-it-works-page\";\n"
+    },
+    {
+      "path": "how-it-works-page/meta.ts",
+      "content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n  title: \"How-it-works page\",\n  summary: \"How a product works, told in steps along a numbered line — each step its words beside its visual, the sides alternating on a wide screen.\",\n  status: \"beta\",\n  category: \"templates\",\n  platforms: \"web\",\n  whenToUse: [\"The journey of a request, an onboarding, an installation.\", \"Any process told in three to seven steps.\"],\n  whenNotToUse: [\n    { when: \"For a product's overview.\", use: \"product-page\" },\n    { when: \"For a step the user is on right now.\", use: \"stepper\" },\n  ],\n  bestPractices: [\"Three to seven steps; a step's title says what happens, in a few words.\", \"Each visual shows the step for real: a command, a schema, a screen.\", \"Words and content arrive as props; the motion is the platform's (`[data-reveal]`, still under reduced motion).\"],\n  accessibility: {\n    keyboard: [],\n    notes: [\"The steps are an ordered list; each title an `h2`.\", \"The line and the numbers are decorative: the list says the order.\"],\n  },\n  related: [\"stepper\", \"product-page\", \"code-block\"],\n  web: {\n    imports: [\"HowItWorksPage\"],\n    examples: [\n      { name: \"orazaka\", title: \"Orazaka's journey\", description: \"Install, guard, answer — each with its command.\", template: true },\n    ],\n  },\n} satisfies ComponentMeta;\n"
+    },
+    {
+      "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  | \"achievement\"\n  | \"action-bar\"\n  | \"alert\"\n  | \"app-shell\"\n  | \"argument-card\"\n  | \"audio-player\"\n  | \"auth-layout\"\n  | \"avatar\"\n  | \"badge\"\n  | \"button\"\n  | \"card\"\n  | \"card-grid\"\n  | \"catalogue-page\"\n  | \"changelog-page\"\n  | \"checkbox\"\n  | \"chip\"\n  | \"chip-link\"\n  | \"choice-grid\"\n  | \"cn\"\n  | \"code-block\"\n  | \"combobox\"\n  | \"command\"\n  | \"component-page\"\n  | \"confirm-button\"\n  | \"contact-page\"\n  | \"continue-prompt\"\n  | \"countdown\"\n  | \"cta-panel\"\n  | \"dashboard-layout\"\n  | \"data-table\"\n  | \"date-picker\"\n  | \"decision-list\"\n  | \"detail-layout\"\n  | \"dialog\"\n  | \"docs-article-page\"\n  | \"docs-hub-page\"\n  | \"docs-layout\"\n  | \"dropdown-menu\"\n  | \"empty-state\"\n  | \"error-page\"\n  | \"field\"\n  | \"file-upload\"\n  | \"filter-bar\"\n  | \"gallery-page\"\n  | \"glow-card\"\n  | \"goal-gauge\"\n  | \"how-it-works-page\"\n  | \"image-cropper\"\n  | \"iso\"\n  | \"kbd\"\n  | \"landing-page\"\n  | \"landscape\"\n  | \"legal-page\"\n  | \"link-card\"\n  | \"list\"\n  | \"loader\"\n  | \"longform-page\"\n  | \"marketing-layout\"\n  | \"marquee\"\n  | \"mascot-quote\"\n  | \"mascot-state\"\n  | \"mascots\"\n  | \"media-capture\"\n  | \"meter\"\n  | \"nav-bar\"\n  | \"number-ticker\"\n  | \"page\"\n  | \"page-header\"\n  | \"page-hero\"\n  | \"pagination\"\n  | \"pointer-light\"\n  | \"popover\"\n  | \"pricing-page\"\n  | \"product-page\"\n  | \"profile-card\"\n  | \"progress\"\n  | \"promise-card\"\n  | \"radio-group\"\n  | \"scroll-stage\"\n  | \"search-field\"\n  | \"section-backdrop\"\n  | \"segmented\"\n  | \"separator\"\n  | \"settings-layout\"\n  | \"skeleton\"\n  | \"slider\"\n  | \"slot\"\n  | \"spinner\"\n  | \"split-view\"\n  | \"stage-banner\"\n  | \"stat\"\n  | \"status-page\"\n  | \"stepper\"\n  | \"switch\"\n  | \"tabs\"\n  | \"tag-input\"\n  | \"terminal-replay\"\n  | \"theme\"\n  | \"toast\"\n  | \"toc\"\n  | \"tooltip\"\n  | \"txt\"\n  | \"video-player\"\n  | \"video-trimmer\"\n  | \"virtual\";\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/**\n * The group of the catalogue. `media`: video, sound, camera, files, cropping. `blocks`: the page blocks — the frame,\n * the hero, sections, cards that lead or argue, decisions, code, calls to act — that every page of a site is made of.\n * `layouts`: the shells of whole screens — an application, a dashboard, settings, sign-in, an object, a list and its\n * item, a site's page, a documentation page — each with its screens. `templates`: the page templates — whole pages of a\n * site (a landing, a product, a docs hub, a long read, a changelog, pricing, status, an error…), each a distinct\n * composition of the blocks, words and content as props.\n */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"media\" | \"blocks\" | \"layouts\" | \"templates\" | \"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   * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its phone\n   * version thought out), copied as a starting point — at most 160 lines, listed on krizaka.com/docs/ui/templates.\n   */\n  readonly template?: boolean;\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  /**\n   * The entry to import from when it is not `@krizaka/ui/native`: a component that needs an Expo module (an optional\n   * peer) has its own, `@krizaka/ui/native/<name>`, so an app that does not use it never installs the module.\n   */\n  readonly entry?: string;\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"
+    }
+  ],
+  "dependencies": [],
+  "registryDependencies": [
+    "cn",
+    "cta-panel",
+    "page",
+    "page-hero"
+  ],
+  "demo": {
+    "path": "examples/how-it-works-page/orazaka.tsx",
+    "content": "import { CodeBlock } from \"@krizaka/ui/code-block\";\nimport { HowItWorksPage } from \"@krizaka/ui/how-it-works-page\";\nimport { Mascot } from \"@krizaka/ui/mascots\";\n\nconst copy = { copyLabel: \"Copy\", copiedLabel: \"Copied\" };\n\n// TEMPLATE — how a product works, in steps along a line (Orazaka's journey of a request): each step its words beside\n// its visual, the sides alternating on a wide screen, one column on a phone.\nexport default function HowItWorksPageOrazaka() {\n  return (\n    <HowItWorksPage\n      brand=\"orazaka\"\n      back={{ href: \"#orazaka\", label: \"Orazaka\" }}\n      eyebrow=\"How it works\"\n      title=\"The journey of a request\"\n      lead=\"Six stages, the same for every request — and none of them leaves your server.\"\n      aside={<Mascot bird=\"duck\" mood=\"thinking\" size={112} />}\n      stepsLabel=\"The steps\"\n      steps={[\n        { id: \"install\", title: \"Install\", text: \"One command pulls the engine, the models you choose and the console.\", visual: <CodeBlock code=\"npx orazaka install\" language=\"bash\" file=\"Terminal\" {...copy} /> },\n        { id: \"guard\", title: \"Guard\", text: \"Every request crosses the same interceptors: identity, quotas, the rules of your workspace.\", visual: <CodeBlock code=\"orazaka rules add --deny pii-export\" language=\"bash\" file=\"Terminal\" {...copy} /> },\n        { id: \"answer\", title: \"Answer\", text: \"The best local model answers; the answer is checked before it is shown.\", visual: <CodeBlock code=\"orazaka chat --model llama3.3\" language=\"bash\" file=\"Terminal\" {...copy} /> },\n      ]}\n    />\n  );\n}\n"
+  },
+  "props": [
+    {
+      "component": "HowItWorksPage",
+      "description": "How a product works: the hero, a numbered timeline of steps with their visuals, then the details.",
+      "props": [
+        {
+          "name": "steps",
+          "type": "readonly HowStep[]",
+          "default": null,
+          "description": "The steps, in order.",
+          "required": true
+        },
+        {
+          "name": "stepsLabel",
+          "type": "string",
+          "default": null,
+          "description": "The steps' accessible name (`The steps`).",
+          "required": true
+        },
+        {
+          "name": "title",
+          "type": "ReactNode",
+          "default": null,
+          "description": "The page's `h1`.",
+          "required": true
+        },
+        {
+          "name": "aside",
+          "type": "ReactNode",
+          "default": null,
+          "description": "Beside the hero: the page's bird or an illustration.",
+          "required": false
+        },
+        {
+          "name": "back",
+          "type": "{ href: string; label: string; }",
+          "default": null,
+          "description": "The way back to the product.",
+          "required": false
+        },
+        {
+          "name": "brand",
+          "type": "string",
+          "default": null,
+          "description": "The brand the page wears (`.brand-<id>`).",
+          "required": false
+        },
+        {
+          "name": "closing",
+          "type": "{ title: ReactNode; body?: ReactNode; actions: ReactNode; }",
+          "default": null,
+          "description": "The closing call.",
+          "required": false
+        },
+        {
+          "name": "eyebrow",
+          "type": "ReactNode",
+          "default": null,
+          "description": "A mono line above the title.",
+          "required": false
+        },
+        {
+          "name": "lead",
+          "type": "ReactNode",
+          "default": null,
+          "description": "One or two sentences under it.",
+          "required": false
+        },
+        {
+          "name": "linkAs",
+          "type": "LinkComponent",
+          "default": null,
+          "description": "The app's link component (Next's `Link`).",
+          "required": false
+        }
+      ]
+    }
+  ]
+}

package/registry/image-cropper.json

@@ -198,7 +198,7 @@
     },
     {
       "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  | \"achievement\"\n  | \"action-bar\"\n  | \"alert\"\n  | \"app-shell\"\n  | \"argument-card\"\n  | \"audio-player\"\n  | \"auth-layout\"\n  | \"avatar\"\n  | \"badge\"\n  | \"button\"\n  | \"card\"\n  | \"card-grid\"\n  | \"checkbox\"\n  | \"chip\"\n  | \"chip-link\"\n  | \"choice-grid\"\n  | \"cn\"\n  | \"code-block\"\n  | \"combobox\"\n  | \"command\"\n  | \"confirm-button\"\n  | \"continue-prompt\"\n  | \"countdown\"\n  | \"cta-panel\"\n  | \"dashboard-layout\"\n  | \"data-table\"\n  | \"date-picker\"\n  | \"decision-list\"\n  | \"detail-layout\"\n  | \"dialog\"\n  | \"docs-layout\"\n  | \"dropdown-menu\"\n  | \"empty-state\"\n  | \"field\"\n  | \"file-upload\"\n  | \"filter-bar\"\n  | \"glow-card\"\n  | \"goal-gauge\"\n  | \"image-cropper\"\n  | \"iso\"\n  | \"kbd\"\n  | \"landscape\"\n  | \"link-card\"\n  | \"loader\"\n  | \"marketing-layout\"\n  | \"marquee\"\n  | \"mascot-quote\"\n  | \"mascot-state\"\n  | \"mascots\"\n  | \"media-capture\"\n  | \"meter\"\n  | \"nav-bar\"\n  | \"number-ticker\"\n  | \"page\"\n  | \"page-header\"\n  | \"page-hero\"\n  | \"pagination\"\n  | \"pointer-light\"\n  | \"popover\"\n  | \"profile-card\"\n  | \"progress\"\n  | \"promise-card\"\n  | \"radio-group\"\n  | \"scroll-stage\"\n  | \"search-field\"\n  | \"section-backdrop\"\n  | \"segmented\"\n  | \"separator\"\n  | \"settings-layout\"\n  | \"skeleton\"\n  | \"slider\"\n  | \"slot\"\n  | \"spinner\"\n  | \"split-view\"\n  | \"stage-banner\"\n  | \"stat\"\n  | \"stepper\"\n  | \"switch\"\n  | \"tabs\"\n  | \"tag-input\"\n  | \"terminal-replay\"\n  | \"theme\"\n  | \"toast\"\n  | \"toc\"\n  | \"tooltip\"\n  | \"txt\"\n  | \"video-player\"\n  | \"video-trimmer\";\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/**\n * The group of the catalogue. `media`: video, sound, camera, files, cropping. `blocks`: the page blocks — the frame,\n * the hero, sections, cards that lead or argue, decisions, code, calls to act — that every page of a site is made of.\n * `layouts`: the shells of whole screens — an application, a dashboard, settings, sign-in, an object, a list and its\n * item, a site's page, a documentation page — each with its templates.\n */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"media\" | \"blocks\" | \"layouts\" | \"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   * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its phone\n   * version thought out), copied as a starting point — at most 160 lines, listed on krizaka.com/docs/ui/templates.\n   */\n  readonly template?: boolean;\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  /**\n   * The entry to import from when it is not `@krizaka/ui/native`: a component that needs an Expo module (an optional\n   * peer) has its own, `@krizaka/ui/native/<name>`, so an app that does not use it never installs the module.\n   */\n  readonly entry?: string;\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"
+      "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  | \"achievement\"\n  | \"action-bar\"\n  | \"alert\"\n  | \"app-shell\"\n  | \"argument-card\"\n  | \"audio-player\"\n  | \"auth-layout\"\n  | \"avatar\"\n  | \"badge\"\n  | \"button\"\n  | \"card\"\n  | \"card-grid\"\n  | \"catalogue-page\"\n  | \"changelog-page\"\n  | \"checkbox\"\n  | \"chip\"\n  | \"chip-link\"\n  | \"choice-grid\"\n  | \"cn\"\n  | \"code-block\"\n  | \"combobox\"\n  | \"command\"\n  | \"component-page\"\n  | \"confirm-button\"\n  | \"contact-page\"\n  | \"continue-prompt\"\n  | \"countdown\"\n  | \"cta-panel\"\n  | \"dashboard-layout\"\n  | \"data-table\"\n  | \"date-picker\"\n  | \"decision-list\"\n  | \"detail-layout\"\n  | \"dialog\"\n  | \"docs-article-page\"\n  | \"docs-hub-page\"\n  | \"docs-layout\"\n  | \"dropdown-menu\"\n  | \"empty-state\"\n  | \"error-page\"\n  | \"field\"\n  | \"file-upload\"\n  | \"filter-bar\"\n  | \"gallery-page\"\n  | \"glow-card\"\n  | \"goal-gauge\"\n  | \"how-it-works-page\"\n  | \"image-cropper\"\n  | \"iso\"\n  | \"kbd\"\n  | \"landing-page\"\n  | \"landscape\"\n  | \"legal-page\"\n  | \"link-card\"\n  | \"list\"\n  | \"loader\"\n  | \"longform-page\"\n  | \"marketing-layout\"\n  | \"marquee\"\n  | \"mascot-quote\"\n  | \"mascot-state\"\n  | \"mascots\"\n  | \"media-capture\"\n  | \"meter\"\n  | \"nav-bar\"\n  | \"number-ticker\"\n  | \"page\"\n  | \"page-header\"\n  | \"page-hero\"\n  | \"pagination\"\n  | \"pointer-light\"\n  | \"popover\"\n  | \"pricing-page\"\n  | \"product-page\"\n  | \"profile-card\"\n  | \"progress\"\n  | \"promise-card\"\n  | \"radio-group\"\n  | \"scroll-stage\"\n  | \"search-field\"\n  | \"section-backdrop\"\n  | \"segmented\"\n  | \"separator\"\n  | \"settings-layout\"\n  | \"skeleton\"\n  | \"slider\"\n  | \"slot\"\n  | \"spinner\"\n  | \"split-view\"\n  | \"stage-banner\"\n  | \"stat\"\n  | \"status-page\"\n  | \"stepper\"\n  | \"switch\"\n  | \"tabs\"\n  | \"tag-input\"\n  | \"terminal-replay\"\n  | \"theme\"\n  | \"toast\"\n  | \"toc\"\n  | \"tooltip\"\n  | \"txt\"\n  | \"video-player\"\n  | \"video-trimmer\"\n  | \"virtual\";\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/**\n * The group of the catalogue. `media`: video, sound, camera, files, cropping. `blocks`: the page blocks — the frame,\n * the hero, sections, cards that lead or argue, decisions, code, calls to act — that every page of a site is made of.\n * `layouts`: the shells of whole screens — an application, a dashboard, settings, sign-in, an object, a list and its\n * item, a site's page, a documentation page — each with its screens. `templates`: the page templates — whole pages of a\n * site (a landing, a product, a docs hub, a long read, a changelog, pricing, status, an error…), each a distinct\n * composition of the blocks, words and content as props.\n */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"media\" | \"blocks\" | \"layouts\" | \"templates\" | \"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   * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its phone\n   * version thought out), copied as a starting point — at most 160 lines, listed on krizaka.com/docs/ui/templates.\n   */\n  readonly template?: boolean;\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  /**\n   * The entry to import from when it is not `@krizaka/ui/native`: a component that needs an Expo module (an optional\n   * peer) has its own, `@krizaka/ui/native/<name>`, so an app that does not use it never installs the module.\n   */\n  readonly entry?: string;\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"
     }
   ],
   "dependencies": [