@primereact/mcp 11.0.0-rc.2

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

@@ -0,0 +1,703 @@
+[
+  {
+    "name": "AvatarFallback",
+    "source": "apps/showcase/assets/apidoc/avatarfallback.json",
+    "data": {
+      "description": "AvatarFallback is a component that displays a fallback icon when the image fails to load or is not provided.",
+      "interfaces": {
+        "AvatarFallbackPassThrough": {
+          "description": "Defines passthrough(pt) options of AvatarFallback component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "AvatarFallbackPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "AvatarFallbackProps": {
+          "description": "Defines valid properties in AvatarFallback component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<AvatarFallbackInstance, unknown, AvatarFallbackPassThrough>",
+          "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?: AvatarFallbackInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: AvatarFallbackInstance) => 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": "AvatarFallbackInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<AvatarFallbackPassThrough>",
+              "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: AvatarFallbackInstance) => 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": []
+        },
+        "AvatarFallbackState": {
+          "description": "Defines valid state in AvatarFallback component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "AvatarFallbackExposes": {
+          "description": "Defines the methods and properties exposed by AvatarFallback component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "avatar",
+              "type": "AvatarRootInstance",
+              "default": "",
+              "description": "The Avatar component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "AvatarFallbackPassThroughType": {
+          "description": "Defines passthrough(pt) options type in AvatarFallback component.",
+          "values": "PassThroughType<AvatarFallbackInstance, E>"
+        },
+        "AvatarFallbackInstance": {
+          "description": "Instance of AvatarFallback component.",
+          "values": "ComponentInstance<AvatarFallbackProps, AvatarFallbackState, AvatarFallbackExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "AvatarGroup",
+    "source": "apps/showcase/assets/apidoc/avatargroup.json",
+    "data": {
+      "description": "AvatarGroup is a component that displays a group of avatars, typically used to represent multiple users or items in a compact way.",
+      "interfaces": {
+        "AvatarGroupPassThrough": {
+          "description": "Defines passthrough(pt) options of AvatarGroup component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "AvatarGroupPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "AvatarGroupProps": {
+          "description": "Defines valid properties in AvatarGroup component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<AvatarGroupInstance, UseAvatarGroupProps, AvatarGroupPassThrough>",
+          "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?: AvatarGroupInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: AvatarGroupInstance) => 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": "AvatarGroupInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<AvatarGroupPassThrough>",
+              "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: AvatarGroupInstance) => 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": []
+        },
+        "AvatarGroupState": {
+          "description": "Defines valid state in AvatarGroup component.",
+          "relatedProp": "",
+          "extendedTypes": "UseAvatarGroupState",
+          "props": [],
+          "methods": []
+        },
+        "AvatarGroupExposes": {
+          "description": "Defines the methods and properties exposed by AvatarGroup component.",
+          "relatedProp": "",
+          "extendedTypes": "UseAvatarGroupExposes",
+          "props": [
+            {
+              "name": "rootProps",
+              "type": "UseAvatarGroupRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "AvatarGroupPassThroughType": {
+          "description": "Defines passthrough(pt) options type in AvatarGroup component.",
+          "values": "PassThroughType<AvatarGroupInstance, E>"
+        },
+        "AvatarGroupClassNamesType": {
+          "description": "Type representing the CSS class names used in the AvatarGroup component.",
+          "values": "typeof AvatarGroupClassNames[keyof typeof AvatarGroupClassNames]"
+        },
+        "AvatarGroupInstance": {
+          "description": "Instance of AvatarGroup component.",
+          "values": "ComponentInstance<AvatarGroupProps, AvatarGroupState, AvatarGroupExposes>"
+        }
+      },
+      "variables": {
+        "AvatarGroupClassNames": {
+          "description": "Defines the CSS class names used in the AvatarGroup component.",
+          "variables": [
+            {
+              "name": "root",
+              "value": "p-avatar-group",
+              "optional": false,
+              "readonly": true,
+              "description": "Class name of the root element"
+            }
+          ]
+        }
+      }
+    }
+  },
+  {
+    "name": "AvatarImage",
+    "source": "apps/showcase/assets/apidoc/avatarimage.json",
+    "data": {
+      "description": "AvatarImage is a component that displays an image inside an Avatar.",
+      "interfaces": {
+        "AvatarImagePassThrough": {
+          "description": "Defines passthrough(pt) options of AvatarImage component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "AvatarImagePassThroughType<ImgHTMLAttributes<HTMLImageElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "AvatarImageProps": {
+          "description": "Defines valid properties in AvatarImage component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<AvatarImageInstance, unknown, AvatarImagePassThrough, \"img\">",
+          "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?: AvatarImageInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: AvatarImageInstance) => 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": "AvatarImageInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<AvatarImagePassThrough>",
+              "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: AvatarImageInstance) => 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": "src",
+              "type": "string",
+              "default": "undefined",
+              "description": "Specifies the path to the image to display."
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "AvatarImageState": {
+          "description": "Defines valid state in AvatarImage component.",
+          "relatedProp": "",
+          "props": [],
+          "methods": []
+        },
+        "AvatarImageExposes": {
+          "description": "Defines the methods and properties exposed by AvatarImage component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "avatar",
+              "type": "AvatarRootInstance",
+              "default": "",
+              "description": "The Avatar component instance."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "AvatarImagePassThroughType": {
+          "description": "Defines passthrough(pt) options type in AvatarImage component.",
+          "values": "PassThroughType<AvatarImageInstance, E>"
+        },
+        "AvatarImageInstance": {
+          "description": "Instance of AvatarImage component.",
+          "values": "ComponentInstance<AvatarImageProps, AvatarImageState, AvatarImageExposes>"
+        }
+      },
+      "variables": {}
+    }
+  },
+  {
+    "name": "AvatarRoot",
+    "source": "apps/showcase/assets/apidoc/avatarroot.json",
+    "data": {
+      "description": "Avatar represents people using icons, labels and images.",
+      "interfaces": {
+        "AvatarRootPassThrough": {
+          "description": "Defines passthrough(pt) options of AvatarRoot component.",
+          "relatedProp": "",
+          "props": [
+            {
+              "name": "root",
+              "type": "AvatarRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the root's DOM element."
+            },
+            {
+              "name": "fallback",
+              "type": "AvatarRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the fallback's DOM element."
+            },
+            {
+              "name": "image",
+              "type": "AvatarRootPassThroughType<ImgHTMLAttributes<HTMLImageElement>>",
+              "default": "",
+              "description": "Used to pass attributes to the image's DOM element."
+            }
+          ],
+          "methods": []
+        },
+        "AvatarRootProps": {
+          "description": "Defines valid properties in AvatarRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "BaseComponentProps<AvatarRootInstance, UseAvatarProps, AvatarRootPassThrough>",
+          "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?: AvatarRootInstance) => CSSProperties)",
+              "default": "",
+              "description": "The style to apply to the component."
+            },
+            {
+              "name": "className",
+              "type": "string | ((instance?: AvatarRootInstance) => 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": "AvatarRootInstance",
+              "default": "",
+              "description": "The instance to pass to the component."
+            },
+            {
+              "name": "pt",
+              "type": "SafeRecord<AvatarRootPassThrough>",
+              "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: AvatarRootInstance) => 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": "delayDuration",
+              "type": "number",
+              "default": "",
+              "description": "The delay duration of the avatar."
+            },
+            {
+              "name": "size",
+              "type": "\"large\" | \"normal\" | \"xlarge\"",
+              "default": "normal",
+              "description": "Defines the size of the avatar."
+            },
+            {
+              "name": "shape",
+              "type": "\"circle\" | \"square\"",
+              "default": "square",
+              "description": "Defines the shape of the avatar."
+            },
+            {
+              "name": "[key: string]",
+              "type": "any",
+              "description": ""
+            },
+            {
+              "name": "pt-{optionName}-*",
+              "type": "-",
+              "default": "",
+              "description": "Pass through attributes for customizing component parts.",
+              "deprecated": false
+            }
+          ],
+          "methods": []
+        },
+        "AvatarRootState": {
+          "description": "Defines valid state in Avatar component.",
+          "relatedProp": "",
+          "extendedTypes": "UseAvatarState",
+          "props": [
+            {
+              "name": "load",
+              "type": "boolean",
+              "default": "",
+              "description": "Whether the avatar's image is loading or not."
+            }
+          ],
+          "methods": []
+        },
+        "AvatarRootExposes": {
+          "description": "Defines the methods and properties exposed by AvatarRoot component.",
+          "relatedProp": "",
+          "extendedTypes": "UseAvatarExposes",
+          "props": [
+            {
+              "name": "state",
+              "type": "UseAvatarState",
+              "default": "",
+              "description": "The state of the useAvatar."
+            },
+            {
+              "name": "rootProps",
+              "type": "UseAvatarRootProps",
+              "default": "",
+              "description": "Pre-built data attribute props for the root element."
+            },
+            {
+              "name": "handleImageLoad",
+              "type": "(src?: string) => void",
+              "default": "",
+              "description": "The method to handle image load."
+            },
+            {
+              "name": "handleImageUnload",
+              "type": "() => void",
+              "default": "",
+              "description": "The method to handle image unload."
+            }
+          ],
+          "methods": []
+        }
+      },
+      "types": {
+        "AvatarRootPassThroughType": {
+          "description": "Defines passthrough(pt) options type in AvatarRoot component.",
+          "values": "PassThroughType<AvatarRootInstance, E>"
+        },
+        "AvatarRootInstance": {
+          "description": "Instance of AvatarRoot component.",
+          "values": "ComponentInstance<AvatarRootProps, AvatarRootState, AvatarRootExposes>"
+        }
+      },
+      "variables": {}
+    }
+  }
+]