@imfusion/web-ui 0.6.1-dev.6.g4adc5c3e → 0.6.1

package/src/docgen/doc.gen.json

@@ -533,6 +533,13 @@
             "type": "boolean",
             "defaultValue": "false",
             "description": "Show a small copy button on the right, behind a hairline separator."
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
           }
         ]
       },
@@ -553,6 +560,13 @@
             "type": "CodeInlineLinkKind",
             "defaultValue": "external",
             "description": "Link target scope. `\"external\"` (default) opens in a new tab with a diagonal `ArrowUpRight` icon; `\"internal\"` stays in the current tab with a horizontal `ArrowRight` icon."
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
           }
         ]
       }
@@ -3799,7 +3813,7 @@
         {
           "name": "gap",
           "required": false,
-          "type": "| \"1\"\n| \"2\"\n| \"3\"\n| \"4\"\n| \"5\"\n| \"6\"\n| \"7\"\n| \"8\"\n| \"9\"\n| \"10\"\n| null",
+          "type": "| \"0\"\n| \"1\"\n| \"2\"\n| \"3\"\n| \"4\"\n| \"5\"\n| \"6\"\n| \"7\"\n| \"8\"\n| \"9\"\n| \"10\"\n| null",
           "defaultValue": "4",
           "description": ""
         },
@@ -4180,6 +4194,394 @@
       }
     ]
   },
