From 72c57b1bf2d629ffbd37a38c3ecfbcebda0b9b21 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Fri, 28 Apr 2023 11:57:27 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 115 ++++++++++++++++++++++++++++++++++- 1 file changed, 113 insertions(+), 2 deletions(-) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 1bdad0527..52c1dec67 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -19353,6 +19353,110 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "MessagePassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "MessageProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "MessageState", + "default": "" + } + ], + "methods": [] + }, + "MessagePassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "undefined.MessageProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "MessagePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "wrapper", + "optional": true, + "readonly": false, + "type": "MessagePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the wrapper's DOM element." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "MessagePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the icon's DOM element." + }, + { + "name": "text", + "optional": true, + "readonly": false, + "type": "MessagePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the text's DOM element." + }, + { + "name": "button", + "optional": true, + "readonly": false, + "type": "MessagePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the button's DOM element." + }, + { + "name": "buttonIcon", + "optional": true, + "readonly": false, + "type": "MessagePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the button icon's DOM element." + } + ], + "methods": [] + }, + "MessagePassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "MessageState": { + "description": "Defines current inline state in Message component.", + "relatedProp": "", + "props": [ + { + "name": "visible", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current visible state as a boolean." + } + ], + "methods": [] + }, "MessageProps": { "description": "Defines valid properties in Message component.", "relatedProp": "", @@ -19412,8 +19516,7 @@ "readonly": false, "type": "ButtonHTMLAttributes", "default": "", - "description": "Uses to pass all properties of the HTMLButtonElement to the close button.", - "deprecated": "since v3.26.0. Use 'pt' property." + "description": "Uses to pass all properties of the HTMLButtonElement to the close button." } ], "methods": [] @@ -19476,6 +19579,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "MessagePassThroughOptionType": { + "values": "MessagePassThroughAttributes | (options: MessagePassThroughMethodOptions) => MessagePassThroughAttributes | null | undefined" + } + } } }, "multiselect": {