From 55a0c0540b18653f421548279b072382f095ec91 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Fri, 21 Apr 2023 13:42:40 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 88 ++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 8604b1274..afcde6370 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -21592,6 +21592,78 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "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": { "description": "Defines valid properties in ScrollTop component.", "relatedProp": "", @@ -21628,6 +21700,14 @@ "type": "string", "default": "smooth", "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": [] @@ -21652,6 +21732,14 @@ "methods": [] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "ScrollTopPassThroughOptionType": { + "values": "ScrollTopPassThroughAttributes | (options: ScrollTopPassThroughMethodOptions) => ScrollTopPassThroughAttributes | null | undefined" + } + } } }, "selectbutton": {