+  "toast": {
+    "root": {
+      "name": "Toast.Root",
+      "description": "Toast.Root — one toast surface. Carries the upstream state as data attributes\n(`data-starting-style`, `data-ending-style`, `data-expanded`, `data-limited`,\n`data-swiping`) which the stylesheet uses for stack and exit motion.",
+      "props": [
+        {
+          "name": "className",
+          "required": false,
+          "type": "string | ((state: ToastRootState) => string)",
+          "defaultValue": null,
+          "description": ""
+        },
+        {
+          "name": "render",
+          "required": false,
+          "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, ToastRootState>",
+          "defaultValue": null,
+          "description": ""
+        },
+        {
+          "name": "swipeDirection",
+          "required": false,
+          "type": "| \"up\"\n| \"down\"\n| \"left\"\n| \"right\"\n| (\"up\" | \"down\" | \"left\" | \"right\")[]",
+          "defaultValue": "['down', 'right']",
+          "description": ""
+        },
+        {
+          "name": "toast",
+          "required": true,
+          "type": "ToastRootToastObject<any>",
+          "defaultValue": null,
+          "description": "The toast object from the manager's `toasts` array."
+        },
+        {
+          "name": "variant",
+          "required": false,
+          "type": "| \"neutral\"\n| \"info\"\n| \"success\"\n| \"warning\"\n| \"error\"\n| null",
+          "defaultValue": "neutral",
+          "description": "Semantic treatment for the toast surface."
+        }
+      ]
+    },
+    "subComponents": [
+      {
+        "name": "Toast.Action",
+        "description": "Toast.Action — the toast's single affordance, typically an undo. Its behavior\ncomes from `actionProps` on the toast object passed to the manager.",
+        "props": [
+          {
+            "name": "className",
+            "required": false,
+            "type": "string | ((state: ToastActionState) => string)",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "nativeButton",
+            "required": false,
+            "type": "boolean",
+            "defaultValue": "true",
+            "description": ""
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, ToastActionState>",
+            "defaultValue": null,
+            "description": ""
+          }
+        ]
+      },
+      {
+        "name": "Toast.Arrow",
+        "description": "Toast.Arrow — pointer joining an anchored toast to its anchor. Receives `data-side` for orientation.",
+        "props": [
+          {
+            "name": "className",
+            "required": false,
+            "type": "string | ((state: ToastArrowState) => string)",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, ToastArrowState>",
+            "defaultValue": null,
+            "description": ""
+          }
+        ]
+      },
+      {
+        "name": "Toast.Close",
+        "description": "Toast.Close — dismisses the toast it sits in.",
+        "props": [
+          {
+            "name": "className",
+            "required": false,
+            "type": "string | ((state: ToastCloseState) => string)",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "nativeButton",
+            "required": false,
+            "type": "boolean",
+            "defaultValue": "true",
+            "description": ""
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, ToastCloseState>",
+            "defaultValue": null,
+            "description": ""
+          }
+        ]
+      },
+      {
+        "name": "Toast.Content",
+        "description": "Toast.Content — lays out title, description, action, and close. Fades out on\nthe toasts stacked behind the frontmost one via `data-behind`.",
+        "props": [
+          {
+            "name": "className",
+            "required": false,
+            "type": "string | ((state: ToastContentState) => string)",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, ToastContentState>",
+            "defaultValue": null,
+            "description": ""
+          }
+        ]
+      },
+      {
+        "name": "Toast.Description",
+        "description": "Toast.Description — supporting copy. Falls back to the toast object's `description` when given no children.",
+        "props": [
+          {
+            "name": "className",
+            "required": false,
+            "type": "| string\n| ((state: ToastDescriptionState) => string)",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, ToastDescriptionState>",
+            "defaultValue": null,
+            "description": ""
+          }
+        ]
+      },
+      {
+        "name": "Toast.Portal",
+        "description": "Toast.Portal — moves the viewport out of the page flow so toasts float above the app.",
+        "props": [
+          {
+            "name": "className",
+            "required": false,
+            "type": "string | ((state: any) => string)",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "container",
+            "required": false,
+            "type": "| HTMLElement\n| ShadowRoot\n| RefObject<HTMLElement | ShadowRoot | null>\n| null",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, any>",
+            "defaultValue": null,
+            "description": ""
+          }
+        ]
+      },
+      {
+        "name": "Toast.Positioner",
+        "description": "Toast.Positioner — anchors a toast to an element instead of the stack, for\nfeedback that belongs next to the control that caused it. Wrap a `Root` in it\nand the root switches to the compact content-sized surface.",
+        "props": [
+          {
+            "name": "align",
+            "required": false,
+            "type": "Align",
+            "defaultValue": "'center'",
+            "description": ""
+          },
+          {
+            "name": "alignOffset",
+            "required": false,
+            "type": "number | OffsetFunction",
+            "defaultValue": "0",
+            "description": ""
+          },
+          {
+            "name": "anchor",
+            "required": false,
+            "type": "Element | null",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "arrowPadding",
+            "required": false,
+            "type": "number",
+            "defaultValue": "5",
+            "description": ""
+          },
+          {
+            "name": "className",
+            "required": false,
+            "type": "| string\n| ((state: ToastPositionerState) => string)",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "collisionAvoidance",
+            "required": false,
+            "type": "CollisionAvoidance",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "collisionBoundary",
+            "required": false,
+            "type": "Boundary",
+            "defaultValue": "'clipping-ancestors'",
+            "description": ""
+          },
+          {
+            "name": "collisionPadding",
+            "required": false,
+            "type": "Padding",
+            "defaultValue": "5",
+            "description": ""
+          },
+          {
+            "name": "disableAnchorTracking",
+            "required": false,
+            "type": "boolean",
+            "defaultValue": "false",
+            "description": ""
+          },
+          {
+            "name": "positionMethod",
+            "required": false,
+            "type": "\"absolute\" | \"fixed\"",
+            "defaultValue": "'absolute'",
+            "description": ""
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, ToastPositionerState>",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "side",
+            "required": false,
+            "type": "Side",
+            "defaultValue": "'top'",
+            "description": ""
+          },
+          {
+            "name": "sideOffset",
+            "required": false,
+            "type": "number | OffsetFunction",
+            "defaultValue": "0",
+            "description": ""
+          },
+          {
+            "name": "sticky",
+            "required": false,
+            "type": "boolean",
+            "defaultValue": "false",
+            "description": ""
+          },
+          {
+            "name": "toast",
+            "required": true,
+            "type": "ToastObject<any>",
+            "defaultValue": null,
+            "description": "The toast object from the manager's `toasts` array."
+          }
+        ]
+      },
+      {
+        "name": "Toast.Provider",
+        "description": "Toast.Provider — owns the toast queue for its subtree. Renders no DOM element.\n\n`WebUIProvider` already mounts one, so most applications never write this\npart. Use it for a scoped queue or to attach an external manager.",
+        "props": [
+          {
+            "name": "limit",
+            "required": false,
+            "type": "number",
+            "defaultValue": "3",
+            "description": ""
+          },
+          {
+            "name": "timeout",
+            "required": false,
+            "type": "number",
+            "defaultValue": "5000",
+            "description": ""
+          },
+          {
+            "name": "toastManager",
+            "required": false,
+            "type": "ToastManager<any>",
+            "defaultValue": null,
+            "description": ""
+          }
+        ]
+      },
+      {
+        "name": "Toast.Title",
+        "description": "Toast.Title — the message heading. Falls back to the toast object's `title` when given no children.",
+        "props": [
+          {
+            "name": "className",
+            "required": false,
+            "type": "string | ((state: ToastTitleState) => string)",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, ToastTitleState>",
+            "defaultValue": null,
+            "description": ""
+          }
+        ]
+      },
+      {
+        "name": "Toast.Provider",
+        "description": "Toast.createToastManager — creates a manager that lives outside React so\nnon-component code can add toasts. Pass it to a `Toast.Provider` via\n`toastManager`.",
+        "props": []
+      },
+      {
+        "name": "Toast.useToastManager",
+        "description": "Toast.useToastManager — reads the queue and the add/close/update/promise\nmethods from the surrounding provider. Must run inside a provider; the one\n`WebUIProvider` mounts satisfies that for the standard setup.",
+        "props": []
+      },
+      {
+        "name": "Toast.Viewport",
+        "description": "Toast.Viewport — the fixed layer that holds the stack. Hovering or focusing it\nexpands the collapsed toasts; it ignores pointer events except on the toasts\nthemselves so the app underneath stays clickable.",
+        "props": [
+          {
+            "name": "className",
+            "required": false,
+            "type": "string | ((state: ToastViewportState) => string)",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "position",
+            "required": false,
+            "type": "| \"top-left\"\n| \"top-center\"\n| \"top-right\"\n| \"bottom-left\"\n| \"bottom-center\"\n| \"bottom-right\"\n| null",
+            "defaultValue": "bottom-center",
+            "description": "Which edge or corner of the screen the stack anchors to."
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, ToastViewportState>",
+            "defaultValue": null,
+            "description": ""
+          },
+          {
+            "name": "width",
+            "required": false,
+            "type": "\"content\" | \"compact\" | \"default\" | \"wide\" | null",
+            "defaultValue": "default",
+            "description": "Width treatment for the toast stack."
+          }
+        ]
+      }
+    ]
+  },
   "toggle": {
     "root": {
       "name": "Toggle",
@@ -4665,6 +5067,13 @@
         "name": "Typo.Blockquote",
         "description": "Typo.Blockquote — pulled quotation.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "spacing",
             "required": false,
@@ -4685,6 +5094,13 @@
         "name": "Typo.Detail",
         "description": "Typo.Detail — compact UI text, between Small (12px) and P (16px).",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "variant",
             "required": false,
@@ -4698,6 +5114,13 @@
         "name": "Typo.H1",
         "description": "Typo.H1 — top-level page heading.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "spacing",
             "required": false,
@@ -4718,6 +5141,13 @@
         "name": "Typo.H2",
         "description": "Typo.H2 — section heading.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "spacing",
             "required": false,
@@ -4738,6 +5168,13 @@
         "name": "Typo.H3",
         "description": "Typo.H3 — sub-section heading.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "spacing",
             "required": false,
@@ -4758,6 +5195,13 @@
         "name": "Typo.H4",
         "description": "Typo.H4 — minor heading.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "spacing",
             "required": false,
@@ -4778,6 +5222,13 @@
         "name": "Typo.Highlight",
         "description": "Typo.Highlight — inline mark/highlight.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "variant",
             "required": false,
@@ -4804,6 +5255,13 @@
             "type": "boolean",
             "defaultValue": "false",
             "description": "Show a small copy button on the right, behind a hairline separator."
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
           }
         ]
       },
