@commercetools/nimbus-mcp 0.1.0 → 2.11.0

package/data/docs/types/RangeCalendar.json

@@ -0,0 +1,618 @@
+{
+  "tags": {
+    "see": "{@link https://nimbus-documentation.vercel.app/components/inputs/rangecalendar}",
+    "supportsStylePropsx": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "RangeCalendar\n============================================================\nCalendar component that displays a grid of days in one or more months\nand allows users to select a range of dates. Built with React Aria\nComponents for accessibility and WCAG 2.1 AA compliance.",
+  "displayName": "RangeCalendar",
+  "methods": [],
+  "props": {
+    "slot": {
+      "defaultValue": null,
+      "description": "A slot name for the component. Slots allow the component to receive props from a parent component.\nAn explicit `null` value indicates that the local props completely override all props received from a parent.",
+      "name": "slot",
+      "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": "SlotProps"
+      },
+      "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": "SlotProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string | null"
+      }
+    },
+    "defaultValue": {
+      "defaultValue": null,
+      "description": "The default value (uncontrolled).",
+      "name": "defaultValue",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/inputs.d.ts",
+        "name": "ValueBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/inputs.d.ts",
+          "name": "ValueBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "autoFocus": {
+      "defaultValue": {
+        "value": "false"
+      },
+      "description": "Whether to automatically focus the calendar when it mounts.",
+      "name": "autoFocus",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "className": {
+      "defaultValue": {
+        "value": "'react-aria-Calendar'"
+      },
+      "description": "The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. 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.17.0_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/react-aria-components/dist/types/src/Calendar.d.ts",
+        "name": "CalendarProps"
+      },
+      "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/Calendar.d.ts",
+          "name": "CalendarProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ClassNameOrFunction<CalendarRenderProps>"
+      }
+    },
+    "id": {
+      "defaultValue": null,
+      "description": "The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).",
+      "name": "id",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "DOMProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "DOMProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "aria-describedby": {
+      "defaultValue": null,
+      "description": "Identifies the element (or elements) that describes the object.",
+      "name": "aria-describedby",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "AriaLabelingProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "AriaLabelingProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "aria-details": {
+      "defaultValue": null,
+      "description": "Identifies the element (or elements) that provide a detailed, extended description for the object.",
+      "name": "aria-details",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "AriaLabelingProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "AriaLabelingProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "aria-label": {
+      "defaultValue": null,
+      "description": "Defines a string value that labels the current element.",
+      "name": "aria-label",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "AriaLabelingProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "AriaLabelingProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "aria-labelledby": {
+      "defaultValue": null,
+      "description": "Identifies the element (or elements) that labels the current element.",
+      "name": "aria-labelledby",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+        "name": "AriaLabelingProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/dom.d.ts",
+          "name": "AriaLabelingProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "children": {
+      "defaultValue": null,
+      "description": "The children of the component. A function may be provided to alter the children based on component state.",
+      "name": "children",
+      "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": "RenderProps"
+      },
+      "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": "RenderProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ChildrenOrFunction<PopoverRenderProps>"
+      }
+    },
+    "onChange": {
+      "defaultValue": null,
+      "description": "Handler that is called when the value changes.",
+      "name": "onChange",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/inputs.d.ts",
+        "name": "ValueBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/inputs.d.ts",
+          "name": "ValueBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((value: string) => void)"
+      }
+    },
+    "value": {
+      "defaultValue": null,
+      "description": "The current value (controlled).",
+      "name": "value",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/inputs.d.ts",
+        "name": "ValueBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/inputs.d.ts",
+          "name": "ValueBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "isDisabled": {
+      "defaultValue": {
+        "value": "false"
+      },
+      "description": "Whether the calendar is disabled.",
+      "name": "isDisabled",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "onFocusChange": {
+      "defaultValue": null,
+      "description": "Handler that is called when the focused date changes.",
+      "name": "onFocusChange",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((date: CalendarDate) => void)"
+      }
+    },
+    "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>"
+      }
+    },
+    "isInvalid": {
+      "defaultValue": null,
+      "description": "Whether the current selection is invalid according to application logic.",
+      "name": "isInvalid",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "isReadOnly": {
+      "defaultValue": {
+        "value": "false"
+      },
+      "description": "Whether the calendar value is immutable.",
+      "name": "isReadOnly",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "commitBehavior": {
+      "defaultValue": {
+        "value": "'select'"
+      },
+      "description": "Controls the behavior when a pointer is released outside the calendar or a blur occurs mid selection:\n\n- `clear`: clear the currently selected range of dates.\n\n- `reset`: reset the selection to the previously selected range of dates.\n\n- `select`: select the currently hovered range of dates.",
+      "name": "commitBehavior",
+      "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/calendar/useRangeCalendar.d.ts",
+        "name": "AriaRangeCalendarProps"
+      },
+      "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/calendar/useRangeCalendar.d.ts",
+          "name": "AriaRangeCalendarProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "\"clear\" | \"select\" | \"reset\"",
+        "value": [
+          {
+            "value": "\"clear\""
+          },
+          {
+            "value": "\"select\""
+          },
+          {
+            "value": "\"reset\""
+          }
+        ]
+      }
+    },
+    "minValue": {
+      "defaultValue": null,
+      "description": "The minimum allowed date that a user may select.",
+      "name": "minValue",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "DateValue | null"
+      }
+    },
+    "maxValue": {
+      "defaultValue": null,
+      "description": "The maximum allowed date that a user may select.",
+      "name": "maxValue",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "DateValue | null"
+      }
+    },
+    "isDateUnavailable": {
+      "defaultValue": null,
+      "description": "Callback that is called for each date of the calendar. If it returns true, then the date is unavailable.",
+      "name": "isDateUnavailable",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((date: DateValue) => boolean)"
+      }
+    },
+    "focusedValue": {
+      "defaultValue": null,
+      "description": "Controls the currently focused date within the calendar.",
+      "name": "focusedValue",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "DateValue | null"
+      }
+    },
+    "defaultFocusedValue": {
+      "defaultValue": null,
+      "description": "The date that is focused when the calendar first mounts (uncontrolled).",
+      "name": "defaultFocusedValue",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "DateValue | null"
+      }
+    },
+    "pageBehavior": {
+      "defaultValue": {
+        "value": "visible"
+      },
+      "description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration.",
+      "name": "pageBehavior",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "PageBehavior",
+        "value": [
+          {
+            "value": "\"visible\""
+          },
+          {
+            "value": "\"single\""
+          }
+        ]
+      }
+    },
+    "firstDayOfWeek": {
+      "defaultValue": null,
+      "description": "The day that starts the week.",
+      "name": "firstDayOfWeek",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "\"sun\" | \"mon\" | \"tue\" | \"wed\" | \"thu\" | \"fri\" | \"sat\"",
+        "value": [
+          {
+            "value": "\"sun\""
+          },
+          {
+            "value": "\"mon\""
+          },
+          {
+            "value": "\"tue\""
+          },
+          {
+            "value": "\"wed\""
+          },
+          {
+            "value": "\"thu\""
+          },
+          {
+            "value": "\"fri\""
+          },
+          {
+            "value": "\"sat\""
+          }
+        ]
+      }
+    },
+    "selectionAlignment": {
+      "defaultValue": {
+        "value": "'center'"
+      },
+      "description": "Determines the alignment of the visible months on initial render based on the current selection or current date if there is no selection.",
+      "name": "selectionAlignment",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+        "name": "CalendarPropsBase"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/types.d.ts",
+          "name": "CalendarPropsBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "\"center\" | \"end\" | \"start\"",
+        "value": [
+          {
+            "value": "\"center\""
+          },
+          {
+            "value": "\"end\""
+          },
+          {
+            "value": "\"start\""
+          }
+        ]
+      }
+    },
+    "visibleDuration": {
+      "defaultValue": {
+        "value": "{months: 1}"
+      },
+      "description": "The amount of days that will be displayed at once. This affects how pagination works.",
+      "name": "visibleDuration",
+      "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/Calendar.d.ts",
+        "name": "CalendarProps"
+      },
+      "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/Calendar.d.ts",
+          "name": "CalendarProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "DateDuration"
+      }
+    },
+    "allowsNonContiguousRanges": {
+      "defaultValue": null,
+      "description": "When combined with `isDateUnavailable`, determines whether non-contiguous ranges,\ni.e. ranges containing unavailable dates, may be selected.",
+      "name": "allowsNonContiguousRanges",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/useRangeCalendarState.d.ts",
+        "name": "RangeCalendarProps"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/react-stately@3.46.0_react@19.2.0/node_modules/react-stately/dist/types/src/calendar/useRangeCalendarState.d.ts",
+          "name": "RangeCalendarProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    }
+  },
+  "supportsStyleProps": false
+}