@krizaka/ui 2.0.0-beta.5 → 2.0.0

package/registry/field.json

@@ -1,15 +1,153 @@
 {
   "name": "field",
   "type": "primitive",
-  "description": "`Field.Root/Label/Hint/Error`, `Input`, `Textarea`, `Select`. Server-safe.",
+  "title": "Field",
+  "summary": "A form field: a label, a hint and an error around an `Input`, a `Textarea` or a native `Select`.",
+  "description": "A form field: a label, a hint and an error around an `Input`, a `Textarea` or a native `Select`.",
+  "status": "stable",
+  "category": "forms",
+  "platforms": "web",
+  "whenToUse": [
+    "For every text entry of a form: email, title, description, amount.",
+    "`Select` for a choice among many options (a country): the platform's own menu, right on phones."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "To turn a setting on or off.",
+      "use": "switch"
+    },
+    {
+      "when": "To choose among two to five options that should all be visible.",
+      "use": "radio-group"
+    },
+    {
+      "when": "To pick a number in a range by feel.",
+      "use": "slider"
+    }
+  ],
+  "bestPractices": [
+    "Always a visible `Field.Label`: a placeholder is an example, never the label.",
+    "Put the hint before the error is possible (“We never share it”), the error after it is: what is wrong and how to fix it.",
+    "Use the right `type` (`email`, `url`, `number`) and `autoComplete`: phones show the right keyboard."
+  ],
+  "accessibility": {
+    "keyboard": [],
+    "notes": [
+      "Plain HTML wiring: `Field.Label htmlFor` = the control's `id`; hint and error ids in `aria-describedby`.",
+      "`invalid` sets `aria-invalid` and `data-invalid` on the control.",
+      "A disabled control is skipped by Tab: if the value matters, prefer `readOnly`."
+    ]
+  },
+  "related": [
+    "checkbox",
+    "switch",
+    "radio-group",
+    "slider"
+  ],
+  "web": {
+    "entry": "@krizaka/ui/field",
+    "import": "import { Field, Input, Textarea, Select } from \"@krizaka/ui/field\";",
+    "props": [
+      {
+        "component": "Input",
+        "description": "",
+        "props": [
+          {
+            "name": "invalid",
+            "type": "boolean",
+            "default": null,
+            "description": "Marks the control invalid: aria-invalid and data-invalid (pair it with a `Field.Error` in aria-describedby).",
+            "required": false
+          }
+        ]
+      },
+      {
+        "component": "Select",
+        "description": "A native <select>, styled like the other controls (the platform's menu: accessible and right on phones).",
+        "props": [
+          {
+            "name": "invalid",
+            "type": "boolean",
+            "default": null,
+            "description": "Marks the control invalid: aria-invalid and data-invalid (pair it with a `Field.Error` in aria-describedby).",
+            "required": false
+          }
+        ]
+      },
+      {
+        "component": "Textarea",
+        "description": "",
+        "props": [
+          {
+            "name": "invalid",
+            "type": "boolean",
+            "default": null,
+            "description": "Marks the control invalid: aria-invalid and data-invalid (pair it with a `Field.Error` in aria-describedby).",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "default",
+        "title": "Default",
+        "description": "A label, an input and a hint.",
+        "path": "examples/field/default.tsx",
+        "module": "@krizaka/ui/registry/examples/field/default",
+        "code": "import { Field, Input } from \"@krizaka/ui/field\";\n\nexport default function FieldDefault() {\n  return (\n    <Field.Root>\n      <Field.Label htmlFor=\"email\">Email</Field.Label>\n      <Input id=\"email\" type=\"email\" aria-describedby=\"email-hint\" placeholder=\"you@example.com\" />\n      <Field.Hint id=\"email-hint\">We never share it.</Field.Hint>\n    </Field.Root>\n  );\n}\n"
+      },
+      {
+        "name": "invalid",
+        "title": "Invalid",
+        "description": "`invalid` and its error, read through `aria-describedby`.",
+        "path": "examples/field/invalid.tsx",
+        "module": "@krizaka/ui/registry/examples/field/invalid",
+        "code": "import { Field, Input } from \"@krizaka/ui/field\";\n\n// `invalid` sets `aria-invalid` and `data-invalid`; the error is read through `aria-describedby`.\nexport default function FieldInvalid() {\n  return (\n    <Field.Root>\n      <Field.Label htmlFor=\"email-invalid\">Email</Field.Label>\n      <Input id=\"email-invalid\" type=\"email\" invalid defaultValue=\"you@\" aria-describedby=\"email-error\" />\n      <Field.Error id=\"email-error\">Enter a complete address.</Field.Error>\n    </Field.Root>\n  );\n}\n"
+      },
+      {
+        "name": "disabled",
+        "title": "Disabled",
+        "description": "Not editable.",
+        "path": "examples/field/disabled.tsx",
+        "module": "@krizaka/ui/registry/examples/field/disabled",
+        "code": "import { Field, Input } from \"@krizaka/ui/field\";\n\nexport default function FieldDisabled() {\n  return (\n    <Field.Root>\n      <Field.Label htmlFor=\"email-disabled\">Email</Field.Label>\n      <Input id=\"email-disabled\" disabled defaultValue=\"you@example.com\" />\n    </Field.Root>\n  );\n}\n"
+      },
+      {
+        "name": "textarea",
+        "title": "Textarea",
+        "description": "A longer text.",
+        "path": "examples/field/textarea.tsx",
+        "module": "@krizaka/ui/registry/examples/field/textarea",
+        "code": "import { Field, Textarea } from \"@krizaka/ui/field\";\n\nexport default function FieldTextarea() {\n  return (\n    <Field.Root>\n      <Field.Label htmlFor=\"bio\">Bio</Field.Label>\n      <Textarea id=\"bio\" placeholder=\"A few words about you\" />\n    </Field.Root>\n  );\n}\n"
+      },
+      {
+        "name": "select",
+        "title": "Select",
+        "description": "A native select.",
+        "path": "examples/field/select.tsx",
+        "module": "@krizaka/ui/registry/examples/field/select",
+        "code": "import { Field, Select } from \"@krizaka/ui/field\";\n\n// A native select: the platform's menu, accessible and right on phones.\nexport default function FieldSelect() {\n  return (\n    <Field.Root>\n      <Field.Label htmlFor=\"country\">Country</Field.Label>\n      <Select id=\"country\" defaultValue=\"fr\">\n        <option value=\"fr\">France</option>\n        <option value=\"tn\">Tunisia</option>\n        <option value=\"ca\">Canada</option>\n      </Select>\n    </Field.Root>\n  );\n}\n"
+      }
+    ]
+  },
+  "native": null,
   "files": [
     {
       "path": "field/field.tsx",
-      "content": "// Server-safe. The label ↔ control wiring is HTML (htmlFor / id, aria-describedby): no context.\nimport type * as React from \"react\";\nimport { tv } from \"tailwind-variants\";\n\nimport { cn } from \"../cn\";\n\nexport const field = tv({\n  slots: {\n    root: \"flex flex-col gap-1.5\",\n    label: \"text-xs font-semibold text-fg-secondary\",\n    control:\n      \"flex h-11 w-full rounded-lg border border-border-default bg-surface-2 px-3 text-sm text-fg placeholder:text-fg-muted \" +\n      \"transition-[border-color,box-shadow] focus-visible:border-accent focus-visible:outline-hidden focus-visible:ring-2 focus-visible:ring-ring \" +\n      \"disabled:cursor-not-allowed disabled:opacity-50 aria-invalid:border-danger aria-invalid:ring-danger/30\",\n    hint: \"text-xs text-fg-secondary\",\n    // The danger token is too light for small text on a light surface: the message is a text role, the dot says danger.\n    error: \"flex items-center gap-1.5 text-xs font-medium text-fg before:h-1.5 before:w-1.5 before:shrink-0 before:rounded-full before:bg-danger\",\n    selectWrap: \"relative flex w-full\",\n    chevron: \"pointer-events-none absolute right-3 top-1/2 h-4 w-4 -translate-y-1/2 text-fg-secondary\",\n  },\n});\nconst s = field();\n\nexport const Field = {\n  Root: ({ className, ...props }: React.ComponentProps<\"div\">) => <div className={s.root({ className })} {...props} />,\n  Label: ({ className, ...props }: React.ComponentProps<\"label\">) => <label className={s.label({ className })} {...props} />,\n  Hint: ({ className, ...props }: React.ComponentProps<\"p\">) => <p className={s.hint({ className })} {...props} />,\n  Error: ({ className, ...props }: React.ComponentProps<\"p\">) => <p role=\"alert\" className={s.error({ className })} {...props} />,\n};\n\ntype ControlProps = {\n  /** Marks the control invalid: aria-invalid and data-invalid (pair it with a `Field.Error` in aria-describedby). */\n  invalid?: boolean;\n};\n\nconst invalidProps = (invalid?: boolean) => (invalid ? { \"aria-invalid\": true as const, \"data-invalid\": \"\" } : {});\n\nexport function Input({ invalid, className, ...props }: React.ComponentProps<\"input\"> & ControlProps) {\n  return <input {...invalidProps(invalid)} className={s.control({ className })} {...props} />;\n}\n\nexport function Textarea({ invalid, className, ...props }: React.ComponentProps<\"textarea\"> & ControlProps) {\n  return <textarea {...invalidProps(invalid)} className={s.control({ className: cn(\"h-auto min-h-24 py-2\", className) })} {...props} />;\n}\n\n/** A native <select>, styled like the other controls (the platform's menu: accessible and right on phones). */\nexport function Select({ invalid, className, ...props }: React.ComponentProps<\"select\"> & ControlProps) {\n  return (\n    <span className={s.selectWrap()}>\n      <select {...invalidProps(invalid)} className={s.control({ className: cn(\"appearance-none pr-9\", className) })} {...props} />\n      <svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" strokeWidth=\"2\" strokeLinecap=\"round\" strokeLinejoin=\"round\" aria-hidden className={s.chevron()}>\n        <path d=\"m6 9 6 6 6-6\" />\n      </svg>\n    </span>\n  );\n}\n"
+      "content": "// Server-safe. The label ↔ control wiring is HTML (htmlFor / id, aria-describedby): no context.\nimport type * as React from \"react\";\nimport { tv } from \"tailwind-variants\";\n\nimport { cn } from \"../cn\";\n\nexport const field = tv({\n  slots: {\n    root: \"flex flex-col gap-1.5\",\n    label: \"text-xs font-semibold text-fg-secondary\",\n    control:\n      \"flex h-11 w-full rounded-lg border border-border-default bg-surface-2 px-3 text-sm text-fg placeholder:text-fg-muted \" +\n      \"transition-[border-color,box-shadow] focus-visible:border-accent focus-visible:outline-hidden focus-visible:ring-2 focus-visible:ring-ring \" +\n      \"disabled:cursor-not-allowed disabled:opacity-50 aria-invalid:border-danger aria-invalid:ring-danger/30\",\n    hint: \"text-xs text-fg-secondary\",\n    // The message reads in the danger text role (≥ 4.5:1 on every surface, both themes); the dot is the danger fill.\n    error: \"flex items-center gap-1.5 text-xs font-medium text-fg-danger before:h-1.5 before:w-1.5 before:shrink-0 before:rounded-full before:bg-danger\",\n    selectWrap: \"relative flex w-full\",\n    chevron: \"pointer-events-none absolute right-3 top-1/2 h-4 w-4 -translate-y-1/2 text-fg-secondary\",\n  },\n});\nconst s = field();\n\nexport const Field = {\n  Root: ({ className, ...props }: React.ComponentProps<\"div\">) => <div className={s.root({ className })} {...props} />,\n  Label: ({ className, ...props }: React.ComponentProps<\"label\">) => <label className={s.label({ className })} {...props} />,\n  Hint: ({ className, ...props }: React.ComponentProps<\"p\">) => <p className={s.hint({ className })} {...props} />,\n  Error: ({ className, ...props }: React.ComponentProps<\"p\">) => <p role=\"alert\" className={s.error({ className })} {...props} />,\n};\n\ntype ControlProps = {\n  /** Marks the control invalid: aria-invalid and data-invalid (pair it with a `Field.Error` in aria-describedby). */\n  invalid?: boolean;\n};\n\nconst invalidProps = (invalid?: boolean) => (invalid ? { \"aria-invalid\": true as const, \"data-invalid\": \"\" } : {});\n\nexport function Input({ invalid, className, ...props }: React.ComponentProps<\"input\"> & ControlProps) {\n  return <input {...invalidProps(invalid)} className={s.control({ className })} {...props} />;\n}\n\nexport function Textarea({ invalid, className, ...props }: React.ComponentProps<\"textarea\"> & ControlProps) {\n  return <textarea {...invalidProps(invalid)} className={s.control({ className: cn(\"h-auto min-h-24 py-2\", className) })} {...props} />;\n}\n\n/** A native <select>, styled like the other controls (the platform's menu: accessible and right on phones). */\nexport function Select({ invalid, className, ...props }: React.ComponentProps<\"select\"> & ControlProps) {\n  return (\n    <span className={s.selectWrap()}>\n      <select {...invalidProps(invalid)} className={s.control({ className: cn(\"appearance-none pr-9\", className) })} {...props} />\n      <svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" strokeWidth=\"2\" strokeLinecap=\"round\" strokeLinejoin=\"round\" aria-hidden className={s.chevron()}>\n        <path d=\"m6 9 6 6 6-6\" />\n      </svg>\n    </span>\n  );\n}\n"
     },
     {
       "path": "field/index.ts",
       "content": "/** @krizaka/ui/field — `Field.Root/Label/Hint/Error`, `Input`, `Textarea`, `Select`. Server-safe. */\nexport { Field, field, Input, Select, Textarea } from \"./field\";\n"
+    },
+    {
+      "path": "field/meta.ts",
+      "content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n  title: \"Field\",\n  summary: \"A form field: a label, a hint and an error around an `Input`, a `Textarea` or a native `Select`.\",\n  status: \"stable\",\n  category: \"forms\",\n  platforms: \"web\",\n  whenToUse: [\n    \"For every text entry of a form: email, title, description, amount.\",\n    \"`Select` for a choice among many options (a country): the platform's own menu, right on phones.\",\n  ],\n  whenNotToUse: [\n    { when: \"To turn a setting on or off.\", use: \"switch\" },\n    { when: \"To choose among two to five options that should all be visible.\", use: \"radio-group\" },\n    { when: \"To pick a number in a range by feel.\", use: \"slider\" },\n  ],\n  bestPractices: [\n    \"Always a visible `Field.Label`: a placeholder is an example, never the label.\",\n    \"Put the hint before the error is possible (“We never share it”), the error after it is: what is wrong and how to fix it.\",\n    \"Use the right `type` (`email`, `url`, `number`) and `autoComplete`: phones show the right keyboard.\",\n  ],\n  accessibility: {\n    keyboard: [],\n    notes: [\n      \"Plain HTML wiring: `Field.Label htmlFor` = the control's `id`; hint and error ids in `aria-describedby`.\",\n      \"`invalid` sets `aria-invalid` and `data-invalid` on the control.\",\n      \"A disabled control is skipped by Tab: if the value matters, prefer `readOnly`.\",\n    ],\n  },\n  related: [\"checkbox\", \"switch\", \"radio-group\", \"slider\"],\n  web: {\n    imports: [\"Field\", \"Input\", \"Textarea\", \"Select\"],\n    examples: [\n      { name: \"default\", title: \"Default\", description: \"A label, an input and a hint.\" },\n      { name: \"invalid\", title: \"Invalid\", description: \"`invalid` and its error, read through `aria-describedby`.\" },\n      { name: \"disabled\", title: \"Disabled\", description: \"Not editable.\" },\n      { name: \"textarea\", title: \"Textarea\", description: \"A longer text.\" },\n      { name: \"select\", title: \"Select\", description: \"A native select.\" },\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": [
@@ -19,8 +157,8 @@
     "cn"
   ],
   "demo": {
-    "path": "demos/field.tsx",
-    "content": "import { Field, Input } from \"@krizaka/ui/field\";\n\nexport default function FieldDemo() {\n  return (\n    <Field.Root>\n      <Field.Label htmlFor=\"email\">Email</Field.Label>\n      <Input id=\"email\" type=\"email\" aria-describedby=\"email-hint\" placeholder=\"you@example.com\" />\n      <Field.Hint id=\"email-hint\">We never share it.</Field.Hint>\n    </Field.Root>\n  );\n}\n"
+    "path": "examples/field/default.tsx",
+    "content": "import { Field, Input } from \"@krizaka/ui/field\";\n\nexport default function FieldDefault() {\n  return (\n    <Field.Root>\n      <Field.Label htmlFor=\"email\">Email</Field.Label>\n      <Input id=\"email\" type=\"email\" aria-describedby=\"email-hint\" placeholder=\"you@example.com\" />\n      <Field.Hint id=\"email-hint\">We never share it.</Field.Hint>\n    </Field.Root>\n  );\n}\n"
   },
   "props": [
     {