Skip to content

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

TypeScript

fix(cli): correct Breadcrumbs and Theme docs from vibe test 2026-06-18 (#2914)

Cindy Zhange39acca0748e
diff --git a/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs b/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs
index 3b6be4d7dc..3f0afd59c7 100644
--- a/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs
+++ b/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs
@@ -84,7 +84,45 @@ export const docs = {
},
],
components: [
- {name: 'XDSBreadcrumbItem'},
+ {
+ name: 'XDSBreadcrumbItem',
+ displayName: 'Breadcrumb Item',
+ description: 'Individual breadcrumb item. Renders as a link when href is provided, or as plain text for the current page.',
+ props: [
+ {
+ name: 'children',
+ type: 'ReactNode',
+ description: 'Label content for the breadcrumb item.',
+ required: true,
+ },
+ {
+ name: 'href',
+ type: 'string',
+ description: 'URL the breadcrumb links to; omit for non-navigable items.',
+ },
+ {
+ name: 'onClick',
+ type: '(e: MouseEvent) => void',
+ description: 'Click handler for the breadcrumb item.',
+ },
+ {
+ name: 'isCurrent',
+ type: 'boolean',
+ description: 'Marks this item as the current page, applying aria-current="page".',
+ default: 'false',
+ },
+ {
+ name: 'startIcon',
+ 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.',
+ },
+ ],
+ },
],
};
diff --git a/packages/core/src/theme/XDSTheme.doc.mjs b/packages/core/src/theme/XDSTheme.doc.mjs
index 2989289d8f..320dfd9912 100644
--- a/packages/core/src/theme/XDSTheme.doc.mjs
+++ b/packages/core/src/theme/XDSTheme.doc.mjs
@@ -39,7 +39,7 @@ export const docs = {
},
usage: {
description:
- 'Wraps a subtree with a specific XDS theme. For static production themes, use `npx xds theme build` and import the generated CSS plus built theme object for first-paint and SSR performance. Use runtime `defineTheme()` when themes are dynamic or for prototyping.',
+ 'Wraps a subtree with a specific XDS theme. For static production themes, use `npx xds theme build` and import the generated CSS plus built theme object for first-paint and SSR performance. Use runtime `defineTheme()` when themes are dynamic or for prototyping.\n\n`defineTheme` accepts a `tokens` object whose keys are CSS custom property names (always prefixed with `--`). Common token names include `--color-accent`, `--color-background-surface`, `--color-background-body`, `--color-text-primary`, `--color-text-secondary`, `--radius-container`, `--spacing-1` through `--spacing-6`. Values can be a string (same for light/dark) or a `[light, dark]` tuple.\n\nExample:\n```ts\nimport {defineTheme} from \'@xds/core/theme\';\nconst myTheme = defineTheme({\n name: \'ocean\',\n tokens: {\n \'--color-accent\': [\'#0077B6\', \'#48CAE4\'],\n \'--color-background-surface\': [\'#F0F8FF\', \'#0A1628\'],\n \'--color-text-primary\': [\'#0A1317\', \'#FFFFFF\'],\n \'--radius-container\': \'16px\',\n },\n});\n```',
bestPractices: [
{
guidance: true,
@@ -51,6 +51,11 @@ export const docs = {
description:
'Use runtime themes when the theme is created or edited in the browser, such as theme editors, user branding, or prototypes.',
},
+ {
+ guidance: true,
+ description:
+ 'Token names always start with `--` (e.g. `--color-accent`, `--color-background-surface`). Do not omit the prefix.',
+ },
{
guidance: false,
description:
@@ -85,7 +90,7 @@ export const docs = {
export const docsDense = {
usage: {
description:
- 'Wraps subtree w/ specific XDS theme. For static production themes, use `npx xds theme build` + generated CSS + built theme object for first-paint/SSR performance. Use runtime `defineTheme()` for dynamic themes or prototyping.',
+ 'Wraps subtree w/ specific XDS theme. For static production themes, use `npx xds theme build` + generated CSS + built theme object for first-paint/SSR performance. Use runtime `defineTheme()` for dynamic themes or prototyping. Token names always start with `--` (e.g. `--color-accent`, `--color-background-surface`).',
bestPractices: [
{
guidance: true,
@@ -97,6 +102,11 @@ export const docsDense = {
description:
'Use runtime themes when theme is created/edited in browser, e.g. theme editor, user branding, prototype.',
},
+ {
+ guidance: true,
+ description:
+ 'Token names always start with `--` (e.g. `--color-accent`, `--color-background-surface`). Do not omit the prefix.',
+ },
{
guidance: false,
description: