Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs: add missing props and fix theming drift (#713)

Joeyb20e5db71d52
diff --git a/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs b/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs
index 14e2ec87a0..a774e61fb3 100644
--- a/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs
+++ b/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs
@@ -148,6 +148,12 @@ export const docs = {
type: 'ReactNode',
description: 'Icon rendered before the item label.',
},
+ {
+ name: 'as',
+ type: 'XDSLinkComponentType',
+ description:
+ 'Custom link component to render instead of <a>. Overrides the provider-level default from XDSLinkProvider. Only applies to non-current items.',
+ },
],
examples: [
{
@@ -318,6 +324,12 @@ export const docsZh = {
type: 'ReactNode',
description: '在项目标签前渲染的图标。',
},
+ {
+ name: 'as',
+ type: 'XDSLinkComponentType',
+ description:
+ '自定义链接组件,代替 <a> 渲染。覆盖 XDSLinkProvider 设置的默认值。仅适用于非当前项。',
+ },
],
examples: [
{
@@ -379,6 +391,7 @@ export const docsDense = {
onClick: 'click handler',
isCurrent: 'marks current page w/ aria-current="page"',
startIcon: 'icon before label',
+ as: 'custom link component; overrides XDSLinkProvider default',
},
},
],
diff --git a/packages/core/src/HoverCard/HoverCard.doc.mjs b/packages/core/src/HoverCard/HoverCard.doc.mjs
index 324432bb70..8228749905 100644
--- a/packages/core/src/HoverCard/HoverCard.doc.mjs
+++ b/packages/core/src/HoverCard/HoverCard.doc.mjs
@@ -109,6 +109,12 @@ export const docs = {
description: 'Enables or disables the hover and focus triggers.',
default: 'true',
},
+ {
+ name: 'onOpenChange',
+ type: '(isOpen: boolean) => void',
+ description:
+ 'Callback fired when hover card visibility changes. Called with true when shown and false when hidden.',
+ },
{
name: 'hasHoverIndication',
type: "'auto' | boolean",
@@ -294,6 +300,12 @@ export const docsZh = {
description: '启用或禁用悬停和聚焦触发器。',
default: 'true',
},
+ {
+ name: 'onOpenChange',
+ type: '(isOpen: boolean) => void',
+ description:
+ '悬浮卡片可见性变化时触发的回调。显示时传入 true,隐藏时传入 false。',
+ },
{
name: 'hasHoverIndication',
type: "'auto' | boolean",
@@ -406,6 +418,7 @@ export const docsDense = {
hideDelay: 'Hide delay in ms.',
focusTrigger: 'Controls when focus events trigger hover card.',
isEnabled: 'Enable/disable hover + focus triggers.',
+ onOpenChange: 'Callback when visibility changes; true=shown, false=hidden.',
hasHoverIndication: 'Dashed underline on trigger element.',
},
},
diff --git a/packages/core/src/Token/Token.doc.mjs b/packages/core/src/Token/Token.doc.mjs
index db4fb64659..70876b1034 100644
--- a/packages/core/src/Token/Token.doc.mjs
+++ b/packages/core/src/Token/Token.doc.mjs
@@ -20,6 +20,12 @@ export const docs = {
description: 'Text label displayed inside the token.',
required: true,
},
+ {
+ name: 'size',
+ type: "'sm' | 'md'",
+ description: 'The size of the token.',
+ default: "'md'",
+ },
{
name: 'color',
type: "'default' | 'red' | 'orange' | 'yellow' | 'green' | 'teal' | 'cyan' | 'blue' | 'purple' | 'pink' | 'gray'",
@@ -145,6 +151,12 @@ export const docsZh = {
description: '显示在标记内部的文本标签。',
required: true,
},
+ {
+ name: 'size',
+ type: "'sm' | 'md'",
+ description: '标记的大小。',
+ default: "'md'",
+ },
{
name: 'color',
type: "'default' | 'red' | 'orange' | 'yellow' | 'green' | 'teal' | 'cyan' | 'blue' | 'purple' | 'pink' | 'gray'",
@@ -271,6 +283,7 @@ export const docsDense = {
keyboard: 'Tab focuses token (or inner button w/ onClick). Enter/Space activate clickable token or remove button. Remove button is separate Tab stop.',
propDescriptions: {
label: 'Text label inside token.',
+ size: "Token size; 'sm' or 'md'.",
color: 'Color variant of token.',
icon: 'Optional icon before label.',
isDisabled: 'Reduces opacity, blocks interactions.',
diff --git a/packages/core/src/Tooltip/Tooltip.doc.mjs b/packages/core/src/Tooltip/Tooltip.doc.mjs
index df9eaa1da8..1f38058e02 100644
--- a/packages/core/src/Tooltip/Tooltip.doc.mjs
+++ b/packages/core/src/Tooltip/Tooltip.doc.mjs
@@ -113,6 +113,12 @@ export const docs = {
description: 'Enables or disables the tooltip triggers.',
default: 'true',
},
+ {
+ name: 'onOpenChange',
+ type: '(isOpen: boolean) => void',
+ description:
+ 'Callback fired when tooltip visibility changes. Called with true when shown and false when hidden.',
+ },
{
name: 'hasHoverIndication',
type: "'auto' | boolean",
@@ -302,6 +308,12 @@ export const docsZh = {
description: '启用或禁用工具提示触发器。',
default: 'true',
},
+ {
+ name: 'onOpenChange',
+ type: '(isOpen: boolean) => void',
+ description:
+ '工具提示可见性变化时触发的回调。显示时传入 true,隐藏时传入 false。',
+ },
{
name: 'hasHoverIndication',
type: "'auto' | boolean",
@@ -416,6 +428,7 @@ export const docsDense = {
hideDelay: 'Hide delay in ms.',
focusTrigger: 'Controls when focus events trigger tooltip.',
isEnabled: 'Enables/disables tooltip triggers.',
+ onOpenChange: 'Callback when visibility changes; true=shown, false=hidden.',
hasHoverIndication: 'Dashed underline on trigger element.',
},
},
diff --git a/packages/core/src/TopNav/TopNav.doc.mjs b/packages/core/src/TopNav/TopNav.doc.mjs
index 481bad4d45..7252ed8181 100644
--- a/packages/core/src/TopNav/TopNav.doc.mjs
+++ b/packages/core/src/TopNav/TopNav.doc.mjs
@@ -122,7 +122,7 @@ export const docs = {
{className: 'xds-top-nav', visualProps: ['mode']},
{className: 'xds-top-nav-item', visualProps: ['mode']},
{className: 'xds-top-nav-heading'},
- {className: 'xds-top-nav-mega-menu'},
+ {className: 'xds-top-nav-mega-menu', visualProps: ['mode']},
{className: 'xds-top-nav-menu'},
],
},
@@ -600,7 +600,7 @@ export const docsZh = {
{className: 'xds-top-nav', visualProps: ['mode']},
{className: 'xds-top-nav-item', visualProps: ['mode']},
{className: 'xds-top-nav-heading'},
- {className: 'xds-top-nav-mega-menu'},
+ {className: 'xds-top-nav-mega-menu', visualProps: ['mode']},
{className: 'xds-top-nav-menu'},
],
},