From ac8fedeccfa3e868a88eaa03c6b794843278a35d Mon Sep 17 00:00:00 2001
From: GitHub Actions Bot <>
Date: Mon, 15 Jan 2024 14:02:00 +0000
Subject: [PATCH] Update API doc
---
doc/common/apidoc/index.json | 98 +++++++++++++++++++++++++++++++++++-
1 file changed, 96 insertions(+), 2 deletions(-)
diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json
index 90ead662c..40d6c4932 100644
--- a/doc/common/apidoc/index.json
+++ b/doc/common/apidoc/index.json
@@ -7590,6 +7590,53 @@
],
"methods": []
},
+ "CalendarDateContext": {
+ "description": "Defines current date options in Calendar component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "day",
+ "optional": false,
+ "readonly": false,
+ "type": "number",
+ "default": "",
+ "description": "Current date."
+ },
+ {
+ "name": "month",
+ "optional": false,
+ "readonly": false,
+ "type": "number",
+ "default": "",
+ "description": "Current month state."
+ },
+ {
+ "name": "year",
+ "optional": false,
+ "readonly": false,
+ "type": "number",
+ "default": "",
+ "description": "Current year state."
+ },
+ {
+ "name": "today",
+ "optional": false,
+ "readonly": false,
+ "type": "boolean",
+ "default": "",
+ "description": "Current today state of the calendar's day."
+ },
+ {
+ "name": "selectable",
+ "optional": false,
+ "readonly": false,
+ "type": "boolean",
+ "default": "",
+ "description": "Selectable state of the day."
+ }
+ ],
+ "methods": []
+ },
"CalendarContext": {
"description": "Defines current options in Calendar component.",
"relatedProp": "",
@@ -7598,7 +7645,7 @@
"name": "date",
"optional": false,
"readonly": false,
- "type": "undefined | null | string | string[] | Date | Date[]",
+ "type": "CalendarDateContext",
"default": "",
"description": "Current date."
},
@@ -8202,6 +8249,53 @@
],
"methods": []
},
+ "CalendarDateSlotOptions": {
+ "description": "Defines valid options of the date slot in Calendar component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "day",
+ "optional": false,
+ "readonly": false,
+ "type": "number",
+ "default": "",
+ "description": "Current date."
+ },
+ {
+ "name": "month",
+ "optional": false,
+ "readonly": false,
+ "type": "number",
+ "default": "",
+ "description": "Current month state."
+ },
+ {
+ "name": "year",
+ "optional": false,
+ "readonly": false,
+ "type": "number",
+ "default": "",
+ "description": "Current year state."
+ },
+ {
+ "name": "today",
+ "optional": false,
+ "readonly": false,
+ "type": "boolean",
+ "default": "",
+ "description": "Current today state of the calendar's day."
+ },
+ {
+ "name": "selectable",
+ "optional": false,
+ "readonly": false,
+ "type": "boolean",
+ "default": "",
+ "description": "Selectable state of the day."
+ }
+ ],
+ "methods": []
+ },
"CalendarSlots": {
"description": "Defines valid slots in Calendar component.",
"relatedProp": "",
@@ -8225,7 +8319,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t date: undefined, // Value of the component.\n }"
+ "type": "{\n \t date: CalendarDateSlotOptions, // Value of the component.\n }"
}
],
"returnType": "VNode[]",