@@ -4811,6 +5269,13 @@
         "name": "Typo.Lead",
         "description": "Typo.Lead — emphasised intro paragraph.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "spacing",
             "required": false,
@@ -4838,6 +5303,13 @@
             "defaultValue": "external",
             "description": "Link target scope. `\"external\"` (default) opens in a new tab with a diagonal `ArrowUpRight` icon; `\"internal\"` stays in the current tab with a horizontal `ArrowRight` icon."
           },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "variant",
             "required": false,
@@ -4851,6 +5323,13 @@
         "name": "Typo.OrderedList",
         "description": "Typo.OrderedList — numbered list.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "spacing",
             "required": false,
@@ -4871,6 +5350,13 @@
         "name": "Typo.P",
         "description": "Typo.P — body paragraph.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "spacing",
             "required": false,
@@ -4891,6 +5377,13 @@
         "name": "Typo.Small",
         "description": "Typo.Small — fine print.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "variant",
             "required": false,
@@ -4904,6 +5397,13 @@
         "name": "Typo.UnorderedList",
         "description": "Typo.UnorderedList — bulleted list.",
         "props": [
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+          },
           {
             "name": "spacing",
             "required": false,
@@ -4980,6 +5480,13 @@
             "type": "SupportedLanguage",
             "defaultValue": null,
             "description": ""
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
           }
         ]
       },
@@ -5000,6 +5507,13 @@
             "type": "CodeInlineLinkKind",
             "defaultValue": "external",
             "description": "Link target scope. `\"external\"` (default) opens in a new tab with a diagonal `ArrowUpRight` icon; `\"internal\"` stays in the current tab with a horizontal `ArrowRight` icon."
+          },
+          {
+            "name": "render",
+            "required": false,
+            "type": "| ReactElement<\n    unknown,\n    string | JSXElementConstructor<any>\n  >\n| ComponentRenderFn<HTMLProps, {}>",
+            "defaultValue": null,
+            "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
           }
         ]
       }