vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Update API doc

pull/3892/head
GitHub Actions Bot 2023-04-21 12:05:09 +00:00
parent 43c3f82ae5
commit 6e0ccd732e
1 changed files with 128 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
doc/common/apidoc/index.json
View File

@ -3340,6 +3340,72 @@
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AvatarPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "AvatarProps",
"default": ""
}
],
"methods": []
},
"AvatarPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AvatarPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AvatarProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AvatarPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "label",
"optional": true,
"readonly": false,
"type": "AvatarPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the label's DOM element."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "AvatarPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the icon's DOM element."
},
{
"name": "image",
"optional": true,
"readonly": false,
"type": "AvatarPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the image's DOM element."
}
],
"methods": []
},
"AvatarProps": {
"description": "Defines valid properties in Avatar component.",
"relatedProp": "",
@ -3400,6 +3466,14 @@
"type": "string",
"default": "",
"description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "AvatarPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
}
],
"methods": []
@ -3437,6 +3511,14 @@
]
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AvatarPassThroughOptionType": {
"values": "AvatarPassThroughAttributes | (options: AvatarPassThroughMethodOptions) => AvatarPassThroughAttributes | null | undefined"
}
}
}
},
"avatargroup": {
@ -3456,10 +3538,47 @@
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"AvatarGroupPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"AvatarGroupPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "AvatarGroupProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "AvatarGroupPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
}
],
"methods": []
},
"AvatarGroupProps": {
"description": "Defines valid properties in AvatarGroup component.",
"relatedProp": "",
"props": [],
"props": [
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "AvatarGroupPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
}
],
"methods": []
},
"AvatarGroupSlots": {
@ -3475,6 +3594,14 @@
"methods": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"AvatarGroupPassThroughOptionType": {
"values": "AvatarGroupPassThroughAttributes | null | undefined"
}
}
}
},
"badge": {