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

Update API doc

pull/3925/head
GitHub Actions Bot 2023-05-05 06:38:03 +00:00
parent afd4ddde69
commit 4c5d66f2de
1 changed files with 185 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -33470,6 +33470,27 @@
"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": {
"VirtualScrollerPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "VirtualScrollerProps",
"default": ""
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "VirtualScrollerState",
"default": ""
}
],
"methods": []
},
"VirtualScrollerScrollIndexChangeEvent": { "VirtualScrollerScrollIndexChangeEvent": {
"description": "Custom scroll index change event.", "description": "Custom scroll index change event.",
"relatedProp": "VirtualScrollerEmits['scroll-index-change']", "relatedProp": "VirtualScrollerEmits['scroll-index-change']",
@ -33635,6 +33656,153 @@
"methods": [], "methods": [],
"extendedBy": "VirtualScrollerLoaderOptions" "extendedBy": "VirtualScrollerLoaderOptions"
}, },
"VirtualScrollerPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "VirtualScrollerProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "VirtualScrollerPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "content",
"optional": true,
"readonly": false,
"type": "VirtualScrollerPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the content's DOM element."
},
{
"name": "spacer",
"optional": true,
"readonly": false,
"type": "VirtualScrollerPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the spacer's DOM element."
},
{
"name": "loader",
"optional": true,
"readonly": false,
"type": "VirtualScrollerPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the loader's DOM element."
},
{
"name": "loadingIcon",
"optional": true,
"readonly": false,
"type": "VirtualScrollerPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the loading icon's DOM element."
}
],
"methods": []
},
"VirtualScrollerPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"VirtualScrollerState": {
"description": "Defines current inline state in VirtualScroller component.",
"relatedProp": "",
"props": [
{
"name": "first",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "First index of the new data range to be loaded as a number."
},
{
"name": "last",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Last index of the new data range to be loaded as a number."
},
{
"name": "page",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Index of the first item as a number."
},
{
"name": "numItemsInViewport",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Visible item count in the viewport as a number."
},
{
"name": "lastScrollPos",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Lastest scroll position as a number."
},
{
"name": "d_numToleratedItems",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Additional elements to add to the DOM outside of the view as a number."
},
{
"name": "d_loading",
"optional": false,
"readonly": false,
"type": "number",
"default": "false",
"description": "Current loading state as a boolean."
},
{
"name": "loaderArr",
"optional": false,
"readonly": false,
"type": "any[]",
"default": "",
"description": "Loadable items array."
},
{
"name": "spacerStyle",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "The style of spacer element."
},
{
"name": "contentStyle",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "The style of content element."
}
],
"methods": []
},
"VirtualScrollerLoaderOptions": { "VirtualScrollerLoaderOptions": {
"description": "Custom virtualscroller loader options", "description": "Custom virtualscroller loader options",
"relatedProp": "undefined.VirtualScrollerItemOptions", "relatedProp": "undefined.VirtualScrollerItemOptions",
@ -33813,7 +33981,7 @@
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "boolean", "type": "boolean",
"default": "", "default": "false",
"description": "Whether to show loader." "description": "Whether to show loader."
}, },
{ {
@ -33871,6 +34039,14 @@
"type": "boolean", "type": "boolean",
"default": "false", "default": "false",
"description": "Whether to dynamically change the height or width of scrollable container." "description": "Whether to dynamically change the height or width of scrollable container."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "VirtualScrollerPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
} }
], ],
"methods": [ "methods": [
@ -34001,6 +34177,14 @@
] ]
} }
} }
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"VirtualScrollerPassThroughOptionType": {
"values": "VirtualScrollerPassThroughAttributes | (options: VirtualScrollerPassThroughMethodOptions) => VirtualScrollerPassThroughAttributes | null | undefined"
}
}
} }
} }
} }