From 5f889d203757c909213f40f724e4590fc8d8edb3 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Wed, 10 May 2023 07:29:22 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 92 ++++++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 12cc5c553..8b491e1b7 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -35480,6 +35480,82 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "TimelinePassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "TimelineProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "TimelinePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "event", + "optional": true, + "readonly": false, + "type": "TimelinePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the event's DOM element." + }, + { + "name": "opposite", + "optional": true, + "readonly": false, + "type": "TimelinePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the opposite's DOM element." + }, + { + "name": "separator", + "optional": true, + "readonly": false, + "type": "TimelinePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the separator's DOM element." + }, + { + "name": "marker", + "optional": true, + "readonly": false, + "type": "TimelinePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the marker's DOM element." + }, + { + "name": "connector", + "optional": true, + "readonly": false, + "type": "TimelinePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the connector's DOM element." + }, + { + "name": "content", + "optional": true, + "readonly": false, + "type": "TimelinePassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the content's DOM element." + } + ], + "methods": [] + }, + "TimelinePassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, "TimelineProps": { "description": "Defines valid properties in Timeline component.", "relatedProp": "", @@ -35515,6 +35591,14 @@ "type": "string", "default": "", "description": "Name of the field that uniquely identifies the a record in the data." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "TimelinePassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -35584,6 +35668,14 @@ "methods": [] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "TimelinePassThroughOptionType": { + "values": "TimelinePassThroughAttributes | null | undefined" + } + } } }, "toast": {