@primereact/mcp 11.0.0-rc.2

package/data/llms/headless/components/radiobutton/api.json

@@ -0,0 +1,569 @@
+[
+  {
+    "name": "useRadioButton",
+    "source": "apps/showcase/assets/apidoc/useradiobutton.json",
+    "data": {
+      "description": "The useRadioButton manages the state and functionality of a radio button component.",
+      "interfaces": {
+        "UseRadioButtonChangeEvent": {
+          "description": "Event fired when the radio button's checked state changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "E",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "checked",
+              "type": "boolean",
+              "default": "",
+              "description": "The checked state of the radio button."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonProps": {
+          "description": "Defines valid properties in useRadioButton.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "checked",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, it specifies the input's checked state."
+            },
+            {
+              "name": "defaultChecked",
+              "type": "boolean",
+              "default": "",
+              "description": "The default value for the input when not controlled by  `checked`  and  `onCheckedChange` ."
+            },
+            {
+              "name": "inputId",
+              "type": "string",
+              "default": "",
+              "description": "Identifier of the underlying input element."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "Value of the radio button."
+            },
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "The name attribute of the input, resolved from group context if available."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the element should be disabled."
+            },
+            {
+              "name": "readOnly",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that an input field is read-only."
+            },
+            {
+              "name": "required",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the element is required."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard navigation."
+            },
+            {
+              "name": "invalid",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the component should have invalid state style."
+            },
+            {
+              "name": "ariaLabelledby",
+              "type": "string",
+              "default": "",
+              "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
+            },
+            {
+              "name": "ariaLabel",
+              "type": "string",
+              "default": "",
+              "description": "Establishes a string value that labels the component."
+            },
+            {
+              "name": "onFocus",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Callback function that is called when the radio button is focused."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Callback function that is called when the radio button loses focus."
+            },
+            {
+              "name": "onCheckedChange",
+              "type": "(event: UseRadioButtonChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the radio button's checked state changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonState": {
+          "description": "Defines valid state in useRadioButton.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "checked",
+              "type": "boolean",
+              "default": "",
+              "description": "The checked state of the useRadioButton."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonInputProps": {
+          "description": "Props for the RadioButton native input element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "id",
+              "type": "string",
+              "default": "",
+              "description": "The id attribute of the input element."
+            },
+            {
+              "name": "type",
+              "type": "\"radio\"",
+              "default": "",
+              "description": "The input type."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The value of the radio button."
+            },
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "The name attribute of the input."
+            },
+            {
+              "name": "checked",
+              "type": "boolean",
+              "default": "",
+              "description": "The checked state of the input."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard navigation."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is disabled."
+            },
+            {
+              "name": "readOnly",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is read-only."
+            },
+            {
+              "name": "required",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is required."
+            },
+            {
+              "name": "aria-labelledby",
+              "type": "string",
+              "default": "",
+              "description": "ARIA labelledby reference."
+            },
+            {
+              "name": "aria-label",
+              "type": "string",
+              "default": "",
+              "description": "ARIA label text."
+            },
+            {
+              "name": "aria-invalid",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the input is in an invalid state."
+            },
+            {
+              "name": "data-checked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is checked."
+            },
+            {
+              "name": "data-unchecked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is unchecked."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is in an invalid state."
+            },
+            {
+              "name": "onFocus",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Focus event handler."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Blur event handler."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: ChangeEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Change event handler. Undefined when readOnly."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonBoxProps": {
+          "description": "Data attribute props for the RadioButton box element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "data-checked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is checked."
+            },
+            {
+              "name": "data-unchecked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is unchecked."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is in an invalid state."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonIndicatorProps": {
+          "description": "Data attribute props for the RadioButton indicator element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "data-checked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is checked."
+            },
+            {
+              "name": "data-unchecked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is unchecked."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is in an invalid state."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonRootProps": {
+          "description": "Data attribute props for the RadioButton root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            },
+            {
+              "name": "data-checked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is checked."
+            },
+            {
+              "name": "data-unchecked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is unchecked."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "string",
+              "default": "",
+              "description": "Present when the radio button is in an invalid state."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonExposes": {
+          "description": "Defines the methods and properties exposed by useRadioButton.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseRadioButtonState",
+              "default": "",
+              "description": "The state of the useRadioButton."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: ChangeEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Callback fired when the useRadioButton's checked state changes."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseRadioButtonRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element.\nIncludes data-checked/unchecked, data-disabled, data-invalid."
+            },
+            {
+              "name": "inputProps",
+              "type": "UseRadioButtonInputProps",
+              "default": "",
+              "description": "Pre-built props for the native input element.\nIncludes type, value, checked, ARIA attributes, data attributes, and event handlers."
+            },
+            {
+              "name": "boxProps",
+              "type": "UseRadioButtonBoxProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the box element.\nIncludes data-checked/unchecked, data-disabled, data-invalid."
+            },
+            {
+              "name": "indicatorProps",
+              "type": "UseRadioButtonIndicatorProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the indicator element.\nIncludes data-checked/unchecked, data-disabled, data-invalid."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseRadioButtonInstance": {
+          "description": "Instance of useRadioButton headless.",
+          "values": "HeadlessInstance<UseRadioButtonProps, UseRadioButtonState, UseRadioButtonExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "useRadioButtonGroup",
+    "source": "apps/showcase/assets/apidoc/useradiobuttongroup.json",
+    "data": {
+      "description": "The useRadioButtonGroup manages the state and functionality of a radio button group component.",
+      "interfaces": {
+        "UseRadioButtonGroupValueChangeEvent": {
+          "description": "Event fired when the radio button group's value changes.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "SyntheticEvent",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The value of the radio button group."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonGroupProps": {
+          "description": "Defines valid properties in useRadioButtonGroup.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "Value of the radio button group."
+            },
+            {
+              "name": "defaultValue",
+              "type": "unknown",
+              "default": "",
+              "description": "The default value of the radio button group."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseRadioButtonGroupValueChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the radio button group's value state changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonGroupState": {
+          "description": "Defines valid state in useRadioButtonGroup.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The value state of the useRadioButtonGroup."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonGroupRootProps": {
+          "description": "Data attribute props for the RadioButtonGroup root element.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-scope",
+              "type": "string",
+              "default": "",
+              "description": "Component scope identifier."
+            },
+            {
+              "name": "data-part",
+              "type": "string",
+              "default": "",
+              "description": "Component part identifier."
+            }
+          ],
+          "methods": []
+        },
+        "UseRadioButtonGroupExposes": {
+          "description": "Defines the methods and properties exposed by useRadioButtonGroup.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseRadioButtonGroupState",
+              "default": "",
+              "description": "The state of the useRadioButtonGroup."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseRadioButtonGroupRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element."
+            },
+            {
+              "name": "updateChange",
+              "type": "(event: UseRadioButtonChangeEvent<SyntheticEvent<Element, Event>> & { value: unknown }) => void",
+              "default": "",
+              "description": "Updates the value of the radio button group."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseRadioButtonGroupInstance": {
+          "description": "Instance of useRadioButtonGroup headless.",
+          "values": "HeadlessInstance<UseRadioButtonGroupProps, UseRadioButtonGroupState, UseRadioButtonGroupExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]