@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,681 @@
+[
+  {
+    "name": "ToggleSwitchControl",
+    "source": "apps/showcase/assets/apidoc/toggleswitchcontrol.json",
+    "data": {
+      "description": "ToggleSwitchControl is a component that displays a container for handle.",
+      "interfaces": {
+        "ToggleSwitchControlPassThrough": {
+          "description": "Defines passthrough(pt) options of ToggleSwitchControl component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "ToggleSwitchControlPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "ToggleSwitchControlProps": {
+          "description": "Defines valid properties in ToggleSwitchControl component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<ToggleSwitchControlInstance, unknown, ToggleSwitchControlPassThrough>",
+          "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?: ToggleSwitchControlInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: ToggleSwitchControlInstance) => 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": "ToggleSwitchControlInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<ToggleSwitchControlPassThrough>",
+              "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: ToggleSwitchControlInstance) => 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": []
+        },
+        "ToggleSwitchControlState": {
+          "description": "Defines valid state in ToggleSwitchControl component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "ToggleSwitchControlExtraProps": {
+          "description": "Pre-built extra props for the toggle switch control element (excluding className).",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-invalid",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when invalid."
+            }
+          ],
+          "methods": []
+        },
+        "ToggleSwitchControlExposes": {
+          "description": "Defines the methods and properties exposed by ToggleSwitchControl component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "toggleSwitch",
+              "type": "ToggleSwitchRootInstance",
+              "default": "",
+              "description": "The ToggleSwitch component instance."
+            },
+            {
+              "name": "extraControlProps",
+              "type": "ToggleSwitchControlExtraProps",
+              "default": "",
+              "description": "Pre-built extra props for the control element (excluding className)."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "ToggleSwitchControlPassThroughType": {
+          "description": "Defines passthrough(pt) options type in ToggleSwitchControl component.",
+          "values": "PassThroughType<ToggleSwitchControlInstance, E>"
+        },
+        "ToggleSwitchControlInstance": {
+          "description": "Instance of ToggleSwitchControl component.",
+          "values": "ComponentInstance<ToggleSwitchControlProps, ToggleSwitchControlState, ToggleSwitchControlExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "ToggleSwitchHandle",
+    "source": "apps/showcase/assets/apidoc/toggleswitchhandle.json",
+    "data": {
+      "description": "ToggleSwitchHandle is a component that displays ahandle.",
+      "interfaces": {
+        "ToggleSwitchHandlePassThrough": {
+          "description": "Defines passthrough(pt) options of ToggleSwitchHandle component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "ToggleSwitchHandlePassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "ToggleSwitchHandleProps": {
+          "description": "Defines valid properties in ToggleSwitchHandle component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<ToggleSwitchHandleInstance, unknown, ToggleSwitchHandlePassThrough>",
+          "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?: ToggleSwitchHandleInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: ToggleSwitchHandleInstance) => 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": "ToggleSwitchHandleInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<ToggleSwitchHandlePassThrough>",
+              "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: ToggleSwitchHandleInstance) => 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": []
+        },
+        "ToggleSwitchHandleState": {
+          "description": "Defines valid state in ToggleSwitchHandle component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "ToggleSwitchHandleExtraProps": {
+          "description": "Pre-built extra props for the toggle switch handle element (excluding className).",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "data-invalid",
+              "type": "\"\"",
+              "default": "",
+              "description": "Data attribute when invalid."
+            }
+          ],
+          "methods": []
+        },
+        "ToggleSwitchHandleExposes": {
+          "description": "Defines the methods and properties exposed by ToggleSwitchHandle component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "toggleSwitch",
+              "type": "ToggleSwitchRootInstance",
+              "default": "",
+              "description": "The ToggleSwitch component instance."
+            },
+            {
+              "name": "extraHandleProps",
+              "type": "ToggleSwitchHandleExtraProps",
+              "default": "",
+              "description": "Pre-built extra props for the handle element (excluding className)."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "ToggleSwitchHandlePassThroughType": {
+          "description": "Defines passthrough(pt) options type in ToggleSwitchHandle component.",
+          "values": "PassThroughType<ToggleSwitchHandleInstance, E>"
+        },
+        "ToggleSwitchHandleInstance": {
+          "description": "Instance of ToggleSwitchHandle component.",
+          "values": "ComponentInstance<ToggleSwitchHandleProps, ToggleSwitchHandleState, ToggleSwitchHandleExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "ToggleSwitchRoot",
+    "source": "apps/showcase/assets/apidoc/toggleswitchroot.json",
+    "data": {
+      "description": "ToggleSwitch component is used to select a boolean value.",
+      "interfaces": {
+        "ToggleSwitchRootPassThrough": {
+          "description": "Defines passthrough(pt) options of ToggleSwitch component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "ToggleSwitchRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            },
+            {
+              "name": "input",
+              "type": "ToggleSwitchRootPassThroughType<HTMLAttributes<HTMLElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the input's DOM element."
+            },
+            {
+              "name": "control",
+              "type": "ToggleSwitchRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the control's DOM element."
+            },
+            {
+              "name": "handle",
+              "type": "ToggleSwitchRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the handle's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "ToggleSwitchRootChangeEvent": {
+          "description": "Event fired when the toggle switch's checked state changes.",
+          "relatedProp": "",
+          "extendedTypes": "UseToggleSwitchChangeEvent<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 toggle switch."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "Value of the toggle switch."
+            }
+          ],
+          "methods": []
+        },
+        "ToggleSwitchRootProps": {
+          "description": "Defines valid properties in ToggleSwitch component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<ToggleSwitchRootInstance, Omit<UseToggleSwitchProps, \"onCheckedChange\">, ToggleSwitchRootPassThrough>",
+          "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?: ToggleSwitchRootInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: ToggleSwitchRootInstance) => 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": "ToggleSwitchRootInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<ToggleSwitchRootPassThrough>",
+              "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: ToggleSwitchRootInstance) => 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": "tabIndex",
+              "type": "number",
+              "default": "",
+              "description": "Index of the element in tabbing order."
+            },
+            {
+              "name": "value",
+              "type": "unknown",
+              "default": "",
+              "description": "Value of the toggle switch."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "false",
+              "description": "When present, it specifies that the element should be disabled."
+            },
+            {
+              "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 toggle switch is focused."
+            },
+            {
+              "name": "onBlur",
+              "type": "(event: FocusEvent<HTMLInputElement>) => void",
+              "default": "",
+              "description": "Callback function that is called when the toggle switch loses focus."
+            },
+            {
+              "name": "onCheckedChange",
+              "type": "(event: ToggleSwitchRootChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the toggle switch'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": []
+        },
+        "ToggleSwitchRootState": {
+          "description": "Defines valid state in ToggleSwitch component.",
+          "relatedProp": "",
+          "extendedTypes": "UseToggleSwitchState",
+          "props": [
+            {
+              "name": "checked",
+              "type": "boolean",
+              "default": "",
+              "description": "The checked state of the useToggleSwitch."
+            }
+          ],
+          "methods": []
+        },
+        "ToggleSwitchRootExposes": {
+          "description": "Defines the methods and properties exposed by ToggleSwitch component.",
+          "relatedProp": "",
+          "extendedTypes": "UseToggleSwitchExposes",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseToggleSwitchState",
+              "default": "",
+              "description": "The state of the useToggleSwitch."
+            },
+            {
+              "name": "onChange",
+              "type": "(event: UseToggleSwitchChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the useToggleSwitch's checked state changes."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseToggleSwitchRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element."
+            },
+            {
+              "name": "inputProps",
+              "type": "UseToggleSwitchInputProps",
+              "default": "",
+              "description": "Pre-built props for the input element."
+            },
+            {
+              "name": "controlProps",
+              "type": "UseToggleSwitchControlProps",
+              "default": "",
+              "description": "Pre-built props for the control element."
+            },
+            {
+              "name": "handleProps",
+              "type": "UseToggleSwitchHandleProps",
+              "default": "",
+              "description": "Pre-built props for the handle element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "ToggleSwitchRootPassThroughType": {
+          "description": "Defines passthrough(pt) options type in ToggleSwitch component.",
+          "values": "PassThroughType<ToggleSwitchRootInstance, E>"
+        },
+        "ToggleSwitchRootInstance": {
+          "description": "Instance of ToggleSwitch component.",
+          "values": "ComponentInstance<ToggleSwitchRootProps, ToggleSwitchRootState, ToggleSwitchRootExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]