@krizaka/ui 2.0.0-beta.5 → 2.0.0

package/registry/badge.json

@@ -1,7 +1,229 @@
 {
   "name": "badge",
   "type": "primitive",
-  "description": "`Badge`, `badgeVariants`. Server-safe.",
+  "title": "Badge",
+  "summary": "A short status or label: a tone, two sizes, an optional dot that can pulse.",
+  "description": "A short status or label: a tone, two sizes, an optional dot that can pulse.",
+  "status": "stable",
+  "category": "data-display",
+  "platforms": "both",
+  "whenToUse": [
+    "To label the state of an item: paid, pending, new, live, ending soon.",
+    "On a media (`tone=\"scrim\"`): a duration, a quality, a live marker.",
+    "With a `dot` (and `pulse`) for something happening now."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "For something the user can click or select.",
+      "use": "chip"
+    },
+    {
+      "when": "For a message the user must read.",
+      "use": "alert"
+    },
+    {
+      "when": "For a key figure with a trend.",
+      "use": "stat"
+    }
+  ],
+  "bestPractices": [
+    "One or two words: a badge is scanned, not read.",
+    "Keep the tone meaningful: `success`, `warning`, `danger` for states; `accent` to highlight; `neutral` otherwise.",
+    "`pulse` only for what is live: a page full of pulsing dots says nothing."
+  ],
+  "accessibility": {
+    "keyboard": [],
+    "notes": [
+      "A plain `<span>`: its text is read with the content around it; the dot is decorative.",
+      "The colour is never the only signal: the words say the state.",
+      "The pulse stops under `prefers-reduced-motion`."
+    ]
+  },
+  "related": [
+    "chip",
+    "stat",
+    "card"
+  ],
+  "web": {
+    "entry": "@krizaka/ui/badge",
+    "import": "import { Badge } from \"@krizaka/ui/badge\";",
+    "props": [
+      {
+        "component": "Badge",
+        "description": "",
+        "props": [
+          {
+            "name": "dot",
+            "type": "boolean",
+            "default": null,
+            "description": "A small dot before the text, in the tone's colour (pulsing with `pulse`).",
+            "required": false
+          },
+          {
+            "name": "pulse",
+            "type": "boolean",
+            "default": null,
+            "description": "Makes the `dot` pulse (stopped under reduced motion).",
+            "required": false
+          },
+          {
+            "name": "size",
+            "type": "\"sm\" | \"md\"",
+            "default": "sm",
+            "description": "sm · md.",
+            "required": false
+          },
+          {
+            "name": "tone",
+            "type": "\"success\" | \"warning\" | \"danger\" | \"neutral\" | \"accent\" | \"scrim\"",
+            "default": "neutral",
+            "description": "neutral · accent · success · warning · danger (soft tints, the text stays a text role) · scrim (on a media).",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "neutral",
+        "title": "Neutral",
+        "description": "The default tone.",
+        "path": "examples/badge/neutral.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/neutral",
+        "code": "import { Badge } from \"@krizaka/ui/badge\";\n\nexport default function BadgeNeutral() {\n  return <Badge>New</Badge>;\n}\n"
+      },
+      {
+        "name": "accent",
+        "title": "Accent",
+        "description": "To highlight: new, featured.",
+        "path": "examples/badge/accent.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/accent",
+        "code": "import { Badge } from \"@krizaka/ui/badge\";\n\nexport default function BadgeAccent() {\n  return (\n    <Badge tone=\"accent\" dot>\n      New\n    </Badge>\n  );\n}\n"
+      },
+      {
+        "name": "success",
+        "title": "Success",
+        "description": "A good state: paid, verified.",
+        "path": "examples/badge/success.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/success",
+        "code": "import { Badge } from \"@krizaka/ui/badge\";\n\nexport default function BadgeSuccess() {\n  return (\n    <Badge tone=\"success\" dot>\n      Paid\n    </Badge>\n  );\n}\n"
+      },
+      {
+        "name": "warning",
+        "title": "Warning",
+        "description": "A state that needs attention soon.",
+        "path": "examples/badge/warning.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/warning",
+        "code": "import { Badge } from \"@krizaka/ui/badge\";\n\nexport default function BadgeWarning() {\n  return (\n    <Badge tone=\"warning\" dot>\n      Pending\n    </Badge>\n  );\n}\n"
+      },
+      {
+        "name": "danger",
+        "title": "Danger with pulse",
+        "description": "Urgent, happening now: the dot pulses.",
+        "path": "examples/badge/danger.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/danger",
+        "code": "import { Badge } from \"@krizaka/ui/badge\";\n\nexport default function BadgeDanger() {\n  return (\n    <Badge tone=\"danger\" dot pulse>\n      Ends soon\n    </Badge>\n  );\n}\n"
+      },
+      {
+        "name": "scrim",
+        "title": "On a media",
+        "description": "`tone=\"scrim\"`: the veil and the text are identical in both themes.",
+        "path": "examples/badge/scrim.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/scrim",
+        "code": "import { Badge } from \"@krizaka/ui/badge\";\n\n// On a media: the veil and the text are invariant, identical in both themes.\nexport default function BadgeScrim() {\n  return (\n    <div className=\"flex h-24 w-40 items-start bg-media p-2.5\">\n      <Badge tone=\"scrim\">4K</Badge>\n    </div>\n  );\n}\n"
+      },
+      {
+        "name": "medium",
+        "title": "Medium",
+        "description": "`size=\"md\"` for a badge next to a heading.",
+        "path": "examples/badge/medium.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/medium",
+        "code": "import { Badge } from \"@krizaka/ui/badge\";\n\nexport default function BadgeMedium() {\n  return (\n    <Badge tone=\"accent\" size=\"md\">\n      Featured\n    </Badge>\n  );\n}\n"
+      }
+    ]
+  },
+  "native": {
+    "entry": "@krizaka/ui/native",
+    "import": "import { Badge } from \"@krizaka/ui/native\";",
+    "differences": [
+      "The text is set in capitals by the component.",
+      "No `className`: style it with `style`."
+    ],
+    "props": [
+      {
+        "component": "Badge",
+        "description": "A short status in capitals: a tone, a size, an optional (pulsing) dot.",
+        "props": [
+          {
+            "name": "dot",
+            "type": "boolean",
+            "default": null,
+            "description": "A small dot before the text, in the tone's colour.",
+            "required": false
+          },
+          {
+            "name": "pulse",
+            "type": "boolean",
+            "default": null,
+            "description": "The dot breathes (still when the system reduces motion).",
+            "required": false
+          },
+          {
+            "name": "size",
+            "type": "\"sm\" | \"md\"",
+            "default": "sm",
+            "description": "sm (default) · md.",
+            "required": false
+          },
+          {
+            "name": "tone",
+            "type": "BadgeTone",
+            "default": "neutral",
+            "description": "neutral (default) · accent · success · warning · danger · scrim (on a media).",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "tones",
+        "title": "Tones",
+        "description": "`neutral`, `accent`, `success`, `warning`, `danger`.",
+        "path": "examples/badge/native/tones.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/native/tones",
+        "code": "import { Badge } from \"@krizaka/ui/native\";\nimport { View } from \"react-native\";\n\nexport default function NativeBadgeTones() {\n  return (\n    <View style={{ flexDirection: \"row\", gap: 8 }}>\n      <Badge tone=\"neutral\">Live</Badge>\n      <Badge tone=\"accent\">Live</Badge>\n      <Badge tone=\"success\">Live</Badge>\n      <Badge tone=\"warning\">Live</Badge>\n      <Badge tone=\"danger\">Live</Badge>\n    </View>\n  );\n}\n",
+        "screenshots": {
+          "dark": "examples/badge/native/tones.dark.png",
+          "light": "examples/badge/native/tones.light.png"
+        }
+      },
+      {
+        "name": "dot",
+        "title": "Dot",
+        "description": "`sm` and `md`, with a pulsing dot.",
+        "path": "examples/badge/native/dot.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/native/dot",
+        "code": "import { Badge } from \"@krizaka/ui/native\";\nimport { View } from \"react-native\";\n\n// `pulse` stops under reduced motion.\nexport default function NativeBadgeDot() {\n  return (\n    <View style={{ flexDirection: \"row\", gap: 8 }}>\n      <Badge tone=\"danger\" dot pulse>\n        Live\n      </Badge>\n      <Badge tone=\"danger\" size=\"md\" dot pulse>\n        Live\n      </Badge>\n    </View>\n  );\n}\n",
+        "screenshots": {
+          "dark": "examples/badge/native/dot.dark.png",
+          "light": "examples/badge/native/dot.light.png"
+        }
+      },
+      {
+        "name": "scrim",
+        "title": "On a media",
+        "description": "`scrim`: identical in both themes.",
+        "path": "examples/badge/native/scrim.tsx",
+        "module": "@krizaka/ui/registry/examples/badge/native/scrim",
+        "code": "import { Badge, useTheme } from \"@krizaka/ui/native\";\nimport { View } from \"react-native\";\n\n// `scrim`: on a media, identical in both themes.\nexport default function NativeBadgeScrim() {\n  const { theme } = useTheme();\n  return (\n    <View style={{ backgroundColor: theme.media, padding: 24, borderRadius: 12 }}>\n      <Badge tone=\"scrim\" dot>\n        Ending soon\n      </Badge>\n    </View>\n  );\n}\n",
+        "screenshots": {
+          "dark": "examples/badge/native/scrim.dark.png",
+          "light": "examples/badge/native/scrim.light.png"
+        }
+      }
+    ]
+  },
   "files": [
     {
       "path": "badge/badge.tsx",
@@ -10,6 +232,14 @@
     {
       "path": "badge/index.ts",
       "content": "/** @krizaka/ui/badge — `Badge`, `badgeVariants`. Server-safe. */\nexport { Badge, type BadgeProps, type BadgeVariants, badgeVariants } from \"./badge\";\n"
+    },
+    {
+      "path": "badge/meta.ts",
+      "content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n  title: \"Badge\",\n  summary: \"A short status or label: a tone, two sizes, an optional dot that can pulse.\",\n  status: \"stable\",\n  category: \"data-display\",\n  platforms: \"both\",\n  whenToUse: [\n    \"To label the state of an item: paid, pending, new, live, ending soon.\",\n    \"On a media (`tone=\\\"scrim\\\"`): a duration, a quality, a live marker.\",\n    \"With a `dot` (and `pulse`) for something happening now.\",\n  ],\n  whenNotToUse: [\n    { when: \"For something the user can click or select.\", use: \"chip\" },\n    { when: \"For a message the user must read.\", use: \"alert\" },\n    { when: \"For a key figure with a trend.\", use: \"stat\" },\n  ],\n  bestPractices: [\n    \"One or two words: a badge is scanned, not read.\",\n    \"Keep the tone meaningful: `success`, `warning`, `danger` for states; `accent` to highlight; `neutral` otherwise.\",\n    \"`pulse` only for what is live: a page full of pulsing dots says nothing.\",\n  ],\n  accessibility: {\n    keyboard: [],\n    notes: [\n      \"A plain `<span>`: its text is read with the content around it; the dot is decorative.\",\n      \"The colour is never the only signal: the words say the state.\",\n      \"The pulse stops under `prefers-reduced-motion`.\",\n    ],\n  },\n  related: [\"chip\", \"stat\", \"card\"],\n  web: {\n    imports: [\"Badge\"],\n    examples: [\n      { name: \"neutral\", title: \"Neutral\", description: \"The default tone.\" },\n      { name: \"accent\", title: \"Accent\", description: \"To highlight: new, featured.\" },\n      { name: \"success\", title: \"Success\", description: \"A good state: paid, verified.\" },\n      { name: \"warning\", title: \"Warning\", description: \"A state that needs attention soon.\" },\n      { name: \"danger\", title: \"Danger with pulse\", description: \"Urgent, happening now: the dot pulses.\" },\n      { name: \"scrim\", title: \"On a media\", description: \"`tone=\\\"scrim\\\"`: the veil and the text are identical in both themes.\" },\n      { name: \"medium\", title: \"Medium\", description: \"`size=\\\"md\\\"` for a badge next to a heading.\" },\n    ],\n  },\n  native: {\n    imports: [\"Badge\"],\n    differences: [\"The text is set in capitals by the component.\", \"No `className`: style it with `style`.\"],\n    examples: [\n      { name: \"tones\", title: \"Tones\", description: \"`neutral`, `accent`, `success`, `warning`, `danger`.\" },\n      { name: \"dot\", title: \"Dot\", description: \"`sm` and `md`, with a pulsing dot.\" },\n      { name: \"scrim\", title: \"On a media\", description: \"`scrim`: identical in both themes.\" },\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  | \"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"
     }
   ],
   "dependencies": [
@@ -17,8 +247,8 @@
   ],
   "registryDependencies": [],
   "demo": {
-    "path": "demos/badge.tsx",
-    "content": "import { Badge } from \"@krizaka/ui/badge\";\n\nexport default function BadgeDemo() {\n  return <Badge>New</Badge>;\n}\n"
+    "path": "examples/badge/neutral.tsx",
+    "content": "import { Badge } from \"@krizaka/ui/badge\";\n\nexport default function BadgeNeutral() {\n  return <Badge>New</Badge>;\n}\n"
   },
   "props": [
     {