From 96dbee1bc3eed9e8bb698ac64f927a820c4d2d7c Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Wed, 26 Apr 2023 10:49:55 +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 004eb1f01..f62e4cc94 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -12906,6 +12906,142 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "DockPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "DockProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "DockState", + "default": "" + } + ], + "methods": [] + }, + "DockPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "DockProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "DockPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "container", + "optional": true, + "readonly": false, + "type": "DockPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the container's DOM element." + }, + { + "name": "menu", + "optional": true, + "readonly": false, + "type": "DockPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the list's DOM element." + }, + { + "name": "menuitem", + "optional": true, + "readonly": false, + "type": "DockPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the list item's DOM element." + }, + { + "name": "content", + "optional": true, + "readonly": false, + "type": "DockPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the content's DOM element." + }, + { + "name": "action", + "optional": true, + "readonly": false, + "type": "DockPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the action's DOM element." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "DockPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the icon's DOM element." + } + ], + "methods": [] + }, + "DockPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "DockState": { + "description": "Defines current inline state in Dock component.", + "relatedProp": "", + "props": [ + { + "name": "id", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Current id state as a string." + }, + { + "name": "currentIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Current index as a number." + }, + { + "name": "focused", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current focus state as a boolean." + }, + { + "name": "focusedOptionIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Current focused item index as a number." + } + ], + "methods": [] + }, "DockTooltipOptions": { "description": "Defines tooltip options", "relatedProp": "", @@ -13018,6 +13154,14 @@ "type": "string", "default": "", "description": "Establishes a string value that labels the component." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "DockPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -13089,6 +13233,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "DockPassThroughOptionType": { + "values": "DockPassThroughAttributes | (options: DockPassThroughMethodOptions) => DockPassThroughAttributes | null | undefined" + } + } } }, "dropdown": {