@commercetools/nimbus-mcp 0.1.0 → 2.10.0

package/data/docs/types/ModalPage.json

@@ -0,0 +1,12 @@
+{
+  "tags": {
+    "see": "{@link https://nimbus-documentation.vercel.app/components/layout/modal-page}",
+    "example": "```tsx\nconst [isOpen, setIsOpen] = useState(false);\n\n<ModalPage.Root isOpen={isOpen} onClose={() => setIsOpen(false)}>\n  <ModalPage.TopBar\n    previousPathLabel=\"Products\"\n    currentPathLabel=\"Edit Product\"\n  />\n  <ModalPage.Header>\n    <ModalPage.Title>Edit Product</ModalPage.Title>\n    <ModalPage.Subtitle>Update the product details</ModalPage.Subtitle>\n    <ModalPage.Actions>\n      <Button>Save</Button>\n    </ModalPage.Actions>\n  </ModalPage.Header>\n  <ModalPage.Content>\n    <p>Form content here</p>\n  </ModalPage.Content>\n  <ModalPage.Footer>\n    <Button slot=\"close\" variant=\"outline\">Cancel</Button>\n    <Button colorPalette=\"primary\" variant=\"solid\">Save</Button>\n  </ModalPage.Footer>\n</ModalPage.Root>\n```"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage\n============================================================\nA fullscreen modal overlay used for form, info, and tabular page patterns.\nWraps Drawer internally with right-side placement and near-full-width layout.\n\nUsed for the ~29 modal page patterns in Merchant Center (form/info/tabular).",
+  "displayName": "ModalPage",
+  "methods": [],
+  "props": {},
+  "supportsStyleProps": false
+}

package/data/docs/types/ModalPageActions.json

@@ -0,0 +1,27 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage.Actions — action buttons container, aligned to the right of the header.",
+  "displayName": "ModalPageActions",
+  "methods": [],
+  "props": {
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarded to the actions container",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ModalPageContent.json

@@ -0,0 +1,27 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage.Content — scrollable content area.",
+  "displayName": "ModalPageContent",
+  "methods": [],
+  "props": {
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarded to the content container",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ModalPageFooter.json

@@ -0,0 +1,27 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage.Footer — footer slot, typically containing action buttons.",
+  "displayName": "ModalPageFooter",
+  "methods": [],
+  "props": {
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarded to the footer element",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ModalPageHeader.json

@@ -0,0 +1,27 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage.Header — header section, 2-column grid (title | actions).",
+  "displayName": "ModalPageHeader",
+  "methods": [],
+  "props": {
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarded to the header element",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ModalPageRoot.json

@@ -0,0 +1,87 @@
+{
+  "tags": {},
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage.Root — fullscreen modal page overlay.\n\nRenders a right-side Drawer with near-full-width, full-height layout.\nProvides the slot recipe context for all ModalPage sub-components via a\nCSS grid container (rows: topBar / header / content / footer).\n\nStyle props (e.g. `width`) are forwarded to the Drawer.Content panel.\nThe default width is near-fullscreen; consumers can pass a custom `width`\nto override.\n\nDismissal: backdrop click is disabled (no accidental close on a full-page\nform). Escape key remains active (isKeyboardDismissDisabled defaults to\nfalse), matching standard browser/OS modal behaviour and WCAG 2.1 SC 2.1.2.\n\nExit animations are handled automatically: the Drawer recipe defines\n[data-exiting] CSS animations (fade-out on overlay, slide-to-right-full on\nmodal), and React Aria's ModalOverlay waits for animationend before\nunmounting — no manual delay needed.",
+  "displayName": "ModalPageRoot",
+  "methods": [],
+  "props": {
+    "isOpen": {
+      "defaultValue": null,
+      "description": "Whether the modal page is open (controlled)",
+      "name": "isOpen",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "onClose": {
+      "defaultValue": null,
+      "description": "Callback fired when the modal page should close",
+      "name": "onClose",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "() => void"
+      }
+    },
+    "children": {
+      "defaultValue": null,
+      "description": "Child components — TopBar (required), Header, Content, and optional Footer",
+      "name": "children",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "ReactNode"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarded to the inner grid container",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    },
+    "width": {
+      "defaultValue": {
+        "value": "calc(100vw - {spacing.1200})"
+      },
+      "description": "Custom width for the modal page panel. Defaults to near-fullscreen.",
+      "name": "width",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<`var(--${string})` | AnyString | SizesToken | Width<String | Number> | readonly NonNullable<Width<String | Number>>[]>"
+      }
+    }
+  },
+  "supportsStyleProps": false
+}

package/data/docs/types/ModalPageSubtitle.json

@@ -0,0 +1,27 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage.Subtitle — optional subtitle text below the page title.",
+  "displayName": "ModalPageSubtitle",
+  "methods": [],
+  "props": {
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarded to the subtitle paragraph element",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLParagraphElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ModalPageTabNav.json

@@ -0,0 +1,28 @@
+{
+  "tags": {
+    "supportsStyleProps": "",
+    "example": "```tsx\n<ModalPage.TabNav>\n  <TabNav.Root aria-label=\"Order sections\">\n    <TabNav.Item href=\"/general\" isCurrent>General</TabNav.Item>\n    <TabNav.Item href=\"/items\">Items</TabNav.Item>\n  </TabNav.Root>\n</ModalPage.TabNav>\n```"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage.TabNav — layout container for tab navigation in the header.\nPositions itself in the header grid's last row at full width.\n\nPlace inside `ModalPage.Header` for route-based page navigation.\nWrap a `TabNav.Root` inside this component.",
+  "displayName": "ModalPageTabNav",
+  "methods": [],
+  "props": {
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarded to the tab nav container",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ModalPageTitle.json

@@ -0,0 +1,27 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage.Title — the page title heading. Renders as an `h2` element.\n\nWraps the React Aria `Heading` component with `slot=\"title\"` so the\nparent Dialog automatically uses it as the accessible name (aria-labelledby).",
+  "displayName": "ModalPageTitle",
+  "methods": [],
+  "props": {
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarded to the title container",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ModalPageTopBar.json

@@ -0,0 +1,57 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ModalPage.TopBar — breadcrumb navigation row.\n\nRenders a back button (uses React Aria `slot=\"close\"` to hook into dialog close)\nfollowed by the current path label.",
+  "displayName": "ModalPageTopBar",
+  "methods": [],
+  "props": {
+    "previousPathLabel": {
+      "defaultValue": null,
+      "description": "Label of the previous page shown in the back navigation button (e.g. \"Products\")",
+      "name": "previousPathLabel",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "string"
+      }
+    },
+    "currentPathLabel": {
+      "defaultValue": null,
+      "description": "Label of the current page shown in the breadcrumb (e.g. \"Edit Product\")",
+      "name": "currentPathLabel",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "string"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarded to the top bar container",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/modal-page/modal-page.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/MoneyInput.isEmpty.json

@@ -0,0 +1,40 @@
+{
+  "tags": {},
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "Check if the search text is empty or only whitespace",
+  "displayName": "MoneyInput.isEmpty",
+  "methods": [],
+  "props": {
+    "text": {
+      "defaultValue": null,
+      "description": "Search text entered by user",
+      "name": "text",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/scoped-search-input/scoped-search-input.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "string"
+      }
+    },
+    "option": {
+      "defaultValue": null,
+      "description": "Selected scope/category option",
+      "name": "option",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/scoped-search-input/scoped-search-input.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "string"
+      }
+    }
+  },
+  "supportsStyleProps": false
+}