From 9985119c70c0053abaf1443bf383ed69c4b913dc Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Fri, 28 Apr 2023 13:40:19 +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 52c1dec67..8c474e6a2 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -28715,6 +28715,127 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "ToastPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "ToastProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "ToastState", + "default": "" + } + ], + "methods": [] + }, + "ToastPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "ToastProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "container", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the container's DOM element." + }, + { + "name": "content", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the content's DOM element." + }, + { + "name": "icon", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the icon's DOM element." + }, + { + "name": "text", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the text's DOM element." + }, + { + "name": "summary", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the summary's DOM element." + }, + { + "name": "detail", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the detail's DOM element." + }, + { + "name": "buttonContainer", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the button container's DOM element." + }, + { + "name": "button", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the button's DOM element." + }, + { + "name": "buttonIcon", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the button icon's DOM element." + } + ], + "methods": [] + }, + "ToastPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, "ToastMessageOptions": { "description": "Defines message options in Toast component.", "relatedProp": "", @@ -28799,6 +28920,21 @@ ], "methods": [] }, + "ToastState": { + "description": "Defines current inline state in Toast component.", + "relatedProp": "", + "props": [ + { + "name": "messages", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "Current messages." + } + ], + "methods": [] + }, "ToastProps": { "description": "Defines valid properties in Toast component.", "relatedProp": "", @@ -28896,6 +29032,14 @@ "default": "", "description": "Uses to pass all properties of the HTMLButtonElement to the close button.", "deprecated": "since v3.26.0. Use 'pt' property." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "ToastPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -28966,6 +29110,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "ToastPassThroughOptionType": { + "values": "ToastPassThroughAttributes | (options: ToastPassThroughMethodOptions) => ToastPassThroughAttributes | null | undefined" + } + } } }, "toastservice-usetoast": {