From 6f6a1e617b1215c8b5f06e17647a41fd9b5400c3 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Tue, 9 May 2023 16:03:58 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 183 +++++++++++++++++++++++++++++++++++ 1 file changed, 183 insertions(+) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 6d9b9f1e8..eb6ff5570 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -25633,6 +25633,34 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "OrderListPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "OrderListProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "OrderListState", + "default": "" + }, + { + "name": "context", + "optional": false, + "readonly": false, + "type": "OrderListState", + "default": "" + } + ], + "methods": [] + }, "OrderListReorderEvent": { "description": "Custom reorder event", "relatedProp": "OrderListEmits.reorder", @@ -25687,6 +25715,153 @@ ], "methods": [] }, + "OrderListPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "undefined.OrderListProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "OrderListPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "controls", + "optional": true, + "readonly": false, + "type": "OrderListPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the controls' DOM element." + }, + { + "name": "moveUpButton", + "optional": true, + "readonly": false, + "type": "ButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the Button component." + }, + { + "name": "moveTopButton", + "optional": true, + "readonly": false, + "type": "ButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the Button component." + }, + { + "name": "moveDownButton", + "optional": true, + "readonly": false, + "type": "ButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the Button component." + }, + { + "name": "moveBottomButton", + "optional": true, + "readonly": false, + "type": "ButtonPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the Button component." + }, + { + "name": "container", + "optional": true, + "readonly": false, + "type": "OrderListPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the container's DOM element." + }, + { + "name": "header", + "optional": true, + "readonly": false, + "type": "OrderListPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the header's DOM element." + }, + { + "name": "list", + "optional": true, + "readonly": false, + "type": "OrderListPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the list's DOM element." + }, + { + "name": "item", + "optional": true, + "readonly": false, + "type": "OrderListPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the item's DOM element." + } + ], + "methods": [] + }, + "OrderListPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "OrderListState": { + "description": "Defines current inline state in OrderList component.", + "relatedProp": "", + "props": [ + { + "name": "id", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Current id state as a string." + }, + { + "name": "d_selection", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Current id state as a string." + }, + { + "name": "focused", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current focused state as a boolean." + }, + { + "name": "focusedOptionIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "", + "description": "Current focused item index as a number." + }, + { + "name": "active", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current active state of the item as a boolean." + } + ], + "methods": [] + }, "OrderListProps": { "description": "Defines valid properties in OrderList component.", "relatedProp": "", @@ -25944,6 +26119,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "OrderListPassThroughOptionType": { + "values": "OrderListPassThroughAttributes | (options: OrderListPassThroughMethodOptions) => OrderListPassThroughAttributes | null | undefined" + } + } } }, "organizationchart": {