@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,841 @@
+[
+  {
+    "name": "KnobRange",
+    "source": "apps/showcase/assets/apidoc/knobrange.json",
+    "data": {
+      "description": "KnobRange is a component that displays a range.",
+      "interfaces": {
+        "KnobRangePassThrough": {
+          "description": "Defines passthrough(pt) options of KnobRange component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "KnobRangePassThroughType<HTMLAttributes<SVGPathElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "KnobRangeProps": {
+          "description": "Defines valid properties in KnobRange component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<KnobRangeInstance, unknown, KnobRangePassThrough>",
+          "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?: KnobRangeInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: KnobRangeInstance) => 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": "KnobRangeInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<KnobRangePassThrough>",
+              "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: KnobRangeInstance) => 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": "color",
+              "type": "string",
+              "default": "",
+              "description": "Stroke color of the range arc. Overrides  `rangeColor`  from  `Knob.Root` ."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "KnobRangeState": {
+          "description": "Defines valid state in KnobRange component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "KnobRangeExposes": {
+          "description": "Defines the methods and properties exposed by KnobRange component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "knob",
+              "type": "KnobRootInstance",
+              "default": "",
+              "description": "The Knob component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "KnobRangePassThroughType": {
+          "description": "Defines passthrough(pt) options type in KnobRange component.",
+          "values": "PassThroughType<KnobRangeInstance, E>"
+        },
+        "KnobRangeInstance": {
+          "description": "Instance of KnobRange component.",
+          "values": "ComponentInstance<KnobRangeProps, KnobRangeState, KnobRangeExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "KnobRoot",
+    "source": "apps/showcase/assets/apidoc/knobroot.json",
+    "data": {
+      "description": "Knob is a form component to define number inputs with a dial.",
+      "interfaces": {
+        "KnobRootPassThrough": {
+          "description": "Defines passthrough(pt) options of Knob component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "KnobRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            },
+            {
+              "name": "svg",
+              "type": "KnobRootPassThroughType<HTMLAttributes<SVGSVGElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the svg's DOM element."
+            },
+            {
+              "name": "range",
+              "type": "KnobRootPassThroughType<HTMLAttributes<SVGPathElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the range's DOM element."
+            },
+            {
+              "name": "value",
+              "type": "KnobRootPassThroughType<HTMLAttributes<SVGPathElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the value's DOM element."
+            },
+            {
+              "name": "text",
+              "type": "KnobRootPassThroughType<HTMLAttributes<SVGTextElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the text's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "KnobRootChangeEvent": {
+          "description": "Event fired when the knob's value changes.",
+          "relatedProp": "",
+          "extendedTypes": "UseKnobChangeEvent",
+          "props": [
+            {
+              "name": "originalEvent",
+              "type": "Event | SyntheticEvent<Element, Event>",
+              "default": "",
+              "description": "The original event that triggered the change."
+            },
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "The value of the knob."
+            }
+          ],
+          "methods": []
+        },
+        "KnobRootProps": {
+          "description": "Defines valid properties in Knob component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<KnobRootInstance, Omit<UseKnobProps, \"onValueChange\">, KnobRootPassThrough>",
+          "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?: KnobRootInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: KnobRootInstance) => 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": "KnobRootInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<KnobRootPassThrough>",
+              "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: KnobRootInstance) => 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": "defaultValue",
+              "type": "number",
+              "default": "",
+              "description": "Value of the knob."
+            },
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "The default value of the knob."
+            },
+            {
+              "name": "size",
+              "type": "number",
+              "default": "100",
+              "description": "Size of the component in pixels."
+            },
+            {
+              "name": "step",
+              "type": "number",
+              "default": "1",
+              "description": "Step factor to increment/decrement the value."
+            },
+            {
+              "name": "min",
+              "type": "number",
+              "default": "0",
+              "description": "Mininum boundary value."
+            },
+            {
+              "name": "max",
+              "type": "number",
+              "default": "100",
+              "description": "Maximum boundary value."
+            },
+            {
+              "name": "strokeWidth",
+              "type": "number",
+              "default": "14",
+              "description": "Width of the knob stroke."
+            },
+            {
+              "name": "rangeColor",
+              "type": "string",
+              "default": "",
+              "description": "Background color of the range arc."
+            },
+            {
+              "name": "valueColor",
+              "type": "string",
+              "default": "",
+              "description": "Background color of the value arc."
+            },
+            {
+              "name": "textColor",
+              "type": "string",
+              "default": "",
+              "description": "Color of the value text."
+            },
+            {
+              "name": "tabIndex",
+              "type": "number",
+              "default": "0",
+              "description": "Index of the element in tabbing order."
+            },
+            {
+              "name": "invalid",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, it specifies that the component should have invalid state style."
+            },
+            {
+              "name": "disabled",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, it specifies that the component should be disabled."
+            },
+            {
+              "name": "readOnly",
+              "type": "boolean",
+              "default": "",
+              "description": "When present, it specifies that the component value cannot be edited."
+            },
+            {
+              "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": "Used to define a string that labels the element."
+            },
+            {
+              "name": "onValueChange",
+              "type": "(event: KnobRootChangeEvent) => void",
+              "default": "",
+              "description": "Callback fired when the knob's value changes."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "KnobRootState": {
+          "description": "Defines valid state in Knob component.",
+          "relatedProp": "",
+          "extendedTypes": "UseKnobState",
+          "props": [
+            {
+              "name": "value",
+              "type": "number",
+              "default": "",
+              "description": "The value of the knob."
+            }
+          ],
+          "methods": []
+        },
+        "KnobRootExposes": {
+          "description": "Defines the methods and properties exposed by Knob component.",
+          "relatedProp": "",
+          "extendedTypes": "UseKnobExposes",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseKnobState",
+              "default": "",
+              "description": "The state of the useKnob."
+            },
+            {
+              "name": "rangePath",
+              "type": "string",
+              "default": "",
+              "description": "The path string for the range arc of the knob."
+            },
+            {
+              "name": "valuePath",
+              "type": "string",
+              "default": "",
+              "description": "The path string for the value arc of the knob."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseKnobRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element.\nIncludes data-disabled, data-readonly."
+            },
+            {
+              "name": "svgProps",
+              "type": "UseKnobSvgProps",
+              "default": "",
+              "description": "Pre-built props for the SVG element.\nIncludes viewBox, role, ARIA attributes, size, tabIndex, and event handlers (when interactive)."
+            },
+            {
+              "name": "rangeProps",
+              "type": "UseKnobRangeProps",
+              "default": "",
+              "description": "Pre-built props for the range path element.\nIncludes d (path data), strokeWidth, and stroke color."
+            },
+            {
+              "name": "valueProps",
+              "type": "UseKnobValueProps",
+              "default": "",
+              "description": "Pre-built props for the value path element.\nIncludes d (path data), strokeWidth, and stroke color."
+            },
+            {
+              "name": "textProps",
+              "type": "UseKnobTextProps",
+              "default": "",
+              "description": "Pre-built props for the text element.\nIncludes x, y, textAnchor, and fill color."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "KnobRootPassThroughType": {
+          "description": "Defines passthrough(pt) options type in Knob component.",
+          "values": "PassThroughType<KnobRootInstance, E>"
+        },
+        "KnobRootInstance": {
+          "description": "Instance of Knob component.",
+          "values": "ComponentInstance<KnobRootProps, KnobRootState, KnobRootExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "KnobText",
+    "source": "apps/showcase/assets/apidoc/knobtext.json",
+    "data": {
+      "description": "KnobText is a component that displays a text.",
+      "interfaces": {
+        "KnobTextPassThrough": {
+          "description": "Defines passthrough(pt) options of KnobText component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "KnobTextPassThroughType<HTMLAttributes<SVGTextElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "KnobTextProps": {
+          "description": "Defines valid properties in KnobText component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<KnobTextInstance, unknown, KnobTextPassThrough>",
+          "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?: KnobTextInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: KnobTextInstance) => 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": "KnobTextInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<KnobTextPassThrough>",
+              "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: KnobTextInstance) => 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": "color",
+              "type": "string",
+              "default": "",
+              "description": "Fill color of the text. Overrides  `textColor`  from  `Knob.Root` ."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "KnobTextState": {
+          "description": "Defines valid state in KnobText component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "KnobTextExposes": {
+          "description": "Defines the methods and properties exposed by KnobText component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "knob",
+              "type": "KnobRootInstance",
+              "default": "",
+              "description": "The Knob component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "KnobTextPassThroughType": {
+          "description": "Defines passthrough(pt) options type in KnobText component.",
+          "values": "PassThroughType<KnobTextInstance, E>"
+        },
+        "KnobTextInstance": {
+          "description": "Instance of KnobText component.",
+          "values": "ComponentInstance<KnobTextProps, KnobTextState, KnobTextExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "KnobValue",
+    "source": "apps/showcase/assets/apidoc/knobvalue.json",
+    "data": {
+      "description": "KnobValue is a component that displays a value.",
+      "interfaces": {
+        "KnobValuePassThrough": {
+          "description": "Defines passthrough(pt) options of KnobValue component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "KnobValuePassThroughType<HTMLAttributes<SVGPathElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "KnobValueProps": {
+          "description": "Defines valid properties in KnobValue component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<KnobValueInstance, unknown, KnobValuePassThrough>",
+          "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?: KnobValueInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: KnobValueInstance) => 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": "KnobValueInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<KnobValuePassThrough>",
+              "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: KnobValueInstance) => 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": "color",
+              "type": "string",
+              "default": "",
+              "description": "Stroke color of the value arc. Overrides  `valueColor`  from  `Knob.Root` ."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "KnobValueState": {
+          "description": "Defines valid state in KnobValue component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "KnobValueExposes": {
+          "description": "Defines the methods and properties exposed by KnobValue component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "knob",
+              "type": "KnobRootInstance",
+              "default": "",
+              "description": "The Knob component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "KnobValuePassThroughType": {
+          "description": "Defines passthrough(pt) options type in KnobValue component.",
+          "values": "PassThroughType<KnobValueInstance, E>"
+        },
+        "KnobValueInstance": {
+          "description": "Instance of KnobValue component.",
+          "values": "ComponentInstance<KnobValueProps, KnobValueState, KnobValueExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]