@commercetools/nimbus-mcp 3.4.0 → 3.5.1

package/data/docs/types/DataTableColumn.json

@@ -0,0 +1,540 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "DataTable.Column - Individual column header component that handles sorting interactions",
+  "displayName": "DataTableColumn",
+  "methods": [],
+  "props": {
+    "className": {
+      "defaultValue": {
+        "value": "'react-aria-TableHeader'"
+      },
+      "description": "The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the\nelement. A function may be provided to compute the class based on component state.",
+      "name": "className",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "TableHeaderProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "TableHeaderProps"
+        },
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+          "name": "HTMLAttributes"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "(ClassNameOrFunction<TableHeaderRenderProps> & string)"
+      }
+    },
+    "id": {
+      "defaultValue": null,
+      "description": "The unique id of the row.",
+      "name": "id",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "RowProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "RowProps"
+        },
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+          "name": "HTMLAttributes"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "allowsSorting": {
+      "defaultValue": null,
+      "description": "Whether the column allows sorting.",
+      "name": "allowsSorting",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "ColumnProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "ColumnProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "isRowHeader": {
+      "defaultValue": null,
+      "description": "Whether a column is a [row header](https://www.w3.org/TR/wai-aria-1.1/#rowheader) and should be\nannounced by assistive technology during row navigation.",
+      "name": "isRowHeader",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "ColumnProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "ColumnProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "textValue": {
+      "defaultValue": null,
+      "description": "A string representation of the row's contents, used for features like typeahead.",
+      "name": "textValue",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "RowProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "RowProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "width": {
+      "defaultValue": null,
+      "description": "The width of the column. This prop only applies when the `<Table>` is wrapped in a\n`<ResizableTableContainer>`.",
+      "name": "width",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "ColumnProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "ColumnProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ColumnSize | null"
+      }
+    },
+    "defaultWidth": {
+      "defaultValue": null,
+      "description": "The default width of the column. This prop only applies when the `<Table>` is wrapped in a\n`<ResizableTableContainer>`.",
+      "name": "defaultWidth",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "ColumnProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "ColumnProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ColumnSize | null"
+      }
+    },
+    "minWidth": {
+      "defaultValue": null,
+      "description": "The minimum width of the column. This prop only applies when the `<Table>` is wrapped in a\n`<ResizableTableContainer>`.",
+      "name": "minWidth",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "ColumnProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "ColumnProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ColumnStaticSize | null"
+      }
+    },
+    "maxWidth": {
+      "defaultValue": null,
+      "description": "The maximum width of the column. This prop only applies when the `<Table>` is wrapped in a\n`<ResizableTableContainer>`.",
+      "name": "maxWidth",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "ColumnProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "ColumnProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ColumnStaticSize | null"
+      }
+    },
+    "focusMode": {
+      "defaultValue": null,
+      "description": "Whether the cell or its first focusable child element should be focused when the cell is\nfocused. Defaults to 'child' in arrow keyboard navigation mode and 'cell' in tab keyboard\nnavigation mode.",
+      "name": "focusMode",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "CellProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "CellProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "\"cell\" | \"child\"",
+        "value": [
+          {
+            "value": "\"cell\""
+          },
+          {
+            "value": "\"child\""
+          }
+        ]
+      }
+    },
+    "allowsArrowNavigation": {
+      "defaultValue": null,
+      "description": "Whether the cell should support arrow key navigation even when the containing table uses\ntab keyboard navigation. Allows users to navigate between cells and rows with arrow keys while\nfocus is on an interactive child element within the cell.",
+      "name": "allowsArrowNavigation",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+        "name": "CellProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Table.d.ts",
+          "name": "CellProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "children": {
+      "defaultValue": null,
+      "description": "The children of the component. A function may be provided to alter the children based on\ncomponent state.",
+      "name": "children",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.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": "RenderProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.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": "RenderProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ChildrenOrFunction<PopoverRenderProps>"
+      }
+    },
+    "style": {
+      "defaultValue": null,
+      "description": "The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the\nelement. A function may be provided to compute the style based on component state.",
+      "name": "style",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.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": "StyleRenderProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.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": "StyleRenderProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "StyleOrFunction<PopoverRenderProps>"
+      }
+    },
+    "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\n  `<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\n  as appropriate.",
+      "name": "render",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-aria-components@1.20.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.20.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>"
+      }
+    },
+    "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.18_react@19.2.0_suppor_282ee4efbadb76ec168c7f623f2b67f1/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.18_react@19.2.0_suppor_282ee4efbadb76ec168c7f623f2b67f1/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.18_react@19.2.0_suppor_282ee4efbadb76ec168c7f623f2b67f1/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.18_react@19.2.0_suppor_282ee4efbadb76ec168c7f623f2b67f1/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.18_react@19.2.0_suppor_282ee4efbadb76ec168c7f623f2b67f1/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.18_react@19.2.0_suppor_282ee4efbadb76ec168c7f623f2b67f1/node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts",
+          "name": "JsxStyleProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "SystemStyleObject | Omit<(SystemStyleObject)[], keyof any[]>"
+      }
+    },
+    "abbr": {
+      "defaultValue": null,
+      "description": "",
+      "name": "abbr",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+        "name": "ThHTMLAttributes"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+          "name": "ThHTMLAttributes"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "align": {
+      "defaultValue": null,
+      "description": "",
+      "name": "align",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+        "name": "TableHTMLAttributes"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+          "name": "TableHTMLAttributes"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "\"left\" | \"right\" | \"center\"",
+        "value": [
+          {
+            "value": "\"left\""
+          },
+          {
+            "value": "\"right\""
+          },
+          {
+            "value": "\"center\""
+          }
+        ]
+      }
+    },
+    "colSpan": {
+      "defaultValue": null,
+      "description": "",
+      "name": "colSpan",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+        "name": "ThHTMLAttributes"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+          "name": "ThHTMLAttributes"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "number"
+      }
+    },
+    "headers": {
+      "defaultValue": null,
+      "description": "",
+      "name": "headers",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+        "name": "ThHTMLAttributes"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+          "name": "ThHTMLAttributes"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "rowSpan": {
+      "defaultValue": null,
+      "description": "",
+      "name": "rowSpan",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+        "name": "ThHTMLAttributes"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+          "name": "ThHTMLAttributes"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "number"
+      }
+    },
+    "scope": {
+      "defaultValue": null,
+      "description": "",
+      "name": "scope",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+        "name": "ThHTMLAttributes"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@types+react@19.2.18/node_modules/@types/react/index.d.ts",
+          "name": "ThHTMLAttributes"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/data-table/data-table.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLTableCellElement>"
+      }
+    },
+    "column": {
+      "defaultValue": null,
+      "description": "",
+      "name": "column",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/data-table/data-table.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "DataTableColumnItem<Record<string, unknown>>"
+      }
+    },
+    "unstyled": {
+      "defaultValue": null,
+      "description": "",
+      "name": "unstyled",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/data-table/data-table.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "isInternalColumn": {
+      "defaultValue": null,
+      "description": "",
+      "name": "isInternalColumn",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/data-table/data-table.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}