@commercetools/nimbus-mcp 0.1.0 → 2.11.0

package/data/docs/types/TabsTab.json

@@ -0,0 +1,174 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "# Tab\n\nAn individual tab button that allows users to switch to a specific panel.",
+  "displayName": "TabsTab",
+  "methods": [],
+  "props": {
+    "size": {
+      "defaultValue": {
+        "value": "\"md\""
+      },
+      "description": "Size variant of the tabs",
+      "name": "size",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tabs/tabs.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<\"sm\" | \"md\" | \"lg\">"
+      }
+    },
+    "variant": {
+      "defaultValue": {
+        "value": "\"line\""
+      },
+      "description": "Visual style variant of the tabs",
+      "name": "variant",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tabs/tabs.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<\"line\" | \"pills\">"
+      }
+    },
+    "type": {
+      "defaultValue": null,
+      "description": "",
+      "name": "type",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.14/node_modules/@types/react/index.d.ts",
+        "name": "AnchorHTMLAttributes"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.14/node_modules/@types/react/index.d.ts",
+          "name": "AnchorHTMLAttributes"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "placement": {
+      "defaultValue": {
+        "value": "\"start\""
+      },
+      "description": "Placement of the tab list relative to panels",
+      "name": "placement",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tabs/tabs.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<\"end\" | \"start\">"
+      }
+    },
+    "orientation": {
+      "defaultValue": {
+        "value": "\"horizontal\""
+      },
+      "description": "Layout orientation of the tabs",
+      "name": "orientation",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tabs/tabs.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<\"horizontal\" | \"vertical\">"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "A ref to the underlying tab element.",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tabs/tabs.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLButtonElement>"
+      }
+    },
+    "isDisabled": {
+      "defaultValue": null,
+      "description": "Whether the tab is disabled.",
+      "name": "isDisabled",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tabs/tabs.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "href": {
+      "defaultValue": null,
+      "description": "A URL to link to when the tab is clicked. When provided, the tab renders\nas an anchor element (`<a>`) instead of a button, enabling native browser\nnavigation and router integration.",
+      "name": "href",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tabs/tabs.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "target": {
+      "defaultValue": null,
+      "description": "The target window for the link.\n@see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target",
+      "name": "target",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tabs/tabs.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "HTMLAttributeAnchorTarget"
+      }
+    },
+    "routerOptions": {
+      "defaultValue": null,
+      "description": "Options for the client-side router when navigating via `href`.",
+      "name": "routerOptions",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tabs/tabs.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "any"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/TagGroup.json

@@ -0,0 +1,12 @@
+{
+  "tags": {
+    "see": "{@link https://nimbus-documentation.vercel.app/components/data-display/tag-group}",
+    "example": "```tsx\n<TagGroup.Root>\n  <TagGroup.TagList>\n    <TagGroup.Tag>Tag 1</TagGroup.Tag>\n    <TagGroup.Tag>Tag 2</TagGroup.Tag>\n  </TagGroup.TagList>\n</TagGroup.Root>\n```"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "TagGroup\n============================================================\nA tag group is a focusable list of labels, categories, keywords, filters, or other items, with support for keyboard navigation, selection, and removal.",
+  "displayName": "TagGroup",
+  "methods": [],
+  "props": {},
+  "supportsStyleProps": false
+}

package/data/docs/types/TagGroupRoot.json

@@ -0,0 +1,306 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "TagGroup.Root - The root component that provides context and state management for the tag group",
+  "displayName": "TagGroupRoot",
+  "methods": [],
+  "props": {
+    "size": {
+      "defaultValue": {
+        "value": "\"lg\""
+      },
+      "description": "Size variant of the tag group",
+      "name": "size",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tag-group/tag-group.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<\"sm\" | \"md\" | \"lg\">"
+      }
+    },
+    "render": {
+      "defaultValue": null,
+      "description": "Overrides the default DOM element with a custom render function.\nThis allows rendering existing components with built-in styles and behaviors\nsuch as router links, animation libraries, and pre-styled components.\n\nRequirements:\n\n* You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`).\n* Only a single root DOM element can be rendered (no fragments).\n* You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.",
+      "name": "render",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.17.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/utils.d.ts",
+        "name": "DOMRenderProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.17.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/utils.d.ts",
+          "name": "DOMRenderProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "DOMRenderFunction<\"div\", PopoverRenderProps>"
+      }
+    },
+    "escapeKeyBehavior": {
+      "defaultValue": {
+        "value": "'clearSelection'"
+      },
+      "description": "Whether pressing the escape key should clear selection in the TagGroup or not.\n\nMost experiences should not modify this option as it eliminates a keyboard user's ability to\neasily clear selection. Only use if the escape key is being handled externally or should not\ntrigger selection clearing contextually.",
+      "name": "escapeKeyBehavior",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/tag/useTagGroup.d.ts",
+        "name": "AriaTagGroupProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/tag/useTagGroup.d.ts",
+          "name": "AriaTagGroupProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "\"none\" | \"clearSelection\"",
+        "value": [
+          {
+            "value": "\"none\""
+          },
+          {
+            "value": "\"clearSelection\""
+          }
+        ]
+      }
+    },
+    "onAction": {
+      "defaultValue": null,
+      "description": "Handler that is called when a user performs an action on an item. The exact user event depends on\nthe collection's `selectionBehavior` prop and the interaction modality.",
+      "name": "onAction",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/gridlist/useGridList.d.ts",
+        "name": "GridListProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/gridlist/useGridList.d.ts",
+          "name": "GridListProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((key: Key) => void)"
+      }
+    },
+    "shouldSelectOnPressUp": {
+      "defaultValue": null,
+      "description": "Whether selection should occur on press up instead of press down.",
+      "name": "shouldSelectOnPressUp",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/tag/useTagGroup.d.ts",
+        "name": "AriaTagGroupProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/tag/useTagGroup.d.ts",
+          "name": "AriaTagGroupProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "disabledKeys": {
+      "defaultValue": null,
+      "description": "The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with.",
+      "name": "disabledKeys",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/collections.d.ts",
+        "name": "CollectionBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/collections.d.ts",
+          "name": "CollectionBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Iterable<Key>"
+      }
+    },
+    "selectionMode": {
+      "defaultValue": null,
+      "description": "The type of selection that is allowed in the collection.",
+      "name": "selectionMode",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+        "name": "MultipleSelection"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+          "name": "MultipleSelection"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "SelectionMode",
+        "value": [
+          {
+            "value": "\"none\""
+          },
+          {
+            "value": "\"multiple\""
+          },
+          {
+            "value": "\"single\""
+          }
+        ]
+      }
+    },
+    "disallowEmptySelection": {
+      "defaultValue": null,
+      "description": "Whether the collection allows empty selection.",
+      "name": "disallowEmptySelection",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+        "name": "MultipleSelection"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+          "name": "MultipleSelection"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "selectedKeys": {
+      "defaultValue": null,
+      "description": "The currently selected keys in the collection (controlled).",
+      "name": "selectedKeys",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+        "name": "MultipleSelection"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+          "name": "MultipleSelection"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "\"all\" | Iterable<Key>"
+      }
+    },
+    "defaultSelectedKeys": {
+      "defaultValue": null,
+      "description": "The initial selected keys in the collection (uncontrolled).",
+      "name": "defaultSelectedKeys",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+        "name": "MultipleSelection"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+          "name": "MultipleSelection"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "\"all\" | Iterable<Key>"
+      }
+    },
+    "onSelectionChange": {
+      "defaultValue": null,
+      "description": "Handler that is called when the selection changes.",
+      "name": "onSelectionChange",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+        "name": "MultipleSelection"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/selection.d.ts",
+          "name": "MultipleSelection"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((keys: Selection) => void)"
+      }
+    },
+    "selectionBehavior": {
+      "defaultValue": {
+        "value": "'toggle'"
+      },
+      "description": "How multiple selection should behave in the collection.",
+      "name": "selectionBehavior",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/tag/useTagGroup.d.ts",
+        "name": "AriaTagGroupProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/tag/useTagGroup.d.ts",
+          "name": "AriaTagGroupProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "SelectionBehavior",
+        "value": [
+          {
+            "value": "\"replace\""
+          },
+          {
+            "value": "\"toggle\""
+          }
+        ]
+      }
+    },
+    "onRemove": {
+      "defaultValue": null,
+      "description": "Handler that is called when a user deletes a tag.",
+      "name": "onRemove",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/tag/useTagGroup.d.ts",
+        "name": "AriaTagGroupProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria@3.48.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria/dist/types/src/tag/useTagGroup.d.ts",
+          "name": "AriaTagGroupProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((keys: Set<Key>) => void)"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/tag-group/tag-group.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<(props: TagGroupProps & RefAttributes<HTMLDivElement>) => ReactElement<unknown, string | JSXElementConstructor<any>> | null>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}