From 75b88de8ff524ffafdeb8dced2bc38dca32bfa3c Mon Sep 17 00:00:00 2001
From: GitHub Actions Bot <>
Date: Mon, 4 Sep 2023 09:16:46 +0000
Subject: [PATCH] Update API doc
---
doc/common/apidoc/index.json | 362 ++++++++++++++++++++++++++++++++++-
1 file changed, 352 insertions(+), 10 deletions(-)
diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json
index a2f3e5c1c..b5509e80e 100644
--- a/doc/common/apidoc/index.json
+++ b/doc/common/apidoc/index.json
@@ -5107,6 +5107,37 @@
],
"methods": []
},
+ "BreadcrumbRouterBindProps": {
+ "description": "Defines valid router binding props in Breadcrumb component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ },
+ {
+ "name": "label",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Label element binding"
+ }
+ ],
+ "methods": []
+ },
"BreadcrumbProps": {
"description": "Defines valid properties in Breadcrumb component.",
"relatedProp": "",
@@ -5181,7 +5212,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: BreadcrumbRouterBindProps, // Binding properties of the menuitem\n }",
"description": "item slot's params."
}
],
@@ -14665,6 +14696,45 @@
],
"methods": []
},
+ "ContextMenuRouterBindProps": {
+ "description": "Defines valid router binding props in ContextMenu component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ },
+ {
+ "name": "label",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Label element binding"
+ },
+ {
+ "name": "submenuicon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Submenuicon elemnt binding"
+ }
+ ],
+ "methods": []
+ },
"ContextMenuProps": {
"description": "Defines valid properties in ContextMenu component.",
"relatedProp": "",
@@ -14771,7 +14841,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: ContextMenuRouterBindProps, // Binding properties of the menuitem\n }",
"description": "item slot's params."
}
],
@@ -19582,6 +19652,29 @@
],
"methods": []
},
+ "DockRouterBindProps": {
+ "description": "Defines valid router binding props in Dock component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ }
+ ],
+ "methods": []
+ },
"DockProps": {
"description": "Defines valid properties in Dock component.",
"relatedProp": "",
@@ -19696,7 +19789,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Custom content for item.\n \t index: number, // Index of the menuitem\n \t label: undefined, // Label property of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n }",
+ "type": "{\n \t item: MenuItem, // Custom content for item.\n \t index: number, // Index of the menuitem\n \t label: undefined, // Label property of the menuitem\n \t props: DockRouterBindProps, // Binding properties of the menuitem\n }",
"description": "item slot's params."
}
],
@@ -27429,6 +27522,45 @@
],
"methods": []
},
+ "MegaMenuRouterBindProps": {
+ "description": "Defines valid router binding props in MegaMenu component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ },
+ {
+ "name": "label",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Label element binding"
+ },
+ {
+ "name": "submenuicon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Submenuicon elemnt binding"
+ }
+ ],
+ "methods": []
+ },
"MegaMenuProps": {
"description": "Defines valid properties in MegaMenu component.",
"relatedProp": "",
@@ -27531,7 +27663,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n \t hasSubmenu: boolean, // Whether or not there is a submenu\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: MegaMenuRouterBindProps, // Binding properties of the menuitem\n \t hasSubmenu: boolean, // Whether or not there is a submenu\n }",
"description": "item slot's params."
}
],
@@ -27900,6 +28032,37 @@
],
"methods": []
},
+ "MenuRouterBindProps": {
+ "description": "Defines valid router binding props in Menu component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ },
+ {
+ "name": "label",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Label element binding"
+ }
+ ],
+ "methods": []
+ },
"MenuProps": {
"description": "Defines valid properties in Menu component.",
"relatedProp": "",
@@ -28018,7 +28181,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: MenuRouterBindProps, // Binding properties of the menuitem\n }",
"description": "item slot's params."
}
],
@@ -28417,6 +28580,45 @@
],
"methods": []
},
+ "MenubarRouterBindProps": {
+ "description": "Defines valid router binding props in Menubar component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ },
+ {
+ "name": "label",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Label element binding"
+ },
+ {
+ "name": "submenuicon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Submenuicon elemnt binding"
+ }
+ ],
+ "methods": []
+ },
"MenubarProps": {
"description": "Defines valid properties in Menubar component.",
"relatedProp": "",
@@ -28503,7 +28705,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n \t root: boolean, // State of the root\n \t hasSubmenu: boolean, // Whether or not there is a submenu\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: MenubarRouterBindProps, // Binding properties of the menuitem\n \t root: boolean, // State of the root\n \t hasSubmenu: boolean, // Whether or not there is a submenu\n }",
"description": "item slot's params."
}
],
@@ -32961,6 +33163,45 @@
"methods": [],
"extendedTypes": "PanelMenuPanelOpenEvent"
},
+ "PanelMenuRouterBindProps": {
+ "description": "Defines valid router binding props in PanelMenu component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ },
+ {
+ "name": "label",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Label element binding"
+ },
+ {
+ "name": "submenuicon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Submenuicon elemnt binding"
+ }
+ ],
+ "methods": []
+ },
"PanelMenuProps": {
"description": "Defines valid properties in PanelMenu component.",
"relatedProp": "",
@@ -33027,7 +33268,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n \t hasSubmenu: boolean, // Whether or not there is a submenu\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: PanelMenuRouterBindProps, // Binding properties of the menuitem\n \t hasSubmenu: boolean, // Whether or not there is a submenu\n }",
"description": "item slot's params."
}
],
@@ -39182,6 +39423,37 @@
],
"methods": []
},
+ "StepsRouterBindProps": {
+ "description": "Defines valid router binding props in Steps component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ },
+ {
+ "name": "label",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Label element binding"
+ }
+ ],
+ "methods": []
+ },
"StepsProps": {
"description": "Defines valid properties in Steps component.",
"relatedProp": "",
@@ -39248,7 +39520,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t index: number, // Order of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t index: number, // Order of the menuitem\n \t props: StepsRouterBindProps, // Binding properties of the menuitem\n }",
"description": "item slot's params."
}
],
@@ -39600,6 +39872,37 @@
],
"methods": []
},
+ "TabMenuRouterBindProps": {
+ "description": "Defines valid router binding props in TabMenu component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ },
+ {
+ "name": "label",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Label element binding"
+ }
+ ],
+ "methods": []
+ },
"TabMenuProps": {
"description": "Defines valid properties in TabMenu component.",
"relatedProp": "",
@@ -39674,7 +39977,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: TabMenuRouterBindProps, // Binding properties of the menuitem\n }",
"description": "item slot's params."
}
],
@@ -41375,6 +41678,45 @@
],
"methods": []
},
+ "TabMenuRouterBindProps": {
+ "description": "Defines valid router binding props in TabMenu component.",
+ "relatedProp": "",
+ "props": [
+ {
+ "name": "action",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Action element binding"
+ },
+ {
+ "name": "icon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Icon element binding"
+ },
+ {
+ "name": "label",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Label element binding"
+ },
+ {
+ "name": "submenuicon",
+ "optional": false,
+ "readonly": false,
+ "type": "object",
+ "default": "",
+ "description": "Submenuicon elemnt binding"
+ }
+ ],
+ "methods": []
+ },
"TieredMenuProps": {
"description": "Defines valid properties in TieredMenuMenu component.",
"relatedProp": "",
@@ -41489,7 +41831,7 @@
{
"name": "scope",
"optional": false,
- "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: (args: any) ⇒ string, // Binding properties of the menuitem\n \t hasSubmenu: boolean, // Whether or not there is a submenu\n }",
+ "type": "{\n \t item: MenuItem, // Menuitem instance\n \t label: undefined, // Label property of the menuitem\n \t props: TabMenuRouterBindProps, // Binding properties of the menuitem\n \t hasSubmenu: boolean, // Whether or not there is a submenu\n }",
"description": "item slot's params."
}
],