From eea680f535dcb957abde824e1d90a0a4d012d677 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Thu, 22 Jun 2023 13:52:52 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 149 ++++++++++++++++++++++++++++++++++- 1 file changed, 148 insertions(+), 1 deletion(-) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 98e5b320b..786dc913e 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -31918,10 +31918,157 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "RipplePassThroughHooksOptions": { + "description": "Custom passthrough(pt) hooks options.", + "relatedProp": "", + "props": [ + { + "name": "created", + "optional": true, + "readonly": false, + "type": "DirectiveBinding", + "default": "", + "description": "Called before bound element's attributes or event listeners are applied." + }, + { + "name": "beforeMount", + "optional": true, + "readonly": false, + "type": "DirectiveBinding", + "default": "", + "description": "Called right before the element is inserted into the DOM." + }, + { + "name": "mounted", + "optional": true, + "readonly": false, + "type": "DirectiveBinding", + "default": "", + "description": "Called when the bound element's parent component and all its children are mounted." + }, + { + "name": "beforeUpdate", + "optional": true, + "readonly": false, + "type": "DirectiveBinding", + "default": "", + "description": "Called before the parent component is updated." + }, + { + "name": "updated", + "optional": true, + "readonly": false, + "type": "DirectiveBinding", + "default": "", + "description": "Called after the parent component and all of its children have updated all of its children have updated." + }, + { + "name": "beforeUnmount", + "optional": true, + "readonly": false, + "type": "DirectiveBinding", + "default": "", + "description": "Called before the parent component is unmounted." + }, + { + "name": "unmounted", + "optional": true, + "readonly": false, + "type": "DirectiveBinding", + "default": "", + "description": "Called when the parent component is unmounted." + } + ], + "methods": [] + }, + "RipplePassThroughCSSOptions": { + "description": "Custom passthrough(pt) css options.", + "relatedProp": "", + "props": [ + { + "name": "class", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Style class of the element." + }, + { + "name": "style", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Inline style of the element." + } + ], + "methods": [] + }, + "RipplePassThroughDirectiveOptions": { + "relatedProp": "", + "props": [ + { + "name": "hooks", + "optional": true, + "readonly": false, + "type": "RipplePassThroughHooksOptions", + "default": "", + "description": "Uses to pass attributes to the life cycle hooks." + }, + { + "name": "css", + "optional": true, + "readonly": false, + "type": "RipplePassThroughCSSOptions", + "default": "", + "description": "Uses to pass attributes to the styles." + } + ], + "methods": [] + }, + "RipplePassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "RippleOptions.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "RipplePassThroughDirectiveOptions", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + } + ], + "methods": [] + }, + "RippleOptions": { + "description": "Defines options of Ripple.", + "relatedProp": "", + "props": [ + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "RipplePassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." + } + ], + "methods": [] + }, "RippleDirectiveBinding": { "description": "Binding of Ripple directive.", "relatedProp": "", - "props": [], + "props": [ + { + "name": "value", + "optional": true, + "readonly": false, + "type": "RippleOptions", + "default": "", + "description": "Value of the Ripple." + } + ], "methods": [], "extendedTypes": "Omit" }