@commercetools/nimbus-mcp 0.1.0 → 2.11.0

package/data/docs/types/RadioInputRoot.json

@@ -0,0 +1,514 @@
+{
+  "tags": {
+    "supportsStyleProps": "",
+    "see": "{@link https://nimbus-documentation.vercel.app/components/inputs/radio-input}"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "# RadioInput.Root\n\nA set of closely related, mutually exclusive or complementary actions that are important enough to be displayed directly in the interface for quick access.",
+  "displayName": "RadioInputRoot",
+  "methods": [],
+  "props": {
+    "orientation": {
+      "defaultValue": {
+        "value": "\"vertical\""
+      },
+      "description": "Layout orientation for radio options",
+      "name": "orientation",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/radio-input/radio-input.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<\"horizontal\" | \"vertical\">"
+      }
+    },
+    "form": {
+      "defaultValue": null,
+      "description": "The `<form>` element to associate the input with.\nThe value of this attribute must be the id of a `<form>` in the same document.\nSee [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form).",
+      "name": "form",
+      "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": "InputDOMProps"
+      },
+      "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": "InputDOMProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "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"
+      }
+    },
+    "style": {
+      "defaultValue": null,
+      "description": "The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. 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.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": "StyleRenderProps"
+      },
+      "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": "StyleRenderProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "StyleOrFunction<PopoverRenderProps>"
+      }
+    },
+    "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"
+      }
+    },
+    "className": {
+      "defaultValue": {
+        "value": "'react-aria-RadioGroup'"
+      },
+      "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/RadioGroup.d.ts",
+        "name": "RadioGroupProps"
+      },
+      "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/RadioGroup.d.ts",
+          "name": "RadioGroupProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ClassNameOrFunction<RadioGroupRenderProps>"
+      }
+    },
+    "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-errormessage": {
+      "defaultValue": null,
+      "description": "Identifies the element that provides an error message for the object.",
+      "name": "aria-errormessage",
+      "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": "AriaValidationProps"
+      },
+      "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": "AriaValidationProps"
+        }
+      ],
+      "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"
+      }
+    },
+    "onFocus": {
+      "defaultValue": null,
+      "description": "Handler that is called when the element receives focus.",
+      "name": "onFocus",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/events.d.ts",
+        "name": "FocusEvents"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/events.d.ts",
+          "name": "FocusEvents"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((e: FocusEvent<Element, Element>) => void)"
+      }
+    },
+    "onBlur": {
+      "defaultValue": null,
+      "description": "Handler that is called when the element loses focus.",
+      "name": "onBlur",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/events.d.ts",
+        "name": "FocusEvents"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/events.d.ts",
+          "name": "FocusEvents"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((e: FocusEvent<Element, Element>) => void)"
+      }
+    },
+    "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)"
+      }
+    },
+    "name": {
+      "defaultValue": null,
+      "description": "The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).",
+      "name": "name",
+      "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": "InputDOMProps"
+      },
+      "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": "InputDOMProps"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "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": null,
+      "description": "Whether the input is disabled.",
+      "name": "isDisabled",
+      "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": "InputBase"
+      },
+      "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": "InputBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "onFocusChange": {
+      "defaultValue": null,
+      "description": "Handler that is called when the element's focus status changes.",
+      "name": "onFocusChange",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/events.d.ts",
+        "name": "FocusEvents"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@react-types+shared@3.34.0_react@19.2.0/node_modules/@react-types/shared/src/events.d.ts",
+          "name": "FocusEvents"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((isFocused: boolean) => 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>"
+      }
+    },
+    "isRequired": {
+      "defaultValue": null,
+      "description": "Whether user input is required on the input before form submission.",
+      "name": "isRequired",
+      "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": "Validation"
+      },
+      "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": "Validation"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "isInvalid": {
+      "defaultValue": null,
+      "description": "Whether the input value is invalid.",
+      "name": "isInvalid",
+      "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": "Validation"
+      },
+      "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": "Validation"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "isReadOnly": {
+      "defaultValue": null,
+      "description": "Whether the input can be selected but not changed by the user.",
+      "name": "isReadOnly",
+      "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": "InputBase"
+      },
+      "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": "InputBase"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "validationBehavior": {
+      "defaultValue": {
+        "value": "'native'"
+      },
+      "description": "Whether to use native HTML form validation to prevent form submission\nwhen the value is missing or invalid, or mark the field as required\nor invalid via ARIA.",
+      "name": "validationBehavior",
+      "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": "RACValidation"
+      },
+      "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": "RACValidation"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "\"native\" | \"aria\"",
+        "value": [
+          {
+            "value": "\"native\""
+          },
+          {
+            "value": "\"aria\""
+          }
+        ]
+      }
+    },
+    "validate": {
+      "defaultValue": null,
+      "description": "A function that returns an error message if a given value is invalid.\nValidation errors are displayed to the user when the form is submitted\nif `validationBehavior=\"native\"`. For realtime validation, use the `isInvalid`\nprop instead.",
+      "name": "validate",
+      "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": "Validation"
+      },
+      "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": "Validation"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "((value: boolean) => true | ValidationError | null)"
+      }
+    },
+    "children": {
+      "defaultValue": null,
+      "description": "Radio options to display",
+      "name": "children",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/radio-input/radio-input.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ReactNode"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}