@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,819 @@
+[
+  {
+    "name": "DataViewContent",
+    "source": "apps/showcase/assets/apidoc/dataviewcontent.json",
+    "data": {
+      "description": "DataViewContent is a component that displays the main content inside a DataView.",
+      "interfaces": {
+        "DataViewContentPassThrough": {
+          "description": "Defines passthrough(pt) options of DataViewContent component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "DataViewContentPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "DataViewContentProps": {
+          "description": "Defines valid properties in DataViewContent component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<DataViewContentInstance, unknown, DataViewContentPassThrough, \"div\">",
+          "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?: DataViewContentInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: DataViewContentInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "ReactNode",
+              "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": "DataViewContentInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<DataViewContentPassThrough>",
+              "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: DataViewContentInstance) => 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": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "DataViewContentState": {
+          "description": "Defines valid state in DataViewContent component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "DataViewContentExposes": {
+          "description": "Defines the methods and properties exposed by DataViewContent component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "dataview",
+              "type": "DataViewRootInstance",
+              "default": "",
+              "description": "The DataView component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "DataViewContentPassThroughType": {
+          "description": "Defines passthrough(pt) options type in DataViewContent component.",
+          "values": "PassThroughType<DataViewContentInstance, E>"
+        },
+        "DataViewContentInstance": {
+          "description": "Instance of DataViewContent component.",
+          "values": "ComponentInstance<DataViewContentProps, DataViewContentState, DataViewContentExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "DataViewEmpty",
+    "source": "apps/showcase/assets/apidoc/dataviewempty.json",
+    "data": {
+      "description": "DataViewEmpty is a component that displays empty state content inside a DataView.",
+      "interfaces": {
+        "DataViewEmptyPassThrough": {
+          "description": "Defines passthrough(pt) options of DataViewEmpty component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "DataViewEmptyPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "DataViewEmptyProps": {
+          "description": "Defines valid properties in DataViewEmpty component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<DataViewEmptyInstance, unknown, DataViewEmptyPassThrough, \"div\">",
+          "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?: DataViewEmptyInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: DataViewEmptyInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "ReactNode",
+              "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": "DataViewEmptyInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<DataViewEmptyPassThrough>",
+              "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: DataViewEmptyInstance) => 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": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "DataViewEmptyState": {
+          "description": "Defines valid state in DataViewEmpty component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "DataViewEmptyExposes": {
+          "description": "Defines the methods and properties exposed by DataViewEmpty component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "dataview",
+              "type": "DataViewRootInstance",
+              "default": "",
+              "description": "The DataView component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "DataViewEmptyPassThroughType": {
+          "description": "Defines passthrough(pt) options type in DataViewEmpty component.",
+          "values": "PassThroughType<DataViewEmptyInstance, E>"
+        },
+        "DataViewEmptyInstance": {
+          "description": "Instance of DataViewEmpty component.",
+          "values": "ComponentInstance<DataViewEmptyProps, DataViewEmptyState, DataViewEmptyExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "DataViewFooter",
+    "source": "apps/showcase/assets/apidoc/dataviewfooter.json",
+    "data": {
+      "description": "DataViewFooter is a component that displays a footer inside a DataView.",
+      "interfaces": {
+        "DataViewFooterPassThrough": {
+          "description": "Defines passthrough(pt) options of DataViewFooter component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "DataViewFooterPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "DataViewFooterProps": {
+          "description": "Defines valid properties in DataViewFooter component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<DataViewFooterInstance, unknown, DataViewFooterPassThrough, \"div\">",
+          "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?: DataViewFooterInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: DataViewFooterInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "ReactNode",
+              "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": "DataViewFooterInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<DataViewFooterPassThrough>",
+              "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: DataViewFooterInstance) => 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": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "DataViewFooterState": {
+          "description": "Defines valid state in DataViewFooter component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "DataViewFooterExposes": {
+          "description": "Defines the methods and properties exposed by DataViewFooter component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "dataview",
+              "type": "DataViewRootInstance",
+              "default": "",
+              "description": "The DataView component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "DataViewFooterPassThroughType": {
+          "description": "Defines passthrough(pt) options type in DataViewFooter component.",
+          "values": "PassThroughType<DataViewFooterInstance, E>"
+        },
+        "DataViewFooterInstance": {
+          "description": "Instance of DataViewFooter component.",
+          "values": "ComponentInstance<DataViewFooterProps, DataViewFooterState, DataViewFooterExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "DataViewHeader",
+    "source": "apps/showcase/assets/apidoc/dataviewheader.json",
+    "data": {
+      "description": "DataViewHeader is a component that displays a header inside a DataView.",
+      "interfaces": {
+        "DataViewHeaderPassThrough": {
+          "description": "Defines passthrough(pt) options of DataViewHeader component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "DataViewHeaderPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "DataViewHeaderProps": {
+          "description": "Defines valid properties in DataViewHeader component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<DataViewHeaderInstance, unknown, DataViewHeaderPassThrough, \"div\">",
+          "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?: DataViewHeaderInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: DataViewHeaderInstance) => string)",
+              "default": "",
+              "description": "The class name to apply to the component."
+            },
+            {
+              "name": "as",
+              "type": "ReactNode",
+              "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": "DataViewHeaderInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<DataViewHeaderPassThrough>",
+              "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: DataViewHeaderInstance) => 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": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "DataViewHeaderState": {
+          "description": "Defines valid state in DataViewHeader component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "DataViewHeaderExposes": {
+          "description": "Defines the methods and properties exposed by DataViewHeader component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "dataview",
+              "type": "DataViewRootInstance",
+              "default": "",
+              "description": "The DataView component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "DataViewHeaderPassThroughType": {
+          "description": "Defines passthrough(pt) options type in DataViewHeader component.",
+          "values": "PassThroughType<DataViewHeaderInstance, E>"
+        },
+        "DataViewHeaderInstance": {
+          "description": "Instance of DataViewHeader component.",
+          "values": "ComponentInstance<DataViewHeaderProps, DataViewHeaderState, DataViewHeaderExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "DataViewRoot",
+    "source": "apps/showcase/assets/apidoc/dataviewroot.json",
+    "data": {
+      "description": "DataViewRoot is the main container component for DataView.",
+      "interfaces": {
+        "DataViewRootPassThrough": {
+          "description": "Defines passthrough(pt) options of DataViewRoot component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "DataViewRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "DataViewRootProps": {
+          "description": "Defines valid properties in DataViewRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<DataViewRootInstance, UseDataViewProps, DataViewRootPassThrough>",
+          "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?: DataViewRootInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: DataViewRootInstance) => 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": "DataViewRootInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<DataViewRootPassThrough>",
+              "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: DataViewRootInstance) => 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": "layout",
+              "type": "string",
+              "default": "",
+              "description": "The controlled layout value."
+            },
+            {
+              "name": "defaultLayout",
+              "type": "string",
+              "default": "",
+              "description": "The default layout value for uncontrolled mode."
+            },
+            {
+              "name": "onLayoutChange",
+              "type": "(event: UseDataViewLayoutChangeEvent) => void",
+              "default": "",
+              "description": "Callback invoked when the layout changes."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "DataViewRootState": {
+          "description": "Defines valid state in DataViewRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "UseDataViewState",
+          "props": [
+            {
+              "name": "layout",
+              "type": "string",
+              "default": "",
+              "description": "The current layout value."
+            }
+          ],
+          "methods": []
+        },
+        "DataViewRootExposes": {
+          "description": "Defines the methods and properties exposed by DataViewRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "UseDataViewExposes",
+          "props": [
+            {
+              "name": "sort",
+              "type": "(value: unknown[], sortField: string, sortOrder: number) => unknown[]",
+              "default": "",
+              "description": "Sorts the data based on the specified field and order."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseDataViewRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element.\nIncludes data-scope, data-part, and data-layout."
+            },
+            {
+              "name": "contentProps",
+              "type": "UseDataViewContentProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the content element."
+            },
+            {
+              "name": "headerProps",
+              "type": "UseDataViewHeaderProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the header element."
+            },
+            {
+              "name": "footerProps",
+              "type": "UseDataViewFooterProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the footer element."
+            },
+            {
+              "name": "emptyProps",
+              "type": "UseDataViewEmptyProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the empty element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "DataViewRootPassThroughType": {
+          "description": "Defines passthrough(pt) options type in DataViewRoot component.",
+          "values": "PassThroughType<DataViewRootInstance, E>"
+        },
+        "DataViewRootInstance": {
+          "description": "Instance of DataViewRoot component.",
+          "values": "ComponentInstance<DataViewRootProps, DataViewRootState, DataViewRootExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]