@karimsa/mdxserve 0.0.0-stage → 0.2.0

package/dist/registry.json

@@ -0,0 +1,703 @@
+{
+  "version": 1,
+  "components": [
+    {
+      "name": "Callout",
+      "description": "A boxed aside with an icon, used to draw attention to a note or warning inline with the text.",
+      "whenToUse": "Use to highlight a tip, note, or warning that should stand out from surrounding prose. Prefer `tone=\"warn\"` for caveats or risks, `tone=\"danger\"` for breaking changes, `tone=\"tip\"` or `tone=\"ok\"` for positive asides, and the default `tone=\"note\"` for general notes; add `title` when the callout needs a short heading. (`type` is a deprecated alias for `tone`.)",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "tone": {
+            "default": "note",
+            "description": "Visual intent and icon: note (info), tip (lightbulb), ok (success), warn (caution), or danger (breaking).",
+            "type": "string",
+            "enum": [
+              "note",
+              "tip",
+              "ok",
+              "warn",
+              "danger"
+            ]
+          },
+          "type": {
+            "description": "Deprecated alias for `tone` (info→note, warn→warn). Prefer `tone`.",
+            "type": "string",
+            "enum": [
+              "info",
+              "warn"
+            ]
+          },
+          "title": {
+            "description": "Optional bold heading shown above the body; defaults to the tone's label.",
+            "type": "string"
+          }
+        }
+      },
+      "children": "Callout body; any MDX/Markdown content."
+    },
+    {
+      "name": "Button",
+      "description": "A clickable button or link with primary/secondary/ghost/danger styles and a small tap animation.",
+      "whenToUse": "Use for a call to action inside MDX/JSX content — a link styled as a button (`href`) or an interactive action (`onClick`, JSX only). Prefer `variant=\"primary\"` for the main action on a page, `secondary` or `ghost` for less prominent actions, and `danger` for destructive ones. `icon`/`iconRight` take a lucide icon name.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "variant": {
+            "default": "primary",
+            "description": "Visual style: primary (filled teal), secondary (outlined), ghost (text-only), or danger (outlined, danger tone).",
+            "type": "string",
+            "enum": [
+              "primary",
+              "secondary",
+              "ghost",
+              "danger"
+            ]
+          },
+          "size": {
+            "default": "md",
+            "description": "Height/padding/text size.",
+            "type": "string",
+            "enum": [
+              "sm",
+              "md",
+              "lg"
+            ]
+          },
+          "icon": {
+            "description": "Lucide icon name rendered before the label.",
+            "type": "string"
+          },
+          "iconRight": {
+            "description": "Lucide icon name rendered after the label.",
+            "type": "string"
+          },
+          "href": {
+            "description": "If set, renders as a link (`<a>`) instead of a `<button>`.",
+            "type": "string"
+          },
+          "onClick": {
+            "description": "Click handler (MDX/JSX only)."
+          },
+          "disabled": {
+            "default": false,
+            "description": "Disables the button and dims it.",
+            "type": "boolean"
+          },
+          "autoFocus": {
+            "description": "Focus the button on mount.",
+            "type": "boolean"
+          }
+        }
+      },
+      "children": "Button label/content."
+    },
+    {
+      "name": "Tooltip",
+      "description": "Wraps inline content in a hover/focus tooltip (via tippy.js) that shows a short bit of text.",
+      "whenToUse": "Use to add a short explanation to a word, phrase, or another inline component (e.g. a `Badge`) without cluttering the surrounding prose. Keep `content` brief — it's not meant for long-form text.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "content": {
+            "type": "string",
+            "description": "Tooltip text shown on hover/focus."
+          },
+          "placement": {
+            "default": "top",
+            "description": "Preferred side of the target.",
+            "type": "string",
+            "enum": [
+              "top",
+              "bottom",
+              "left",
+              "right"
+            ]
+          },
+          "delay": {
+            "default": 100,
+            "description": "Delay in milliseconds before the tooltip appears.",
+            "type": "number"
+          }
+        },
+        "required": [
+          "content"
+        ]
+      },
+      "children": "The element the tooltip is attached to."
+    },
+    {
+      "name": "Tabs",
+      "description": "A tabbed container that switches between panels of content, each declared with a `Tab` child.",
+      "whenToUse": "Use to present a few alternative or sequential views of content (e.g. per-language code samples, per-OS instructions) without showing them all at once. Each direct child should be a `Tab` with a `label`; the panel content cross-fades and the underline animates between tabs.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "defaultValue": {
+            "description": "Value of the tab selected initially; defaults to the first tab.",
+            "type": "string"
+          }
+        }
+      },
+      "children": "One or more `<Tab>` elements."
+    },
+    {
+      "name": "Tab",
+      "description": "A single labeled panel within a `Tabs` container.",
+      "whenToUse": "Only as a direct child of `<Tabs>`. `label` is required; `value` defaults to a slug of `label`.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "label": {
+            "type": "string",
+            "description": "Tab label shown in the tab list."
+          },
+          "value": {
+            "description": "Stable identifier for this tab; defaults to a slug of `label`.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "label"
+        ]
+      },
+      "children": "Tab panel content; any MDX/Markdown content."
+    },
+    {
+      "name": "Badge",
+      "description": "A small inline pill for a status, tag, or label, with tone/variant/dot options.",
+      "whenToUse": "Use inline with text (or inside a table cell) to call out a short status or category, e.g. a version, state, or tag. Prefer `variant=\"soft\"` (the default) for most uses; `solid` for emphasis, `outline` for a quieter look; set `dot` for a status indicator. Tones: `neutral`, `teal`, `info`, `ok`, `warn`, `danger`, `note`. (`color` is a deprecated alias for `tone`.)",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "tone": {
+            "default": "neutral",
+            "description": "Tone of the badge.",
+            "type": "string",
+            "enum": [
+              "neutral",
+              "teal",
+              "info",
+              "ok",
+              "warn",
+              "danger",
+              "note"
+            ]
+          },
+          "color": {
+            "description": "Deprecated alias for `tone` (gray→neutral, sky→info, green→ok, amber→warn, red→danger, violet→note). Prefer `tone`.",
+            "type": "string",
+            "enum": [
+              "gray",
+              "sky",
+              "green",
+              "amber",
+              "red",
+              "violet"
+            ]
+          },
+          "variant": {
+            "default": "soft",
+            "description": "Fill style.",
+            "type": "string",
+            "enum": [
+              "soft",
+              "solid",
+              "outline"
+            ]
+          },
+          "dot": {
+            "default": false,
+            "description": "Show a leading status dot.",
+            "type": "boolean"
+          }
+        }
+      },
+      "children": "Badge label."
+    },
+    {
+      "name": "Diff",
+      "description": "Renders the difference between two code snippets with GitHub-style unified or side-by-side views.",
+      "whenToUse": "Use for before/after API changes, config migrations, or 'change this to that' instructions. Prefer a plain fence when only showing the final code.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "before": {
+            "type": "string",
+            "description": "Original text."
+          },
+          "after": {
+            "type": "string",
+            "description": "New text."
+          },
+          "language": {
+            "description": "Label only, shown in the header when `title` isn't set. Shown as a label; the diff is colored by change, not by syntax — Shiki runs at build time for fenced code blocks, not for runtime strings passed to this component.",
+            "type": "string"
+          },
+          "title": {
+            "description": "Filename or heading shown in the header; takes precedence over `language`.",
+            "type": "string"
+          },
+          "view": {
+            "default": "unified",
+            "description": "Initial view.",
+            "type": "string",
+            "enum": [
+              "unified",
+              "split"
+            ]
+          },
+          "context": {
+            "default": 3,
+            "description": "Unchanged lines kept around each change; longer unchanged runs collapse into an expandable separator.",
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 9007199254740991
+          }
+        },
+        "required": [
+          "before",
+          "after"
+        ]
+      }
+    },
+    {
+      "name": "Card",
+      "description": "A bordered content card with an optional icon, title, description, and meta line.",
+      "whenToUse": "Use for a link or highlighted block that needs more visual weight than a plain link — a related page, an external resource, a next step. Set `href` (or `interactive`) to enable the hover lift and trailing arrow. Group several inside `CardGrid` for a responsive layout.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "title": {
+            "description": "Card heading.",
+            "type": "string"
+          },
+          "description": {
+            "description": "One-sentence body text below the title.",
+            "type": "string"
+          },
+          "icon": {
+            "description": "Lucide icon name shown above the title.",
+            "type": "string"
+          },
+          "meta": {
+            "description": "Small uppercase mono line at the bottom, e.g. \"3 pages\".",
+            "type": "string"
+          },
+          "href": {
+            "description": "Renders the card as a link and enables the hover lift.",
+            "type": "string"
+          },
+          "interactive": {
+            "default": false,
+            "description": "Enables the hover lift without a link.",
+            "type": "boolean"
+          }
+        }
+      },
+      "children": "Extra content rendered below the description/meta."
+    },
+    {
+      "name": "CardGrid",
+      "description": "A responsive 2- or 3-column grid for laying out `Card` elements.",
+      "whenToUse": "Wrap 2 or more `Card` elements to lay them out side by side; set `columns=\"3\"` for a wider grid.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "columns": {
+            "default": "2",
+            "description": "Maximum columns at the widest breakpoint; fewer on narrower screens.",
+            "type": "string",
+            "enum": [
+              "2",
+              "3"
+            ]
+          }
+        }
+      },
+      "children": "One or more `<Card>` elements."
+    },
+    {
+      "name": "Kbd",
+      "description": "A small styled key cap for keyboard shortcuts.",
+      "whenToUse": "Use inline for a literal keystroke, e.g. `<Kbd>⌘</Kbd><Kbd>K</Kbd>`. Not for regular inline code — use a backtick fence for that.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {}
+      },
+      "children": "Key label, e.g. a letter, `esc`, or a unicode symbol such as `⌘`."
+    },
+    {
+      "name": "FileTree",
+      "description": "A collapsible file/folder tree, for showing a project layout.",
+      "whenToUse": "Use to show the shape of a directory a reader needs to navigate, e.g. 'here's what the generated project looks like'. Pass `nodes` as a plain JSON array of `{ name, path?, children?, open? }`; set `activePath` to highlight one row.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "nodes": {
+            "default": [],
+            "description": "Tree of files/folders to render.",
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/__schema0"
+            }
+          },
+          "activePath": {
+            "description": "`path` of the row to highlight as active.",
+            "type": "string"
+          }
+        },
+        "$defs": {
+          "__schema0": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "File or folder name shown in the row."
+              },
+              "path": {
+                "description": "Route/identifier used to match `activePath`.",
+                "type": "string"
+              },
+              "children": {
+                "description": "Child nodes; presence makes this row a folder.",
+                "type": "array",
+                "items": {
+                  "$ref": "#/$defs/__schema0"
+                }
+              },
+              "open": {
+                "description": "Folder starts expanded unless this is `false`.",
+                "type": "boolean"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          }
+        }
+      }
+    },
+    {
+      "name": "Chart",
+      "description": "A bar, line, area or histogram chart rendered as inline SVG, framed like a code block.",
+      "whenToUse": "For bar, line and area: `data` is `[{ label, <series>: number }, ...]`; `series` lists which keys to plot (defaults to `[\"value\"]`), for small, self-contained datasets (four series or fewer) that are clearer as a shape than a table. Set `orientation=\"horizontal\"` on a bar chart when labels are long or there are more than ~6 categories. For a histogram, set `type=\"histogram\"` and pass raw numbers as `values`; leave `data`/`series` off and optionally cap the bin count with `bins`. Prefer a table once there's more data than a chart can read at a glance.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "type": {
+            "default": "bar",
+            "description": "Chart shape. `histogram` bins `values` on the client and ignores `data`/`series`.",
+            "type": "string",
+            "enum": [
+              "bar",
+              "line",
+              "area",
+              "histogram"
+            ]
+          },
+          "orientation": {
+            "default": "vertical",
+            "description": "Bar layout direction; ignored for `line`/`area`/`histogram`. Readers can flip it from the chart header for their own view only.",
+            "type": "string",
+            "enum": [
+              "vertical",
+              "horizontal"
+            ]
+          },
+          "data": {
+            "default": [],
+            "description": "One object per x position: `{ label, <series>: number }`.",
+            "type": "array",
+            "items": {
+              "allOf": [
+                {
+                  "type": "object",
+                  "propertyNames": {
+                    "type": "string"
+                  },
+                  "additionalProperties": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "number"
+                      }
+                    ]
+                  }
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "label": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "label"
+                  ]
+                }
+              ]
+            }
+          },
+          "series": {
+            "description": "Keys of `data` entries to plot. Defaults to `[\"value\"]`.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "values": {
+            "default": [],
+            "description": "Raw numbers to bin for `type=\"histogram\"`; ignored otherwise.",
+            "type": "array",
+            "items": {
+              "type": "number"
+            }
+          },
+          "bins": {
+            "description": "Histogram bin count. Defaults to a Sturges estimate, capped at 20.",
+            "type": "integer",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991
+          },
+          "height": {
+            "default": 220,
+            "description": "SVG height in px.",
+            "type": "number"
+          },
+          "filename": {
+            "description": "Header label; defaults to the chart type.",
+            "type": "string"
+          },
+          "caption": {
+            "description": "Caption shown below the chart on a hairline rule.",
+            "type": "string"
+          },
+          "xLabel": {
+            "description": "Caption for the horizontal axis, rendered as uppercase mono — the categories on a vertical bar, line or area chart; the values on a horizontal bar chart or a histogram.",
+            "type": "string"
+          },
+          "yLabel": {
+            "description": "Caption for the vertical axis, rendered as uppercase mono — the values on a vertical bar, line or area chart; the categories on a horizontal bar chart; the count on a histogram.",
+            "type": "string"
+          },
+          "unit": {
+            "description": "Suffix appended to axis tick and tooltip values, e.g. \"ms\" or \"%\". On a histogram it labels the value axis (x); y is a count.",
+            "type": "string"
+          },
+          "legend": {
+            "default": true,
+            "description": "Show the series legend in the header when there's more than one series.",
+            "type": "boolean"
+          }
+        }
+      }
+    },
+    {
+      "name": "Sparkline",
+      "description": "A tiny inline trend line with no axes or labels.",
+      "whenToUse": "Use inline (e.g. in a sentence or table cell) to show the shape of a trend without a full chart — 'requests over the last hour ' next to a Sparkline. Needs at least two `values`.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "values": {
+            "type": "array",
+            "items": {
+              "type": "number"
+            },
+            "description": "Series to plot; at least two numbers."
+          },
+          "width": {
+            "default": 84,
+            "description": "SVG width in px.",
+            "type": "number"
+          },
+          "height": {
+            "default": 20,
+            "description": "SVG height in px.",
+            "type": "number"
+          },
+          "color": {
+            "default": "var(--chart-1)",
+            "description": "Any CSS color, typically a `--chart-1`..`--chart-6` token.",
+            "type": "string"
+          },
+          "fill": {
+            "default": true,
+            "description": "Tinted area under the line.",
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "values"
+        ]
+      }
+    },
+    {
+      "name": "Dropdown",
+      "description": "A menu-style picker: a button that opens a popover list of options — a plain form control, or a content switcher when given `Option` children.",
+      "whenToUse": "Pass `options` (strings or `{ value, label }`) for a form-style select, e.g. a settings picker. Pass `Option` children instead — each with a `label` and its own content — to switch between longer or more numerous panels of content; prefer `Tabs` when there are only 2-4 visible alternatives, and `Dropdown` once the list gets longer than fits comfortably as tabs.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "label": {
+            "description": "Label shown above the control.",
+            "type": "string"
+          },
+          "icon": {
+            "description": "Lucide icon name; renders an icon-only trigger instead of the labelled control. `label` becomes the accessible name.",
+            "type": "string"
+          },
+          "options": {
+            "description": "Strings, or { value, label, description? } objects, for a plain picker. Omit this and use `Option` children instead for a content-switching dropdown.",
+            "type": "array",
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "description": "Option value and label, both the same string."
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "value": {
+                      "type": "string",
+                      "description": "Value reported for this option."
+                    },
+                    "label": {
+                      "type": "string",
+                      "description": "Text shown for this option."
+                    },
+                    "description": {
+                      "description": "One short line shown under the label in the menu.",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "value",
+                    "label"
+                  ]
+                }
+              ]
+            }
+          },
+          "value": {
+            "description": "Selected value (controlled) — requires `onChange` to update it.",
+            "type": "string"
+          },
+          "defaultValue": {
+            "description": "Initially selected value (uncontrolled). Defaults to the first option.",
+            "type": "string"
+          },
+          "placeholder": {
+            "description": "Text shown on the trigger while nothing is selected.",
+            "type": "string"
+          },
+          "size": {
+            "default": "md",
+            "description": "Control height: sm (28px) or md (34px).",
+            "type": "string",
+            "enum": [
+              "sm",
+              "md"
+            ]
+          },
+          "disabled": {
+            "default": false,
+            "description": "Disables the control.",
+            "type": "boolean"
+          },
+          "onChange": {
+            "description": "Called with the new value whenever the selection changes (JSX only)."
+          }
+        }
+      },
+      "children": "One or more `<Option>` elements. When present, `Dropdown` acts as a content switcher: the menu picks which option's content renders below, cross-faded."
+    },
+    {
+      "name": "Option",
+      "description": "A single labeled option within a `Dropdown` content switcher.",
+      "whenToUse": "Only as a direct child of `<Dropdown>`. `label` is required; `value` defaults to a slug of `label`.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "label": {
+            "type": "string",
+            "description": "Option label shown in the menu."
+          },
+          "value": {
+            "description": "Stable identifier for this option; defaults to a slug of `label`.",
+            "type": "string"
+          },
+          "description": {
+            "description": "One short line shown under the label in the menu.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "label"
+        ]
+      },
+      "children": "Panel content shown when this option is selected; any MDX/Markdown content."
+    },
+    {
+      "name": "Screenshot",
+      "description": "An image framed as a macOS window — traffic-light buttons, an optional title, a raised border — for app and UI screenshots.",
+      "whenToUse": "Use instead of a plain Markdown image when the picture is a screenshot of an app, web page, or terminal, so it reads as a window rather than a bare bitmap. `src` resolves like a Markdown image; add `title` for the window name and `caption` for a note below. The title bar's expand control opens the image full-screen with pan and zoom, so a dense screenshot can stay small inline. Keep plain `![alt](src)` for diagrams, logos, and photos.",
+      "props": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "src": {
+            "type": "string",
+            "description": "Image URL, relative to the document like a Markdown image."
+          },
+          "alt": {
+            "default": "",
+            "description": "Accessible description of the image.",
+            "type": "string"
+          },
+          "title": {
+            "description": "Window title shown centred in the title bar, e.g. the app or page name.",
+            "type": "string"
+          },
+          "caption": {
+            "description": "Caption shown below the image on a hairline rule.",
+            "type": "string"
+          },
+          "width": {
+            "description": "Max width of the window (px or any CSS length); defaults to the full column.",
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          }
+        },
+        "required": [
+          "src"
+        ]
+      }
+    }
+  ]
+}