From 8de4b8170d60a14cc4ca6df96a598ae007ca6893 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Fri, 5 May 2023 06:40:55 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 200 +++++++++++++++++++++++++++++++++++ 1 file changed, 200 insertions(+) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 8389396dd..c8fcc9365 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -2578,6 +2578,27 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "AutoCompletePassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "AutoCompleteProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "AutoCompleteState", + "default": "" + } + ], + "methods": [] + }, "AutoCompleteChangeEvent": { "description": "Custom change event.", "relatedProp": "AutoCompleteEmits.change", @@ -2695,6 +2716,169 @@ ], "methods": [] }, + "AutoCompletePassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "AutoCompleteProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "input", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the input's DOM element." + }, + { + "name": "container", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the container's DOM element." + }, + { + "name": "token", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the token' DOM element." + }, + { + "name": "tokenLabel", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the token label's DOM element." + }, + { + "name": "removeTokenIcon", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the remove token icon's DOM element." + }, + { + "name": "loadingIcon", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the loading icon's DOM element." + }, + { + "name": "dropdownButton", + "optional": true, + "readonly": false, + "type": "ButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the Button component." + }, + { + "name": "searchResultMessage", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the search result message's DOM element." + }, + { + "name": "panel", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the panel's DOM element." + }, + { + "name": "virtualScroller", + "optional": true, + "readonly": false, + "type": "VirtualScrollerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the VirtualScroller component." + }, + { + "name": "list", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the list's DOM element." + }, + { + "name": "itemGroup", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the item group's DOM element." + }, + { + "name": "item", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the item's DOM element." + }, + { + "name": "emptyMessage", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the empty message's DOM element." + }, + { + "name": "selectedMessage", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the selected message's DOM element." + } + ], + "methods": [] + }, + "AutoCompletePassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "AutoCompleteState": { + "description": "Defines current inline state in AutoComplete component.", + "relatedProp": "", + "props": [ + { + "name": "d_collapsed", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current collapsed state as a boolean." + } + ], + "methods": [] + }, "AutoCompleteProps": { "description": "Defines valid properties in AutoComplete component.", "relatedProp": "", @@ -3039,6 +3223,14 @@ "type": "string", "default": "", "description": "Identifier of the underlying input element." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "AutoCompletePassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -3327,6 +3519,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "AutoCompletePassThroughOptionType": { + "values": "AutoCompletePassThroughAttributes | (options: AutoCompletePassThroughMethodOptions) => AutoCompletePassThroughAttributes | null | undefined" + } + } } }, "avatar": {