From b07f825abe4de366af1d7f7f4ff26c82172ce0bc Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Wed, 3 Jul 2024 09:31:47 +0000 Subject: [PATCH] Update API doc --- apps/showcase/doc/common/apidoc/index.json | 186 +++++++++++------- packages/themes/types/breadcrumb/index.d.ts | 31 +-- packages/themes/types/carousel/index.d.ts | 86 ++++---- packages/themes/types/checkbox/index.d.ts | 6 + packages/themes/types/radiobutton/index.d.ts | 6 + packages/themes/types/tabs/index.d.ts | 6 +- packages/themes/types/tabview/index.d.ts | 6 +- packages/themes/types/toggleswitch/index.d.ts | 12 ++ pnpm-lock.yaml | 31 +-- 9 files changed, 220 insertions(+), 150 deletions(-) diff --git a/apps/showcase/doc/common/apidoc/index.json b/apps/showcase/doc/common/apidoc/index.json index 676c6aa6c..e4002cac9 100644 --- a/apps/showcase/doc/common/apidoc/index.json +++ b/apps/showcase/doc/common/apidoc/index.json @@ -35927,7 +35927,7 @@ "description": "Used to pass attributes to the column's DOM element." }, { - "name": "submenulabel", + "name": "submenuLabel", "optional": true, "readonly": false, "type": "MegaMenuPassThroughOptionType", @@ -71569,22 +71569,13 @@ "description": "Hover color of item" }, { - "name": "item.iconColor", - "token": "breadcrumb.item.icon.color", + "name": "item.borderRadius", + "token": "breadcrumb.item.border.radius", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Icon color of item" - }, - { - "name": "item.iconHoverColor", - "token": "breadcrumb.item.icon.hover.color", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Hover color of item icon" + "description": "Border radius of item" }, { "name": "item.gap", @@ -71596,13 +71587,22 @@ "description": "Gap of item" }, { - "name": "item.borderRadius", - "token": "breadcrumb.item.border.radius", + "name": "icon.color", + "token": "breadcrumb.item.icon.color", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Border radius of item" + "description": "Icon color of item" + }, + { + "name": "icon.hoverColor", + "token": "breadcrumb.item.icon.hover.color", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Icon hover color of item" }, { "name": "focusRing.width", @@ -73456,7 +73456,7 @@ "readonly": false, "type": "Object", "default": "", - "description": "Indicator list of root" + "description": "Used to pass tokens of the indicator list section" }, { "name": "indicator", @@ -73464,7 +73464,7 @@ "readonly": false, "type": "Object", "default": "", - "description": "Indicator of root" + "description": "Used to pass tokens of the indicator section" }, { "name": "colorScheme", @@ -73500,7 +73500,7 @@ "readonly": false, "type": "string", "default": "", - "description": "Gap of the content" + "description": "Gap of content" }, { "name": "indicatorList.padding", @@ -73509,7 +73509,7 @@ "readonly": false, "type": "string", "default": "", - "description": "Indicator list padding of root" + "description": "Padding of indicator list" }, { "name": "indicatorList.gap", @@ -73518,7 +73518,7 @@ "readonly": false, "type": "string", "default": "", - "description": "Indicator list gap of root" + "description": "Gap of indicator list" }, { "name": "indicator.width", @@ -73527,7 +73527,7 @@ "readonly": false, "type": "string", "default": "", - "description": "Indicator width of root" + "description": "Width of indicator" }, { "name": "indicator.height", @@ -73536,7 +73536,7 @@ "readonly": false, "type": "string", "default": "", - "description": "Indicator height of root" + "description": "Height of indicator" }, { "name": "indicator.borderRadius", @@ -73545,7 +73545,52 @@ "readonly": false, "type": "string", "default": "", - "description": "Indicator border radius of root" + "description": "Border radius of indicator" + }, + { + "name": "focusRing.width", + "token": "carousel.indicator.focus.ring.width", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring width of indicator" + }, + { + "name": "focusRing.style", + "token": "carousel.indicator.focus.ring.style", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring style of indicator" + }, + { + "name": "focusRing.color", + "token": "carousel.indicator.focus.ring.color", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring color of indicator" + }, + { + "name": "focusRing.offset", + "token": "carousel.indicator.focus.ring.offset", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring offset of indicator" + }, + { + "name": "focusRing.shadow", + "token": "carousel.indicator.focus.ring.shadow", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Focus ring shadow of indicator" }, { "name": "indicator.background", @@ -73573,51 +73618,6 @@ "type": "string", "default": "", "description": "Active background of indicator" - }, - { - "name": "focusRing.width", - "token": "carousel.indicator.focus.ring.width", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Indicator focus ring width of root" - }, - { - "name": "focusRing.style", - "token": "carousel.indicator.focus.ring.style", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Indicator focus ring style of root" - }, - { - "name": "focusRing.color", - "token": "carousel.indicator.focus.ring.color", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Indicator focus ring color of root" - }, - { - "name": "focusRing.offset", - "token": "carousel.indicator.focus.ring.offset", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Indicator focus ring offset of root" - }, - { - "name": "focusRing.shadow", - "token": "carousel.indicator.focus.ring.shadow", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Indicator focus ring shadow of root" } ] } @@ -74247,6 +74247,15 @@ "default": "", "description": "Checked focus border color of root" }, + { + "name": "root.checkedDisabledBorderColor", + "token": "checkbox.checked.disabled.border.color", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Checked disabled border color of root" + }, { "name": "root.invalidBorderColor", "token": "checkbox.invalid.border.color", @@ -87120,6 +87129,15 @@ "default": "", "description": "Checked focus border color of root" }, + { + "name": "root.checkedDisabledBorderColor", + "token": "radiobutton.checked.disabled.border.color", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Checked disabled border color of root" + }, { "name": "root.invalidBorderColor", "token": "radiobutton.invalid.border.color", @@ -90203,13 +90221,13 @@ "description": "Focus ring shadow of nav button" }, { - "name": "navButton.boxShadow", - "token": "tabs.nav.button.box.shadow", + "name": "navButton.shadow", + "token": "tabs.nav.button.shadow", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Box shadow of nav button" + "description": "Shadow of nav button" }, { "name": "activeBar.height", @@ -90430,13 +90448,13 @@ "description": "Hover color of nav button" }, { - "name": "navButton.boxShadow", - "token": "tabview.nav.button.box.shadow", + "name": "navButton.shadow", + "token": "tabview.nav.button.shadow", "optional": true, "readonly": false, "type": "string", "default": "", - "description": "Box shadow of nav button" + "description": "Shadow of nav button" } ] } @@ -92970,6 +92988,15 @@ "default": "", "description": "Slide duration of root" }, + { + "name": "root.disabledBackground", + "token": "toggleswitch.disabled.background", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Disabled background of root" + }, { "name": "root.background", "token": "toggleswitch.background", @@ -93024,6 +93051,15 @@ "default": "", "description": "Size of handle" }, + { + "name": "handle.disabledBackground", + "token": "toggleswitch.handle.disabled.background", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Disabled background of handle" + }, { "name": "handle.background", "token": "toggleswitch.handle.background", diff --git a/packages/themes/types/breadcrumb/index.d.ts b/packages/themes/types/breadcrumb/index.d.ts index 80b96aa0c..b699a91ab 100644 --- a/packages/themes/types/breadcrumb/index.d.ts +++ b/packages/themes/types/breadcrumb/index.d.ts @@ -57,17 +57,11 @@ export interface BreadcrumbDesignTokens extends ColorSchemeDesignToken