From f1c765d6535c6165dc87ebac2ca90a4c2def3aa1 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Tue, 20 Feb 2024 08:17:40 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 92 ++++++++++++++++++++++++++++++++++-- 1 file changed, 89 insertions(+), 3 deletions(-) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 284a6bbaf..84d1ce831 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -4608,7 +4608,7 @@ } }, "avatargroup": { - "description": "A set of Avatars can be displayed together using the AvatarGroup component.\n\n[Live Demo](https://www.primevue.org/accordion/)", + "description": "A set of Avatars can be displayed together using the AvatarGroup component.\n\n[Live Demo](https://www.primevue.org/avatar/)", "components": { "default": { "description": "A set of Avatars can be displayed together using the AvatarGroup component.", @@ -4624,6 +4624,53 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "AvatarGroupPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "instance", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Defines instance." + }, + { + "name": "props", + "optional": false, + "readonly": false, + "type": "AvatarGroupProps", + "default": "", + "description": "Defines valid properties." + }, + { + "name": "attrs", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Defines valid attributes." + }, + { + "name": "parent", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Defines parent options." + }, + { + "name": "global", + "optional": false, + "readonly": false, + "type": "undefined | object", + "default": "", + "description": "Defines passthrough(pt) options in global config." + } + ], + "methods": [] + }, "AvatarGroupPassThroughAttributes": { "description": "Custom passthrough attributes for each DOM elements", "relatedProp": "", @@ -4716,7 +4763,7 @@ "description": "Defines the custom types used by the module.", "values": { "AvatarGroupPassThroughOptionType": { - "values": "AvatarGroupPassThroughAttributes | null | undefined" + "values": "AvatarGroupPassThroughAttributes | (options: AvatarGroupPassThroughMethodOptions) => undefined | string | null | undefined" } } } @@ -8925,6 +8972,45 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "CardPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "instance", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Defines instance." + }, + { + "name": "props", + "optional": false, + "readonly": false, + "type": "CardProps", + "default": "", + "description": "Defines valid properties." + }, + { + "name": "attrs", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "Defines valid attributes." + }, + { + "name": "global", + "optional": false, + "readonly": false, + "type": "undefined | object", + "default": "", + "description": "Defines passthrough(pt) options in global config." + } + ], + "methods": [] + }, "CardPassThroughOptions": { "description": "Custom passthrough(pt) options.", "relatedProp": "CardProps.pt", @@ -9097,7 +9183,7 @@ "description": "Defines the custom types used by the module.", "values": { "CardPassThroughOptionType": { - "values": "CardPassThroughAttributes | null | undefined" + "values": "CardPassThroughAttributes | (options: CardPassThroughMethodOptions) => undefined | string | null | undefined" } } }