From 8285192303ee7b421a29555d3deacb6f16c2534b Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Fri, 5 May 2023 09:37:15 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 152 +++++++++++++++++++++++++++++++++++ 1 file changed, 152 insertions(+) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 5a3e0385c..6005982ea 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -8293,6 +8293,27 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "ChipsPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "ChipsProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "ChipsState", + "default": "" + } + ], + "methods": [] + }, "ChipsAddEvent": { "description": "Custom add event.", "relatedProp": "ChipsEmits.add", @@ -8341,6 +8362,121 @@ "methods": [], "extendedTypes": "ChipsAddEvent" }, + "ChipsPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "ChipsProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "ChipsPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "container", + "optional": true, + "readonly": false, + "type": "ChipsPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the container's DOM element." + }, + { + "name": "token", + "optional": true, + "readonly": false, + "type": "ChipsPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the token's DOM element." + }, + { + "name": "label", + "optional": true, + "readonly": false, + "type": "ChipsPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the label's DOM element." + }, + { + "name": "removeTokenIcon", + "optional": true, + "readonly": false, + "type": "ChipsPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the remove token icon's DOM element." + }, + { + "name": "inputToken", + "optional": true, + "readonly": false, + "type": "ChipsPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the input token's DOM element." + }, + { + "name": "input", + "optional": true, + "readonly": false, + "type": "ChipsPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the input's DOM element." + } + ], + "methods": [] + }, + "ChipsPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "ChipsState": { + "description": "Defines current inline state in Chips component.", + "relatedProp": "", + "props": [ + { + "name": "id", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Current id state as a string." + }, + { + "name": "inputValue", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Current input value as a string." + }, + { + "name": "focused", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current focused state as a boolean." + }, + { + "name": "focusedIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Current focused item index state as a number." + } + ], + "methods": [] + }, "ChipsProps": { "description": "Defines valid properties in Chips component.", "relatedProp": "", @@ -8458,6 +8594,14 @@ "type": "string", "default": "", "description": "Establishes a string value that labels the component." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "ChipsPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -8542,6 +8686,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "ChipsPassThroughOptionType": { + "values": "ChipsPassThroughAttributes | (options: ChipsPassThroughMethodOptions) => ChipsPassThroughAttributes | null | undefined" + } + } } }, "colorpicker": {