@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,725 @@
+[
+  {
+    "name": "ProgressSpinnerRange",
+    "source": "apps/showcase/assets/apidoc/progressspinnerrange.json",
+    "data": {
+      "description": "ProgressSpinnerRange is a component that displays the progress range circle.",
+      "interfaces": {
+        "ProgressSpinnerRangePassThrough": {
+          "description": "Defines passthrough(pt) options of ProgressSpinnerRange component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "ProgressSpinnerRangePassThroughType<HTMLAttributes<SVGCircleElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "ProgressSpinnerRangeProps": {
+          "description": "Defines valid properties in ProgressSpinnerRange component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<ProgressSpinnerRangeInstance, unknown, ProgressSpinnerRangePassThrough>",
+          "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?: ProgressSpinnerRangeInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: ProgressSpinnerRangeInstance) => 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": "ProgressSpinnerRangeInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<ProgressSpinnerRangePassThrough>",
+              "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: ProgressSpinnerRangeInstance) => 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": []
+        },
+        "ProgressSpinnerRangeState": {
+          "description": "Defines valid state in ProgressSpinnerRange component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "ProgressSpinnerRangeExposes": {
+          "description": "Defines the methods and properties exposed by ProgressSpinnerRange component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "progressspinner",
+              "type": "ProgressSpinnerRootInstance",
+              "default": "",
+              "description": "The ProgressSpinner component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "ProgressSpinnerRangePassThroughType": {
+          "description": "Defines passthrough(pt) options type in ProgressSpinnerRange component.",
+          "values": "PassThroughType<ProgressSpinnerRangeInstance, E>"
+        },
+        "ProgressSpinnerRangeInstance": {
+          "description": "Instance of ProgressSpinnerRange component.",
+          "values": "ComponentInstance<ProgressSpinnerRangeProps, ProgressSpinnerRangeState, ProgressSpinnerRangeExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "ProgressSpinnerRoot",
+    "source": "apps/showcase/assets/apidoc/progressspinnerroot.json",
+    "data": {
+      "description": "ProgressSpinner is a process status indicator that supports both determinate and indeterminate modes.",
+      "interfaces": {
+        "ProgressSpinnerRootPassThrough": {
+          "description": "Defines passthrough(pt) options of ProgressSpinner component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "ProgressSpinnerRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            },
+            {
+              "name": "circle",
+              "type": "ProgressSpinnerRootPassThroughType<HTMLAttributes<SVGSVGElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the circle's DOM element."
+            },
+            {
+              "name": "circleTrack",
+              "type": "ProgressSpinnerRootPassThroughType<HTMLAttributes<SVGCircleElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the circle track's DOM element."
+            },
+            {
+              "name": "circleRange",
+              "type": "ProgressSpinnerRootPassThroughType<HTMLAttributes<SVGCircleElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the circle range's DOM element."
+            },
+            {
+              "name": "value",
+              "type": "ProgressSpinnerRootPassThroughType<HTMLAttributes<SVGTextElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the value's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "ProgressSpinnerRootProps": {
+          "description": "Defines valid properties in ProgressSpinner component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<ProgressSpinnerRootInstance, UseProgressSpinnerProps, ProgressSpinnerRootPassThrough>",
+          "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?: ProgressSpinnerRootInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: ProgressSpinnerRootInstance) => 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": "ProgressSpinnerRootInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<ProgressSpinnerRootPassThrough>",
+              "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: ProgressSpinnerRootInstance) => 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": "value",
+              "type": "number",
+              "default": "null",
+              "description": "Current value. When null, the component is in indeterminate mode."
+            },
+            {
+              "name": "min",
+              "type": "number",
+              "default": "0",
+              "description": "Minimum value."
+            },
+            {
+              "name": "max",
+              "type": "number",
+              "default": "100",
+              "description": "Maximum value."
+            },
+            {
+              "name": "strokeWidth",
+              "type": "number",
+              "default": "4",
+              "description": "Width of the circle stroke."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the component is disabled."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "ProgressSpinnerRootState": {
+          "description": "Defines valid state in ProgressSpinner component.",
+          "relatedProp": "",
+          "extendedTypes": "UseProgressSpinnerState",
+          "props": [
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "Current value."
+            },
+            {
+              "name": "percent",
+              "type": "number",
+              "default": "",
+              "description": "Computed percentage (0-100)."
+            },
+            {
+              "name": "indeterminate",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the progress is indeterminate."
+            }
+          ],
+          "methods": []
+        },
+        "ProgressSpinnerRootExposes": {
+          "description": "Defines the methods and properties exposed by ProgressSpinner component.",
+          "relatedProp": "",
+          "extendedTypes": "UseProgressSpinnerExposes",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseProgressSpinnerState",
+              "default": "",
+              "description": "The current state of the circular progress."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseProgressSpinnerRootProps",
+              "default": "",
+              "description": "Pre-built props for the root element."
+            },
+            {
+              "name": "circleProps",
+              "type": "UseProgressSpinnerCircleProps",
+              "default": "",
+              "description": "Pre-built props for the SVG circle container element."
+            },
+            {
+              "name": "circleTrackProps",
+              "type": "UseProgressSpinnerCircleTrackProps",
+              "default": "",
+              "description": "Pre-built props for the SVG circle track element."
+            },
+            {
+              "name": "circleRangeProps",
+              "type": "UseProgressSpinnerCircleRangeProps",
+              "default": "",
+              "description": "Pre-built props for the SVG circle range element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "ProgressSpinnerRootPassThroughType": {
+          "description": "Defines passthrough(pt) options type in ProgressSpinner component.",
+          "values": "PassThroughType<ProgressSpinnerRootInstance, E>"
+        },
+        "ProgressSpinnerRootInstance": {
+          "description": "Instance of ProgressSpinner component.",
+          "values": "ComponentInstance<ProgressSpinnerRootProps, ProgressSpinnerRootState, ProgressSpinnerRootExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "ProgressSpinnerTrack",
+    "source": "apps/showcase/assets/apidoc/progressspinnertrack.json",
+    "data": {
+      "description": "ProgressSpinnerTrack is a component that displays the background track circle.",
+      "interfaces": {
+        "ProgressSpinnerTrackPassThrough": {
+          "description": "Defines passthrough(pt) options of ProgressSpinnerTrack component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "ProgressSpinnerTrackPassThroughType<HTMLAttributes<SVGCircleElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "ProgressSpinnerTrackProps": {
+          "description": "Defines valid properties in ProgressSpinnerTrack component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<ProgressSpinnerTrackInstance, unknown, ProgressSpinnerTrackPassThrough>",
+          "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?: ProgressSpinnerTrackInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: ProgressSpinnerTrackInstance) => 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": "ProgressSpinnerTrackInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<ProgressSpinnerTrackPassThrough>",
+              "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: ProgressSpinnerTrackInstance) => 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": []
+        },
+        "ProgressSpinnerTrackState": {
+          "description": "Defines valid state in ProgressSpinnerTrack component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "ProgressSpinnerTrackExposes": {
+          "description": "Defines the methods and properties exposed by ProgressSpinnerTrack component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "progressspinner",
+              "type": "ProgressSpinnerRootInstance",
+              "default": "",
+              "description": "The ProgressSpinner component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "ProgressSpinnerTrackPassThroughType": {
+          "description": "Defines passthrough(pt) options type in ProgressSpinnerTrack component.",
+          "values": "PassThroughType<ProgressSpinnerTrackInstance, E>"
+        },
+        "ProgressSpinnerTrackInstance": {
+          "description": "Instance of ProgressSpinnerTrack component.",
+          "values": "ComponentInstance<ProgressSpinnerTrackProps, ProgressSpinnerTrackState, ProgressSpinnerTrackExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "ProgressSpinnerValue",
+    "source": "apps/showcase/assets/apidoc/progressspinnervalue.json",
+    "data": {
+      "description": "ProgressSpinnerValue is a component that displays the value as text.",
+      "interfaces": {
+        "ProgressSpinnerValuePassThrough": {
+          "description": "Defines passthrough(pt) options of ProgressSpinnerValue component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "ProgressSpinnerValuePassThroughType<HTMLAttributes<SVGTextElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "ProgressSpinnerValueProps": {
+          "description": "Defines valid properties in ProgressSpinnerValue component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<ProgressSpinnerValueInstance, unknown, ProgressSpinnerValuePassThrough>",
+          "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?: ProgressSpinnerValueInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: ProgressSpinnerValueInstance) => 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": "ProgressSpinnerValueInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<ProgressSpinnerValuePassThrough>",
+              "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: ProgressSpinnerValueInstance) => 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": []
+        },
+        "ProgressSpinnerValueState": {
+          "description": "Defines valid state in ProgressSpinnerValue component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "ProgressSpinnerValueExposes": {
+          "description": "Defines the methods and properties exposed by ProgressSpinnerValue component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "progressspinner",
+              "type": "ProgressSpinnerRootInstance",
+              "default": "",
+              "description": "The ProgressSpinner component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "ProgressSpinnerValuePassThroughType": {
+          "description": "Defines passthrough(pt) options type in ProgressSpinnerValue component.",
+          "values": "PassThroughType<ProgressSpinnerValueInstance, E>"
+        },
+        "ProgressSpinnerValueInstance": {
+          "description": "Instance of ProgressSpinnerValue component.",
+          "values": "ComponentInstance<ProgressSpinnerValueProps, ProgressSpinnerValueState, ProgressSpinnerValueExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]