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 13:42:40 +00:00
parent 9dd6301979
commit 55a0c0540b
1 changed files with 88 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21592,6 +21592,78 @@
"methodDescription": "Defines methods that can be accessed by the component's reference.", "methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.", "typeDescription": "Defines the custom types used by the module.",
"values": { "values": {
"ScrollTopPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "ScrollTopProps",
"default": ""
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "ScrollTopState",
"default": ""
}
],
"methods": []
},
"ScrollTopPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "ScrollTopProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "ScrollTopPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "icon",
"optional": true,
"readonly": false,
"type": "ScrollTopPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the icon's DOM element."
}
],
"methods": []
},
"ScrollTopPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"ScrollTopState": {
"description": "Defines current inline state in ScrollTop component.",
"relatedProp": "",
"props": [
{
"name": "visible",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current visible state as a boolean."
}
],
"methods": []
},
"ScrollTopProps": { "ScrollTopProps": {
"description": "Defines valid properties in ScrollTop component.", "description": "Defines valid properties in ScrollTop component.",
"relatedProp": "", "relatedProp": "",
@ -21628,6 +21700,14 @@
"type": "string", "type": "string",
"default": "smooth", "default": "smooth",
"description": "Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump." "description": "Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "ScrollTopPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
} }
], ],
"methods": [] "methods": []
@ -21652,6 +21732,14 @@
"methods": [] "methods": []
} }
} }
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"ScrollTopPassThroughOptionType": {
"values": "ScrollTopPassThroughAttributes | (options: ScrollTopPassThroughMethodOptions) => ScrollTopPassThroughAttributes | null | undefined"
}
}
} }
}, },
"selectbutton": { "selectbutton": {