@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,593 @@
+[
+  {
+    "name": "useCheckbox",
+    "source": "apps/showcase/assets/apidoc/usecheckbox.json",
+    "data": {
+      "description": "The useCheckbox manages the state and functionality of a checkbox component.",
+      "interfaces": {
+        "UseCheckboxChangeEvent": {
+          "description": "Event fired when the checkbox'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 checkbox."
+            }
+          ],
+          "methods": []
+        },
+        "UseCheckboxProps": {
+          "description": "Defines valid properties in useCheckbox.",
+          "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": "indeterminate",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies input state as indeterminate."
+            },
+            {
+              "name": "trueValue",
+              "type": "string | number | boolean",
+              "default": "true",
+              "description": "Value in checked state."
+            },
+            {
+              "name": "falseValue",
+              "type": "string | number | boolean",
+              "default": "false",
+              "description": "Value in unchecked state."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "Value of the checkbox."
+            },
+            {
+              "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 checkbox is focused."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Callback function that is called when the checkbox loses focus."
+            },
+            {
+              "name": "onCheckedChange",
+              "type": "(event: UseCheckboxChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the checkbox's checked state changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseCheckboxState": {
+          "description": "Defines valid state in useCheckbox.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "checked",
+              "type": "boolean",
+              "default": "",
+              "description": "The checked state of the useCheckbox."
+            },
+            {
+              "name": "indeterminate",
+              "type": "boolean",
+              "default": "",
+              "description": "The indeterminate state of the useCheckbox."
+            }
+          ],
+          "methods": []
+        },
+        "UseCheckboxInputProps": {
+          "description": "Props for the Checkbox 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": "\"checkbox\"",
+              "default": "",
+              "description": "The input type."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "The value of the checkbox."
+            },
+            {
+              "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": "aria-checked",
+              "type": "\"mixed\"",
+              "default": "",
+              "description": "ARIA checked state, 'mixed' when indeterminate."
+            },
+            {
+              "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": []
+        },
+        "UseCheckboxBoxProps": {
+          "description": "Data attribute props for the Checkbox 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 checkbox is checked."
+            },
+            {
+              "name": "data-unchecked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is unchecked."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is in an invalid state."
+            },
+            {
+              "name": "data-indeterminate",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is indeterminate (from props)."
+            }
+          ],
+          "methods": []
+        },
+        "UseCheckboxIndicatorProps": {
+          "description": "Data attribute props for the Checkbox 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 checkbox is checked."
+            },
+            {
+              "name": "data-unchecked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is unchecked."
+            },
+            {
+              "name": "data-indeterminate",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is indeterminate (from state)."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is in an invalid state."
+            }
+          ],
+          "methods": []
+        },
+        "UseCheckboxRootProps": {
+          "description": "Data attribute props for the Checkbox 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 checkbox is checked."
+            },
+            {
+              "name": "data-unchecked",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is unchecked."
+            },
+            {
+              "name": "data-disabled",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is disabled."
+            },
+            {
+              "name": "data-invalid",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is in an invalid state."
+            },
+            {
+              "name": "data-indeterminate",
+              "type": "string",
+              "default": "",
+              "description": "Present when the checkbox is indeterminate."
+            }
+          ],
+          "methods": []
+        },
+        "UseCheckboxExposes": {
+          "description": "Defines the methods and properties exposed by useCheckbox.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseCheckboxState",
+              "default": "",
+              "description": "The state of the useCheckbox."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: ChangeEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Callback fired when the useCheckbox's checked state changes."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseCheckboxRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element.\nIncludes data-checked/unchecked, data-disabled, data-invalid, data-indeterminate."
+            },
+            {
+              "name": "inputProps",
+              "type": "UseCheckboxInputProps",
+              "default": "",
+              "description": "Pre-built props for the native input element.\nIncludes type, value, checked, ARIA attributes, and event handlers."
+            },
+            {
+              "name": "boxProps",
+              "type": "UseCheckboxBoxProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the box element.\nIncludes data-checked/unchecked, data-disabled, data-invalid, data-indeterminate."
+            },
+            {
+              "name": "indicatorProps",
+              "type": "UseCheckboxIndicatorProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the indicator element.\nIncludes data-checked/unchecked, data-indeterminate (from state), data-disabled, data-invalid."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseCheckboxInstance": {
+          "description": "Instance of useCheckbox headless.",
+          "values": "HeadlessInstance<UseCheckboxProps, UseCheckboxState, UseCheckboxExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "useCheckboxGroup",
+    "source": "apps/showcase/assets/apidoc/usecheckboxgroup.json",
+    "data": {
+      "description": "The useCheckboxGroup manages the state and functionality of a checkbox group component.",
+      "interfaces": {
+        "UseCheckboxGroupChangeEvent": {
+          "description": "Event fired when the checkbox 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 checkbox group."
+            }
+          ],
+          "methods": []
+        },
+        "UseCheckboxGroupProps": {
+          "description": "Defines valid properties in useCheckboxGroup.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown[]",
+              "default": "",
+              "description": "Value of the checkbox group."
+            },
+            {
+              "name": "defaultValue",
+              "type": "unknown[]",
+              "default": "",
+              "description": "The default value of the checkbox group."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: UseCheckboxGroupChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the checkboxgroup's value state changes."
+            }
+          ],
+          "methods": []
+        },
+        "UseCheckboxGroupState": {
+          "description": "Defines valid state in useCheckboxGroup.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "value",
+              "type": "unknown[]",
+              "default": "",
+              "description": "Value of the checkbox group."
+            }
+          ],
+          "methods": []
+        },
+        "UseCheckboxGroupRootProps": {
+          "description": "Data attribute props for the CheckboxGroup 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": []
+        },
+        "UseCheckboxGroupExposes": {
+          "description": "Defines the methods and properties exposed by useCheckboxGroup.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseCheckboxGroupState",
+              "default": "",
+              "description": "The state of the checkbox group."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseCheckboxGroupRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element."
+            },
+            {
+              "name": "updateChange",
+              "type": "(event: UseCheckboxChangeEvent<SyntheticEvent<Element, Event>> & { value: unknown }) => void",
+              "default": "",
+              "description": "Updates the value of the checkbox group."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "UseCheckboxGroupInstance": {
+          "description": "Instance of useCheckboxGroup headless.",
+          "values": "HeadlessInstance<UseCheckboxGroupProps, UseCheckboxGroupState, UseCheckboxGroupExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]