From a3e0ae9fee2be10379badc8d2d7b64cdfef06c50 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Fri, 21 Apr 2023 13:35:20 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 186 +++++++++++++++++++++++++++++++++++ 1 file changed, 186 insertions(+) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 02198cccb..3b35164d7 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -6361,6 +6361,102 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "ChipPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "ChipProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "ChipState", + "default": "" + } + ], + "methods": [] + }, + "ChipPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "ChipProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "ChipPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "image", + "optional": true, + "readonly": false, + "type": "ChipPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the image's DOM element." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "ChipPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the icon's DOM element." + }, + { + "name": "label", + "optional": true, + "readonly": false, + "type": "ChipPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the label' DOM element." + }, + { + "name": "removeIcon", + "optional": true, + "readonly": false, + "type": "ChipPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the removeIcon's DOM element." + } + ], + "methods": [] + }, + "ChipPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "ChipState": { + "description": "Defines current inline state in Chip component.", + "relatedProp": "", + "props": [ + { + "name": "visible", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "true", + "description": "Current visible state as a boolean." + } + ], + "methods": [] + }, "ChipProps": { "description": "Defines valid properties in Chip component.", "relatedProp": "", @@ -6406,6 +6502,14 @@ "default": "", "description": "Icon of the remove element.", "deprecated": "since v3.27.0. Use 'removeicon' slot." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "ChipPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -6463,6 +6567,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "ChipPassThroughOptionType": { + "values": "ChipPassThroughAttributes | (options: ChipPassThroughMethodOptions) => ChipPassThroughAttributes | null | undefined" + } + } } }, "chips": { @@ -20572,6 +20684,64 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "ProgressBarPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "ProgressBarProps", + "default": "" + } + ], + "methods": [] + }, + "ProgressBarPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "ProgressBarProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "ProgressBarPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "value", + "optional": true, + "readonly": false, + "type": "ProgressBarPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the value's DOM element." + }, + { + "name": "label", + "optional": true, + "readonly": false, + "type": "ProgressBarPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the label's DOM element." + } + ], + "methods": [] + }, + "ProgressBarPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, "ProgressBarProps": { "description": "Defines valid properties in ProgressBar component.", "relatedProp": "", @@ -20599,6 +20769,14 @@ "type": "boolean", "default": "true", "description": "Whether to display the progress bar value." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "ProgressBarPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -20623,6 +20801,14 @@ "methods": [] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "ProgressBarPassThroughOptionType": { + "values": "ProgressBarPassThroughAttributes | (options: ProgressBarPassThroughMethodOptions) => ProgressBarPassThroughAttributes | null | undefined" + } + } } }, "progressspinner": {