@commercetools/nimbus-mcp 3.1.0 → 3.3.0

package/data/docs/types/Markdown.json

@@ -0,0 +1,183 @@
+{
+  "tags": {
+    "supportsStyleProps": "",
+    "see": "{@link https://nimbus-documentation.vercel.app/components/content/markdown}"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "# Markdown\n\nRenders a Markdown string into Nimbus-styled, accessible React elements with\ndefault renderers for every standard element, per-element overrides, embedded\ncustom component tags, and safe incremental rendering of streamed (LLM)\noutput.\n\nSafe by default: raw HTML is never rendered and rendering is restricted to a\nsafe element allowlist; image-host security is delegated to the application\nContent-Security-Policy.",
+  "displayName": "Markdown",
+  "methods": [],
+  "props": {
+    "as": {
+      "defaultValue": null,
+      "description": "",
+      "name": "as",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@chakra-ui+react@3.36.1_@emotion+react@11.14.0_@types+react@19.2.17_react@19.2.0__react_481d5ee5504b18c9383bebdcb4b66737/node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts",
+        "name": "PolymorphicProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@chakra-ui+react@3.36.1_@emotion+react@11.14.0_@types+react@19.2.17_react@19.2.0__react_481d5ee5504b18c9383bebdcb4b66737/node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts",
+          "name": "PolymorphicProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ElementType"
+      }
+    },
+    "asChild": {
+      "defaultValue": null,
+      "description": "",
+      "name": "asChild",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@chakra-ui+react@3.36.1_@emotion+react@11.14.0_@types+react@19.2.17_react@19.2.0__react_481d5ee5504b18c9383bebdcb4b66737/node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts",
+        "name": "PolymorphicProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@chakra-ui+react@3.36.1_@emotion+react@11.14.0_@types+react@19.2.17_react@19.2.0__react_481d5ee5504b18c9383bebdcb4b66737/node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts",
+          "name": "PolymorphicProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "css": {
+      "defaultValue": null,
+      "description": "",
+      "name": "css",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@chakra-ui+react@3.36.1_@emotion+react@11.14.0_@types+react@19.2.17_react@19.2.0__react_481d5ee5504b18c9383bebdcb4b66737/node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts",
+        "name": "JsxStyleProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@chakra-ui+react@3.36.1_@emotion+react@11.14.0_@types+react@19.2.17_react@19.2.0__react_481d5ee5504b18c9383bebdcb4b66737/node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts",
+          "name": "JsxStyleProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "SystemStyleObject | Omit<(SystemStyleObject)[], keyof any[]>"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref to the outer root container element.",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/box/box.tsx",
+          "name": "TypeLiteral"
+        },
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/markdown/markdown.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    },
+    "children": {
+      "defaultValue": null,
+      "description": "The Markdown source string to render (canonical input, matching\n`react-markdown`). GitHub Flavored Markdown — tables, task lists,\nstrikethrough, autolinks — is enabled by default.",
+      "name": "children",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/markdown/markdown.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "string"
+      }
+    },
+    "components": {
+      "defaultValue": null,
+      "description": "Renderer map, shallow-merged per key over the Nimbus defaults. Two uses:\n\n- **Per-element override** — a standard element key (e.g. `{ a: MyLink }`)\n  replaces that one default renderer; all others stay intact.\n- **Custom component tag** — a non-standard key (e.g.\n  `{ SearchQueryResultCard: Card }`) registers a tag that can be embedded in\n  the source (`<SearchQueryResultCard id=\"foo\" />`); its string attributes\n  are passed to the component as props. Tag names match by exact case, so\n  any casing is preserved. Safe by default: a custom tag renders only if a\n  component is registered for it — unregistered tags stay inert.",
+      "name": "components",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/markdown/markdown.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "MarkdownComponents"
+      }
+    },
+    "allowedElements": {
+      "defaultValue": null,
+      "description": "Restrict rendering to this set of element names. Defaults to a safe\nallowlist covering all Nimbus default renderers. Mutually exclusive with\n`disallowedElements`.",
+      "name": "allowedElements",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/markdown/markdown.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "readonly string[] | null"
+      }
+    },
+    "disallowedElements": {
+      "defaultValue": null,
+      "description": "Remove these element names from the rendered output. Mutually exclusive\nwith `allowedElements`.",
+      "name": "disallowedElements",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/markdown/markdown.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "readonly string[] | null"
+      }
+    },
+    "isStreaming": {
+      "defaultValue": {
+        "value": "false"
+      },
+      "description": "Enables safe incremental rendering of streamed (e.g. LLM) output:\nunterminated inline constructs are completed via `remend`, content is split\ninto memoized blocks so only the final block re-parses per token, and the\nroot manages `aria-busy` plus a single coalesced completion announcement.",
+      "name": "isStreaming",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/markdown/markdown.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "headingOffset": {
+      "defaultValue": {
+        "value": "0"
+      },
+      "description": "Shifts rendered heading levels to preserve the host page outline: a\nmarkdown heading of level `L` renders as `min(L + headingOffset, 6)`.",
+      "name": "headingOffset",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/markdown/markdown.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "number"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}