From 6a4226a4e07eed46d977ed6e4f5784fce5283855 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Sun, 7 May 2023 11:39:37 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 112 +++++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 3cd361c3e..17f8391f2 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -33061,6 +33061,102 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "ToggleButtonPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "ToggleButtonProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "ToggleButtonState", + "default": "" + } + ], + "methods": [] + }, + "ToggleButtonPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "ToggleButtonProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "ToggleButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "inputAria", + "optional": true, + "readonly": false, + "type": "ToggleButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the input aria's DOM element." + }, + { + "name": "input", + "optional": true, + "readonly": false, + "type": "ToggleButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the input's DOM element." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "ToggleButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the icon's DOM element." + }, + { + "name": "label", + "optional": true, + "readonly": false, + "type": "ToggleButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the label's DOM element." + } + ], + "methods": [] + }, + "ToggleButtonPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "ToggleButtonState": { + "description": "Defines current inline state in ToggleButton component.", + "relatedProp": "", + "props": [ + { + "name": "focused", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Focused state as a number." + } + ], + "methods": [] + }, "ToggleButtonProps": { "description": "Defines valid properties in ToggleButton component.", "relatedProp": "", @@ -33178,6 +33274,14 @@ "type": "string", "default": "", "description": "Establishes a string value that labels the component." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "ToggleButtonPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -33261,6 +33365,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "ToggleButtonPassThroughOptionType": { + "values": "ToggleButtonPassThroughAttributes | (options: ToggleButtonPassThroughMethodOptions) => ToggleButtonPassThroughAttributes | null | undefined" + } + } } }, "toolbar": {