From 2be89c9d9b36b85f5379b9130342e52a0d4c6ebf Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Fri, 5 May 2023 09:53:53 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 144 +++++++++++++++++++++++++++++++++++ 1 file changed, 144 insertions(+) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 6005982ea..ac9c5a9f1 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -8713,6 +8713,27 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "ColorPickerPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "ColorPickerProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "ColorPickerState", + "default": "" + } + ], + "methods": [] + }, "ColorPickerChangeEvent": { "description": "Custom change event.", "relatedProp": "ColorPickerEmits.change", @@ -8736,6 +8757,113 @@ ], "methods": [] }, + "ColorPickerPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "ColorPickerProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "input", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the input's DOM element." + }, + { + "name": "panel", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the panel's DOM element." + }, + { + "name": "content", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the content's DOM element." + }, + { + "name": "selector", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the selector's DOM element." + }, + { + "name": "color", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the color's DOM element." + }, + { + "name": "colorHandler", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the color handler's DOM element." + }, + { + "name": "hue", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the hue's DOM element." + }, + { + "name": "hueHandler", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the hue handler's DOM element." + } + ], + "methods": [] + }, + "ColorPickerPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "ColorPickerState": { + "description": "Defines current inline state in ColorPicker component.", + "relatedProp": "", + "props": [ + { + "name": "overlayVisible", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current overlay visible state as a boolean." + } + ], + "methods": [] + }, "ColorPickerProps": { "description": "Defines valid properties in ColorPicker component.", "relatedProp": "", @@ -8819,6 +8947,14 @@ "type": "string | HTMLElement", "default": "body", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are 'body' for document body and 'self' for the element itself." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "ColorPickerPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -8874,6 +9010,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "ColorPickerPassThroughOptionType": { + "values": "ColorPickerPassThroughAttributes | (options: ColorPickerPassThroughMethodOptions) => ColorPickerPassThroughAttributes | null | undefined" + } + } } }, "column": {