@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,697 @@
+[
+  {
+    "name": "CheckboxBox",
+    "source": "apps/showcase/assets/apidoc/checkboxbox.json",
+    "data": {
+      "description": "CheckboxBox is a component that displays a box inside a Checkbox.",
+      "interfaces": {
+        "CheckboxBoxPassThrough": {
+          "description": "Defines passthrough(pt) options of CheckboxBox component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "CheckboxBoxPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "CheckboxBoxProps": {
+          "description": "Defines valid properties in CheckboxBox component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<CheckboxBoxInstance, unknown, CheckboxBoxPassThrough>",
+          "props": [
+            {
+              "name": "ref",
+              "type": "Ref<unknown>",
+              "default": "",
+              "description": "The reference to the component instance."
+            },
+            {
+              "name": "pIf",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether the component should be rendered."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties | ((instance?: CheckboxBoxInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: CheckboxBoxInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
+              "default": "",
+              "description": "The component type to render."
+            },
+            {
+              "name": "asChild",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the component should be rendered as a child component."
+            },
+            {
+              "name": "instance",
+              "type": "CheckboxBoxInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<CheckboxBoxPassThrough>",
+              "default": "",
+              "description": "The pass-through props to pass to the component."
+            },
+            {
+              "name": "ptOptions",
+              "type": "PassThroughOptions",
+              "default": "",
+              "description": "The pass-through options to pass to the component."
+            },
+            {
+              "name": "unstyled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component should be rendered without classes."
+            },
+            {
+              "name": "dt",
+              "type": "unknown",
+              "default": "",
+              "description": "The design token to use for the component."
+            },
+            {
+              "name": "styles",
+              "type": "StylesOptions<ComponentInstance>",
+              "default": "",
+              "description": "The styles to use for the component."
+            },
+            {
+              "name": "render",
+              "type": "(instance: CheckboxBoxInstance) => ReactNode",
+              "default": "",
+              "description": "The render function to render the component with instance access."
+            },
+            {
+              "name": "children",
+              "type": "any",
+              "default": "",
+              "description": "The children to render.\n\nAccepts  `React.ReactNode`  for static content or a render function  `(instance: I) => React.ReactNode`  for instance access.\nTyped as  `any`  to avoid JSX type errors when used directly in templates."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "CheckboxBoxState": {
+          "description": "Defines valid state in CheckboxBox component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "CheckboxBoxExposes": {
+          "description": "Defines the methods and properties exposed by CheckboxBox component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "checkbox",
+              "type": "CheckboxRootInstance",
+              "default": "",
+              "description": "The Checkbox component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "CheckboxBoxPassThroughType": {
+          "description": "Defines passthrough(pt) options type in CheckboxBox component.",
+          "values": "PassThroughType<CheckboxBoxInstance, E>"
+        },
+        "CheckboxBoxInstance": {
+          "description": "Instance of CheckboxBox component.",
+          "values": "ComponentInstance<CheckboxBoxProps, CheckboxBoxState, CheckboxBoxExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "CheckboxIndicator",
+    "source": "apps/showcase/assets/apidoc/checkboxindicator.json",
+    "data": {
+      "description": "CheckboxIndicator is a component that displays an indicator inside a Checkbox.",
+      "interfaces": {
+        "CheckboxIndicatorPassThrough": {
+          "description": "Defines passthrough(pt) options of CheckboxIndicator component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "CheckboxIndicatorPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "CheckboxIndicatorProps": {
+          "description": "Defines valid properties in CheckboxIndicator component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<CheckboxIndicatorInstance, unknown, CheckboxIndicatorPassThrough>",
+          "props": [
+            {
+              "name": "ref",
+              "type": "Ref<unknown>",
+              "default": "",
+              "description": "The reference to the component instance."
+            },
+            {
+              "name": "pIf",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether the component should be rendered."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties | ((instance?: CheckboxIndicatorInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: CheckboxIndicatorInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
+              "default": "",
+              "description": "The component type to render."
+            },
+            {
+              "name": "asChild",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the component should be rendered as a child component."
+            },
+            {
+              "name": "instance",
+              "type": "CheckboxIndicatorInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<CheckboxIndicatorPassThrough>",
+              "default": "",
+              "description": "The pass-through props to pass to the component."
+            },
+            {
+              "name": "ptOptions",
+              "type": "PassThroughOptions",
+              "default": "",
+              "description": "The pass-through options to pass to the component."
+            },
+            {
+              "name": "unstyled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component should be rendered without classes."
+            },
+            {
+              "name": "dt",
+              "type": "unknown",
+              "default": "",
+              "description": "The design token to use for the component."
+            },
+            {
+              "name": "styles",
+              "type": "StylesOptions<ComponentInstance>",
+              "default": "",
+              "description": "The styles to use for the component."
+            },
+            {
+              "name": "render",
+              "type": "(instance: CheckboxIndicatorInstance) => ReactNode",
+              "default": "",
+              "description": "The render function to render the component with instance access."
+            },
+            {
+              "name": "children",
+              "type": "any",
+              "default": "",
+              "description": "The children to render.\n\nAccepts  `React.ReactNode`  for static content or a render function  `(instance: I) => React.ReactNode`  for instance access.\nTyped as  `any`  to avoid JSX type errors when used directly in templates."
+            },
+            {
+              "name": "match",
+              "type": "\"checked\" | \"indeterminate\" | \"unchecked\" | \"always\"",
+              "default": "",
+              "description": "Determines the visibility of the indicator based on the state of the checkbox. Valid values are:\n- \"checked\": Indicator is visible when the checkbox is checked.\n- \"unchecked\": Indicator is visible when the checkbox is unchecked.\n- \"indeterminate\": Indicator is visible when the checkbox is in an indeterminate state.\n- \"always\": Indicator is always visible."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "CheckboxIndicatorState": {
+          "description": "Defines valid state in CheckboxIndicator component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "CheckboxIndicatorExposes": {
+          "description": "Defines the methods and properties exposed by CheckboxIndicator component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "checkbox",
+              "type": "CheckboxRootInstance",
+              "default": "",
+              "description": "The Checkbox component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "CheckboxIndicatorPassThroughType": {
+          "description": "Defines passthrough(pt) options type in CheckboxIndicator component.",
+          "values": "PassThroughType<CheckboxIndicatorInstance, E>"
+        },
+        "CheckboxIndicatorInstance": {
+          "description": "Instance of CheckboxIndicator component.",
+          "values": "ComponentInstance<CheckboxIndicatorProps, CheckboxIndicatorState, CheckboxIndicatorExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "CheckboxRoot",
+    "source": "apps/showcase/assets/apidoc/checkboxroot.json",
+    "data": {
+      "description": "Checkbox is an extension to standard checkbox element with theming.",
+      "interfaces": {
+        "CheckboxRootPassThrough": {
+          "description": "Defines passthrough(pt) options of CheckboxRoot component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "CheckboxRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            },
+            {
+              "name": "input",
+              "type": "CheckboxRootPassThroughType<InputHTMLAttributes<HTMLInputElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the input's DOM element."
+            },
+            {
+              "name": "box",
+              "type": "CheckboxRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the box's DOM element."
+            },
+            {
+              "name": "indicator",
+              "type": "CheckboxRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the indicator's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "CheckboxRootChangeEvent": {
+          "description": "Event fired when the checkbox's checked state changes.",
+          "relatedProp": "",
+          "extendedTypes": "UseCheckboxChangeEvent<React.ChangeEvent<HTMLInputElement>>",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "ChangeEvent",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "checked",
+              "type": "boolean",
+              "default": "",
+              "description": "The checked state of the checkbox."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "Value of the checkbox."
+            }
+          ],
+          "methods": []
+        },
+        "CheckboxRootProps": {
+          "description": "Defines valid properties in CheckboxRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<CheckboxRootInstance, Omit<UseCheckboxProps, \"onCheckedChange\">, CheckboxRootPassThrough>",
+          "props": [
+            {
+              "name": "ref",
+              "type": "Ref<unknown>",
+              "default": "",
+              "description": "The reference to the component instance."
+            },
+            {
+              "name": "pIf",
+              "type": "boolean",
+              "default": "true",
+              "description": "Whether the component should be rendered."
+            },
+            {
+              "name": "style",
+              "type": "CSSProperties | ((instance?: CheckboxRootInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: CheckboxRootInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
+              "default": "",
+              "description": "The component type to render."
+            },
+            {
+              "name": "asChild",
+              "type": "boolean",
+              "default": "false",
+              "description": "Whether the component should be rendered as a child component."
+            },
+            {
+              "name": "instance",
+              "type": "CheckboxRootInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<CheckboxRootPassThrough>",
+              "default": "",
+              "description": "The pass-through props to pass to the component."
+            },
+            {
+              "name": "ptOptions",
+              "type": "PassThroughOptions",
+              "default": "",
+              "description": "The pass-through options to pass to the component."
+            },
+            {
+              "name": "unstyled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component should be rendered without classes."
+            },
+            {
+              "name": "dt",
+              "type": "unknown",
+              "default": "",
+              "description": "The design token to use for the component."
+            },
+            {
+              "name": "styles",
+              "type": "StylesOptions<ComponentInstance>",
+              "default": "",
+              "description": "The styles to use for the component."
+            },
+            {
+              "name": "render",
+              "type": "(instance: CheckboxRootInstance) => ReactNode",
+              "default": "",
+              "description": "The render function to render the component with instance access."
+            },
+            {
+              "name": "children",
+              "type": "any",
+              "default": "",
+              "description": "The children to render.\n\nAccepts  `React.ReactNode`  for static content or a render function  `(instance: I) => React.ReactNode`  for instance access.\nTyped as  `any`  to avoid JSX type errors when used directly in templates."
+            },
+            {
+              "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": "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": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Tab index for keyboard navigation."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "Value of the checkbox."
+            },
+            {
+              "name": "name",
+              "type": "string",
+              "default": "",
+              "description": "The name of the checkbox."
+            },
+            {
+              "name": "size",
+              "type": "\"small\" | \"large\" | \"normal\"",
+              "default": "",
+              "description": "Defines the size of the checkbox."
+            },
+            {
+              "name": "variant",
+              "type": "\"outlined\" | \"filled\"",
+              "default": "",
+              "description": "Specifies the input variant of the component."
+            },
+            {
+              "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": "invalid",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the component should have invalid state style."
+            },
+            {
+              "name": "inputId",
+              "type": "string",
+              "default": "",
+              "description": "Identifier of the underlying input element."
+            },
+            {
+              "name": "inputStyle",
+              "type": "CSSProperties",
+              "default": "",
+              "description": "Inline style of the input field."
+            },
+            {
+              "name": "inputClassName",
+              "type": "string",
+              "default": "",
+              "description": "Style class of the input field."
+            },
+            {
+              "name": "ariaLabel",
+              "type": "string",
+              "default": "",
+              "description": "Establishes a string value that labels the component."
+            },
+            {
+              "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": "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: CheckboxRootChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the checkbox's checked state changes."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "CheckboxRootState": {
+          "description": "Defines valid state in CheckboxRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "UseCheckboxState",
+          "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": []
+        },
+        "CheckboxRootExposes": {
+          "description": "Defines the methods and properties exposed by CheckboxRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "UseCheckboxExposes",
+          "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": {
+        "CheckboxRootPassThroughType": {
+          "description": "Defines passthrough(pt) options type in CheckboxRoot component.",
+          "values": "PassThroughType<CheckboxRootInstance, E>"
+        },
+        "CheckboxRootInstance": {
+          "description": "Instance of CheckboxRoot component.",
+          "values": "ComponentInstance<CheckboxRootProps, CheckboxRootState, CheckboxRootExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]