Skip to content

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

TypeScript

feat(Badge): add label prop for API consistency (#709)

Cindy Zhangd3a224e7ccf3
diff --git a/apps/example-nextjs-tailwind/src/app/page.tsx b/apps/example-nextjs-tailwind/src/app/page.tsx
index 22013c416e..fad2395201 100644
--- a/apps/example-nextjs-tailwind/src/app/page.tsx
+++ b/apps/example-nextjs-tailwind/src/app/page.tsx
@@ -43,10 +43,10 @@ export default function Home() {
<XDSVStack gap={3}>
<XDSHeading level={2}>Badges</XDSHeading>
<XDSHStack gap={3} vAlign="center">
- <XDSBadge variant="info">Info</XDSBadge>
- <XDSBadge variant="success">Success</XDSBadge>
- <XDSBadge variant="warning">Warning</XDSBadge>
- <XDSBadge variant="error">Error</XDSBadge>
+ <XDSBadge variant="info" label='Info' />
+ <XDSBadge variant="success" label='Success' />
+ <XDSBadge variant="warning" label='Warning' />
+ <XDSBadge variant="error" label='Error' />
</XDSHStack>
</XDSVStack>
diff --git a/apps/example-nextjs/src/app/page.tsx b/apps/example-nextjs/src/app/page.tsx
index 3c0c92129b..48ddbcedb3 100644
--- a/apps/example-nextjs/src/app/page.tsx
+++ b/apps/example-nextjs/src/app/page.tsx
@@ -60,10 +60,10 @@ export default function Home() {
<XDSVStack gap={3}>
<XDSHeading level={2}>Badges</XDSHeading>
<XDSHStack gap={3} vAlign="center">
- <XDSBadge variant="info">Info</XDSBadge>
- <XDSBadge variant="success">Success</XDSBadge>
- <XDSBadge variant="warning">Warning</XDSBadge>
- <XDSBadge variant="error">Error</XDSBadge>
+ <XDSBadge variant="info" label="Info" />
+ <XDSBadge variant="success" label="Success" />
+ <XDSBadge variant="warning" label="Warning" />
+ <XDSBadge variant="error" label="Error" />
</XDSHStack>
</XDSVStack>
diff --git a/apps/example-vite/src/App.tsx b/apps/example-vite/src/App.tsx
index 7408b3139a..25b4cd0c3b 100644
--- a/apps/example-vite/src/App.tsx
+++ b/apps/example-vite/src/App.tsx
@@ -65,10 +65,10 @@ export default function App() {
<XDSVStack gap={3}>
<XDSHeading level={2}>Badges</XDSHeading>
<XDSHStack gap={3} vAlign="center">
- <XDSBadge variant="info">Info</XDSBadge>
- <XDSBadge variant="success">Success</XDSBadge>
- <XDSBadge variant="warning">Warning</XDSBadge>
- <XDSBadge variant="error">Error</XDSBadge>
+ <XDSBadge variant="info" label='Info' />
+ <XDSBadge variant="success" label='Success' />
+ <XDSBadge variant="warning" label='Warning' />
+ <XDSBadge variant="error" label='Error' />
</XDSHStack>
</XDSVStack>
diff --git a/apps/sandbox/src/app/(fullscreen)/pages/shell-lab/page.tsx b/apps/sandbox/src/app/(fullscreen)/pages/shell-lab/page.tsx
index a23bb6e464..33ee32b8c6 100644
--- a/apps/sandbox/src/app/(fullscreen)/pages/shell-lab/page.tsx
+++ b/apps/sandbox/src/app/(fullscreen)/pages/shell-lab/page.tsx
@@ -560,7 +560,7 @@ function SampleSideNav({
label="Projects"
href="#"
icon={ProjectsIcon}
- endContent={<XDSBadge>3</XDSBadge>}
+ endContent={<XDSBadge label={3} />}
/>
<XDSSideNavItem label="Messages" href="#" icon={MessagesIcon} />
{config.showNestedItems && (
diff --git a/apps/sandbox/src/app/(sandbox)/pages/example/page.tsx b/apps/sandbox/src/app/(sandbox)/pages/example/page.tsx
index 51bf42d082..0d56733dcb 100644
--- a/apps/sandbox/src/app/(sandbox)/pages/example/page.tsx
+++ b/apps/sandbox/src/app/(sandbox)/pages/example/page.tsx
@@ -64,10 +64,10 @@ export default function ExamplePage() {
<XDSVStack gap={3}>
<XDSHeading level={2}>Badges</XDSHeading>
<XDSHStack gap={3} vAlign="center">
- <XDSBadge variant="info">Info</XDSBadge>
- <XDSBadge variant="success">Success</XDSBadge>
- <XDSBadge variant="warning">Warning</XDSBadge>
- <XDSBadge variant="error">Error</XDSBadge>
+ <XDSBadge variant="info" label='Info' />
+ <XDSBadge variant="success" label='Success' />
+ <XDSBadge variant="warning" label='Warning' />
+ <XDSBadge variant="error" label='Error' />
</XDSHStack>
</XDSVStack>
diff --git a/apps/sandbox/src/app/(sandbox)/pages/table-overview/page.tsx b/apps/sandbox/src/app/(sandbox)/pages/table-overview/page.tsx
index f60584df09..a1e3e1649d 100644
--- a/apps/sandbox/src/app/(sandbox)/pages/table-overview/page.tsx
+++ b/apps/sandbox/src/app/(sandbox)/pages/table-overview/page.tsx
@@ -303,9 +303,7 @@ const columns: XDSTableColumn<ReviewRow>[] = [
header: 'Status',
width: pixel(160),
renderCell: (item: ReviewRow) => (
- <XDSBadge variant={STATUS_VARIANT_MAP[item.status]}>
- {item.status}
- </XDSBadge>
+ <XDSBadge variant={STATUS_VARIANT_MAP[item.status]} label={item.status} />
),
},
];
diff --git a/apps/storybook/stories/AppShell.stories.tsx b/apps/storybook/stories/AppShell.stories.tsx
index 35f0bec6d5..c51238bfee 100644
--- a/apps/storybook/stories/AppShell.stories.tsx
+++ b/apps/storybook/stories/AppShell.stories.tsx
@@ -141,7 +141,7 @@ function SideNavWithoutHeader() {
icon={FolderIcon}
selectedIcon={FolderIconSolid}
href="#"
- endContent={<XDSBadge>12</XDSBadge>}
+ endContent={<XDSBadge label={12} />}
/>
</XDSSideNavSection>
<XDSSideNavSection title="Organization">
@@ -195,7 +195,7 @@ function SideNavWithHeader() {
icon={FolderIcon}
selectedIcon={FolderIconSolid}
href="#"
- endContent={<XDSBadge>12</XDSBadge>}
+ endContent={<XDSBadge label={12} />}
/>
</XDSSideNavSection>
<XDSSideNavSection title="Organization">
@@ -406,14 +406,14 @@ export const FullFeatured: Story = {
icon={ChartBarIcon}
selectedIcon={ChartBarIconSolid}
href="#"
- endContent={<XDSBadge variant="info">New</XDSBadge>}
+ endContent={<XDSBadge variant="info" label='New' />}
/>
<XDSSideNavItem
label="Projects"
icon={FolderIcon}
selectedIcon={FolderIconSolid}
href="#"
- endContent={<XDSBadge>12</XDSBadge>}
+ endContent={<XDSBadge label={12} />}
/>
</XDSSideNavSection>
<XDSSideNavSection title="Organization">
@@ -594,7 +594,7 @@ export const WithMobileNav: Story = {
icon={FolderIcon}
selectedIcon={FolderIconSolid}
href="#"
- endContent={<XDSBadge>12</XDSBadge>}
+ endContent={<XDSBadge label={12} />}
/>
</XDSSideNavSection>
<XDSSideNavSection title="Organization">
diff --git a/apps/storybook/stories/Badge.stories.tsx b/apps/storybook/stories/Badge.stories.tsx
index 838e60adb5..067aa495b5 100644
--- a/apps/storybook/stories/Badge.stories.tsx
+++ b/apps/storybook/stories/Badge.stories.tsx
@@ -30,11 +30,11 @@ export const Default: Story = {
export const Variants: Story = {
render: () => (
<div style={{display: 'flex', gap: '8px', alignItems: 'center'}}>
- <XDSBadge variant="neutral">Neutral</XDSBadge>
- <XDSBadge variant="info">Info</XDSBadge>
- <XDSBadge variant="success">Success</XDSBadge>
- <XDSBadge variant="warning">Warning</XDSBadge>
- <XDSBadge variant="error">Error</XDSBadge>
+ <XDSBadge variant="neutral" label='Neutral' />
+ <XDSBadge variant="info" label='Info' />
+ <XDSBadge variant="success" label='Success' />
+ <XDSBadge variant="warning" label='Warning' />
+ <XDSBadge variant="error" label='Error' />
</div>
),
};
@@ -42,9 +42,9 @@ export const Variants: Story = {
export const Counts: Story = {
render: () => (
<div style={{display: 'flex', gap: '8px', alignItems: 'center'}}>
- <XDSBadge variant="info">3</XDSBadge>
- <XDSBadge variant="error">99+</XDSBadge>
- <XDSBadge variant="success">12</XDSBadge>
+ <XDSBadge variant="info" label={3} />
+ <XDSBadge variant="error" label='99+' />
+ <XDSBadge variant="success" label={12} />
</div>
),
};
@@ -64,10 +64,10 @@ export const DotIndicators: Story = {
export const StatusLabels: Story = {
render: () => (
<div style={{display: 'flex', gap: '8px', alignItems: 'center'}}>
- <XDSBadge variant="success">Active</XDSBadge>
- <XDSBadge variant="warning">Pending</XDSBadge>
- <XDSBadge variant="error">Failed</XDSBadge>
- <XDSBadge variant="neutral">Draft</XDSBadge>
+ <XDSBadge variant="success" label='Active' />
+ <XDSBadge variant="warning" label='Pending' />
+ <XDSBadge variant="error" label='Failed' />
+ <XDSBadge variant="neutral" label='Draft' />
</div>
),
};
diff --git a/apps/storybook/stories/Button.stories.tsx b/apps/storybook/stories/Button.stories.tsx
index 99b0dbc971..23950b372d 100644
--- a/apps/storybook/stories/Button.stories.tsx
+++ b/apps/storybook/stories/Button.stories.tsx
@@ -136,12 +136,12 @@ export const WithEndSlot: Story = {
<XDSButton
label="Messages"
variant="primary"
- endSlot={<XDSBadge variant="info">3</XDSBadge>}
+ endSlot={<XDSBadge variant="info" label={3} />}
/>
<XDSButton
label="Notifications"
variant="secondary"
- endSlot={<XDSBadge variant="neutral">New</XDSBadge>}
+ endSlot={<XDSBadge variant="neutral" label='New' />}
/>
</div>
),
@@ -154,14 +154,14 @@ export const IconAndEndSlot: Story = {
label="Settings"
variant="secondary"
icon={<Cog6ToothIcon style={{width: 16, height: 16}} />}
- endSlot={<XDSBadge variant="info">New</XDSBadge>}>
+ endSlot={<XDSBadge variant="info" label='New' />}>
Settings
</XDSButton>
<XDSButton
label="Delete"
variant="destructive"
icon={<TrashIcon style={{width: 16, height: 16}} />}
- endSlot={<XDSBadge variant="error">5</XDSBadge>}>
+ endSlot={<XDSBadge variant="error" label={5} />}>
Delete
</XDSButton>
</div>
diff --git a/packages/cli/src/codemods/registry.mjs b/packages/cli/src/codemods/registry.mjs
index 5e506ec794..e7121493c6 100644
--- a/packages/cli/src/codemods/registry.mjs
+++ b/packages/cli/src/codemods/registry.mjs
@@ -7,7 +7,7 @@
const registry = new Map([
['0.0.2', () => import('./transforms/v0.0.2/index.mjs')],
- ['0.0.5', () => import('./transforms/v0.0.5/index.mjs')],
+ ['0.0.6', () => import('./transforms/v0.0.6/index.mjs')],
]);
/**
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-collapse-to-collapsible.test.mjs b/packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-collapse-to-collapsible.test.mjs
similarity index 100%
rename from packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-collapse-to-collapsible.test.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-collapse-to-collapsible.test.mjs
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-radius-tokens.test.mjs b/packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-radius-tokens.test.mjs
similarity index 100%
rename from packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-radius-tokens.test.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-radius-tokens.test.mjs
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-shadow-tokens.test.mjs b/packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-shadow-tokens.test.mjs
similarity index 100%
rename from packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-shadow-tokens.test.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-shadow-tokens.test.mjs
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-skeleton-radius.test.mjs b/packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-skeleton-radius.test.mjs
similarity index 100%
rename from packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-skeleton-radius.test.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-skeleton-radius.test.mjs
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-token-names.test.mjs b/packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-token-names.test.mjs
similarity index 100%
rename from packages/cli/src/codemods/transforms/v0.0.5/__tests__/migrate-token-names.test.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/__tests__/migrate-token-names.test.mjs
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/index.mjs b/packages/cli/src/codemods/transforms/v0.0.6/index.mjs
similarity index 78%
rename from packages/cli/src/codemods/transforms/v0.0.5/index.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/index.mjs
index 0fc04ac45e..26af4a1199 100644
--- a/packages/cli/src/codemods/transforms/v0.0.5/index.mjs
+++ b/packages/cli/src/codemods/transforms/v0.0.6/index.mjs
@@ -1,5 +1,5 @@
/**
- * @file v0.0.5 transform manifest
+ * @file v0.0.6 transform manifest
*/
import migrateCollapseToCollapsible, {
@@ -22,6 +22,10 @@ import migrateTokenNames, {
meta as tokenNamesMeta,
} from './migrate-token-names.mjs';
+import migrateBadgeChildrenToLabel, {
+ meta as badgeChildrenToLabelMeta,
+} from './migrate-badge-children-to-label.mjs';
+
export default [
{
name: 'migrate-collapse-to-collapsible',
@@ -48,4 +52,9 @@ export default [
transform: migrateTokenNames,
meta: tokenNamesMeta,
},
+ {
+ name: 'migrate-badge-children-to-label',
+ transform: migrateBadgeChildrenToLabel,
+ meta: badgeChildrenToLabelMeta,
+ },
];
diff --git a/packages/cli/src/codemods/transforms/v0.0.6/migrate-badge-children-to-label.mjs b/packages/cli/src/codemods/transforms/v0.0.6/migrate-badge-children-to-label.mjs
new file mode 100644
index 0000000000..89555b4027
--- /dev/null
+++ b/packages/cli/src/codemods/transforms/v0.0.6/migrate-badge-children-to-label.mjs
@@ -0,0 +1,89 @@
+/**
+ * Codemod: Migrate XDSBadge from children to label prop
+ *
+ * <XDSBadge variant="success">Active</XDSBadge> → <XDSBadge variant="success" label="Active" />
+ * <XDSBadge>3</XDSBadge> → <XDSBadge label={3} />
+ * <XDSBadge>{count}</XDSBadge> → <XDSBadge label={count} />
+ * <XDSBadge>{"text"}</XDSBadge> → <XDSBadge label="text" />
+ *
+ * Handles strings, numbers, and expressions.
+ * Skips badges with multiple children or JSX element children.
+ */
+
+export const meta = {
+ title: 'Migrate XDSBadge children to label prop',
+ description:
+ 'Converts <XDSBadge>content</XDSBadge> to <XDSBadge label={content} />.',
+ pr: '#706',
+};
+
+export default function transformer(file, api) {
+ const j = api.jscodeshift;
+ const root = j(file.source);
+ let hasChanges = false;
+
+ root
+ .find(j.JSXElement, {
+ openingElement: {name: {name: 'XDSBadge'}},
+ })
+ .forEach((path) => {
+ const {children} = path.node;
+
+ // Skip if already self-closing or no children
+ if (children.length === 0) return;
+
+ // Filter out whitespace-only JSXText nodes
+ const meaningful = children.filter(
+ (c) => !(c.type === 'JSXText' && !c.value.trim()),
+ );
+
+ // Only transform single-child cases
+ if (meaningful.length !== 1) return;
+
+ const child = meaningful[0];
+ let labelValue;
+
+ if (child.type === 'JSXText') {
+ const text = child.value.trim();
+ if (!text) return;
+
+ // Check if it's a number
+ if (/^\d+$/.test(text)) {
+ // <XDSBadge>3</XDSBadge> → label={3}
+ labelValue = j.jsxExpressionContainer(
+ j.numericLiteral(parseInt(text, 10)),
+ );
+ } else {
+ // <XDSBadge>Active</XDSBadge> → label="Active"
+ labelValue = j.stringLiteral(text);
+ }
+ } else if (child.type === 'JSXExpressionContainer') {
+ if (child.expression.type === 'StringLiteral') {
+ // <XDSBadge>{"text"}</XDSBadge> → label="text"
+ labelValue = j.stringLiteral(child.expression.value);
+ } else if (child.expression.type === 'NumericLiteral') {
+ // <XDSBadge>{3}</XDSBadge> → label={3}
+ labelValue = j.jsxExpressionContainer(child.expression);
+ } else {
+ // <XDSBadge>{count}</XDSBadge> → label={count}
+ labelValue = j.jsxExpressionContainer(child.expression);
+ }
+ } else {
+ // Skip JSXElement children or other complex cases
+ return;
+ }
+
+ // Add label prop
+ path.node.openingElement.attributes.push(
+ j.jsxAttribute(j.jsxIdentifier('label'), labelValue),
+ );
+
+ // Self-close
+ path.node.children = [];
+ path.node.openingElement.selfClosing = true;
+ path.node.closingElement = null;
+ hasChanges = true;
+ });
+
+ return hasChanges ? root.toSource({quote: 'single'}) : undefined;
+}
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/migrate-collapse-to-collapsible.mjs b/packages/cli/src/codemods/transforms/v0.0.6/migrate-collapse-to-collapsible.mjs
similarity index 100%
rename from packages/cli/src/codemods/transforms/v0.0.5/migrate-collapse-to-collapsible.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/migrate-collapse-to-collapsible.mjs
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/migrate-radius-tokens.mjs b/packages/cli/src/codemods/transforms/v0.0.6/migrate-radius-tokens.mjs
similarity index 100%
rename from packages/cli/src/codemods/transforms/v0.0.5/migrate-radius-tokens.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/migrate-radius-tokens.mjs
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/migrate-shadow-tokens.mjs b/packages/cli/src/codemods/transforms/v0.0.6/migrate-shadow-tokens.mjs
similarity index 100%
rename from packages/cli/src/codemods/transforms/v0.0.5/migrate-shadow-tokens.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/migrate-shadow-tokens.mjs
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/migrate-skeleton-radius.mjs b/packages/cli/src/codemods/transforms/v0.0.6/migrate-skeleton-radius.mjs
similarity index 100%
rename from packages/cli/src/codemods/transforms/v0.0.5/migrate-skeleton-radius.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/migrate-skeleton-radius.mjs
diff --git a/packages/cli/src/codemods/transforms/v0.0.5/migrate-token-names.mjs b/packages/cli/src/codemods/transforms/v0.0.6/migrate-token-names.mjs
similarity index 97%
rename from packages/cli/src/codemods/transforms/v0.0.5/migrate-token-names.mjs
rename to packages/cli/src/codemods/transforms/v0.0.6/migrate-token-names.mjs
index 4892bd588f..02e174df63 100644
--- a/packages/cli/src/codemods/transforms/v0.0.5/migrate-token-names.mjs
+++ b/packages/cli/src/codemods/transforms/v0.0.6/migrate-token-names.mjs
@@ -1,5 +1,5 @@
/**
- * @file Codemod: Migrate renamed design tokens from v0.0.5 naming audit
+ * @file Codemod: Migrate renamed design tokens from v0.0.6 naming audit
*
* Renames all tokens updated in the naming audit:
*
@@ -59,7 +59,7 @@
export const meta = {
title: 'Migrate renamed design tokens',
description:
- 'Renames color tokens from the v0.0.5 naming audit (positive→success, negative→error, divider→border, etc.).',
+ 'Renames color tokens from the v0.0.6 naming audit (positive→success, negative→error, divider→border, etc.).',
};
// Ordered longest-first to prevent partial matches
diff --git a/packages/core/src/Badge/Badge.doc.mjs b/packages/core/src/Badge/Badge.doc.mjs
index 327fd81784..0d036e5565 100644
--- a/packages/core/src/Badge/Badge.doc.mjs
+++ b/packages/core/src/Badge/Badge.doc.mjs
@@ -25,17 +25,17 @@ export const docs = {
examples: [
{
label: 'Text badge',
- code: '<XDSBadge>Default</XDSBadge>',
+ code: '<XDSBadge label="Default" />',
},
{
label: 'Status variants',
- code: `<XDSBadge variant="success">Active</XDSBadge>
-<XDSBadge variant="error">Failed</XDSBadge>
-<XDSBadge variant="warning">Pending</XDSBadge>`,
+ code: `<XDSBadge variant="success" label="Active" />
+<XDSBadge variant="error" label="Failed" />
+<XDSBadge variant="warning" label="Pending" />`,
},
{
label: 'Count badge',
- code: '<XDSBadge variant="info">42</XDSBadge>',
+ code: '<XDSBadge variant="info" label={42} />',
},
{
label: 'Dot indicator (no children)',
@@ -75,17 +75,17 @@ export const docsZh = {
examples: [
{
label: '文本徽章',
- code: '<XDSBadge>Default</XDSBadge>',
+ code: '<XDSBadge label="Default" />',
},
{
label: '状态变体',
- code: `<XDSBadge variant="success">Active</XDSBadge>
-<XDSBadge variant="error">Failed</XDSBadge>
-<XDSBadge variant="warning">Pending</XDSBadge>`,
+ code: `<XDSBadge variant="success" label="Active" />
+<XDSBadge variant="error" label="Failed" />
+<XDSBadge variant="warning" label="Pending" />`,
},
{
label: '计数徽章',
- code: '<XDSBadge variant="info">42</XDSBadge>',
+ code: '<XDSBadge variant="info" label={42} />',
},
{
label: '圆点指示器(无子元素)',
diff --git a/packages/core/src/Badge/XDSBadge.test.tsx b/packages/core/src/Badge/XDSBadge.test.tsx
index 65882a02e1..6bcfc25504 100644
--- a/packages/core/src/Badge/XDSBadge.test.tsx
+++ b/packages/core/src/Badge/XDSBadge.test.tsx
@@ -4,21 +4,21 @@ import {XDSBadge} from './XDSBadge';
describe('XDSBadge', () => {
it('renders with default variant', () => {
- render(<XDSBadge>Default</XDSBadge>);
+ render(<XDSBadge label="Default" />);
expect(screen.getByText('Default')).toBeInTheDocument();
});
it('renders with different variants', () => {
- const {rerender} = render(<XDSBadge variant="success">Success</XDSBadge>);
+ const {rerender} = render(<XDSBadge variant="success" label="Success" />);
expect(screen.getByText('Success')).toBeInTheDocument();
- rerender(<XDSBadge variant="error">Error</XDSBadge>);
+ rerender(<XDSBadge variant="error" label="Error" />);
expect(screen.getByText('Error')).toBeInTheDocument();
- rerender(<XDSBadge variant="warning">Warning</XDSBadge>);
+ rerender(<XDSBadge variant="warning" label="Warning" />);
expect(screen.getByText('Warning')).toBeInTheDocument();
- rerender(<XDSBadge variant="info">Info</XDSBadge>);
+ rerender(<XDSBadge variant="info" label="Info" />);
expect(screen.getByText('Info')).toBeInTheDocument();
});
@@ -31,7 +31,7 @@ describe('XDSBadge', () => {
it('renders with icon', () => {
render(
- <XDSBadge icon={<span data-testid="icon">*</span>}>With Icon</XDSBadge>,
+ <XDSBadge icon={<span data-testid="icon">*</span>} label="With Icon" />,
);
expect(screen.getByTestId('icon')).toBeInTheDocument();
expect(screen.getByText('With Icon')).toBeInTheDocument();
@@ -39,17 +39,17 @@ describe('XDSBadge', () => {
it('forwards ref', () => {
const ref = {current: null as HTMLSpanElement | null};
- render(<XDSBadge ref={ref}>Test</XDSBadge>);
+ render(<XDSBadge ref={ref} label="Test" />);
expect(ref.current).toBeInstanceOf(HTMLSpanElement);
});
it('spreads additional props', () => {
- render(<XDSBadge data-testid="custom-badge">Test</XDSBadge>);
+ render(<XDSBadge data-testid="custom-badge" label="Test" />);
expect(screen.getByTestId('custom-badge')).toBeInTheDocument();
});
it('renders xds-* class names for theme targeting', () => {
- const {container} = render(<XDSBadge variant="success">Active</XDSBadge>);
+ const {container} = render(<XDSBadge variant="success" label="Active" />);
const root = container.firstElementChild!;
expect(root.className).toContain('xds-badge');
expect(root.className).toContain('success');
diff --git a/packages/core/src/Badge/XDSBadge.tsx b/packages/core/src/Badge/XDSBadge.tsx
index ab9095829e..e3ad93d805 100644
--- a/packages/core/src/Badge/XDSBadge.tsx
+++ b/packages/core/src/Badge/XDSBadge.tsx
@@ -91,9 +91,10 @@ export interface XDSBadgeProps extends XDSBaseProps<HTMLSpanElement> {
variant?: XDSBadgeVariant;
/**
* The content to display in the badge.
- * If omitted, renders as a small dot indicator.
+ * If omitted (and no icon), renders as a small dot indicator.
*/
- children?: ReactNode;
+ label?: ReactNode;
+
/**
* Optional icon to display before the label.
*/
@@ -108,15 +109,15 @@ export interface XDSBadgeProps extends XDSBaseProps<HTMLSpanElement> {
*
* @example
* ```
- * <XDSBadge>Default</XDSBadge>
- * <XDSBadge variant="success">Active</XDSBadge>
- * <XDSBadge variant="error">3</XDSBadge>
+ * <XDSBadge label="Default" />
+ * <XDSBadge variant="success" label="Active" />
+ * <XDSBadge variant="error" label="3" />
* <XDSBadge variant="info" />
* ```
*/
export function XDSBadge({
variant = 'neutral',
- children,
+ label,
icon,
xstyle,
className,
@@ -124,7 +125,7 @@ export function XDSBadge({
ref,
...props
}: XDSBadgeProps) {
- const isDot = children == null && icon == null;
+ const isDot = label == null && icon == null;
return (
<span
@@ -142,7 +143,7 @@ export function XDSBadge({
)}
{...props}>
{icon}
- {children}
+ {label}
</span>
);
}
diff --git a/packages/core/src/Button/Button.doc.mjs b/packages/core/src/Button/Button.doc.mjs
index 930bb07a35..74def78888 100644
--- a/packages/core/src/Button/Button.doc.mjs
+++ b/packages/core/src/Button/Button.doc.mjs
@@ -114,15 +114,15 @@ export const docs = {
},
{
label: 'endSlot — badge after label',
- code: '<XDSButton label="Messages" endSlot={<XDSBadge>3</XDSBadge>} />',
+ code: '<XDSButton label="Messages" endSlot={<XDSBadge label={3} />} />',
},
{
label: 'endSlot — icon, label, and badge',
- code: '<XDSButton label="Edit" icon={<PencilIcon />} endSlot={<XDSBadge>New</XDSBadge>}>Edit</XDSButton>',
+ code: '<XDSButton label="Edit" icon={<PencilIcon />} endSlot={<XDSBadge label="New" />}>Edit</XDSButton>',
},
{
label: 'endSlot — settings with badge',
- code: `<XDSButton label="Settings" icon={<GearIcon />} endSlot={<XDSBadge>New</XDSBadge>}>
+ code: `<XDSButton label="Settings" icon={<GearIcon />} endSlot={<XDSBadge label="New" />}>
Settings
</XDSButton>`,
},
@@ -260,15 +260,15 @@ export const docsZh = {
},
{
label: 'endSlot——标签后的徽章',
- code: '<XDSButton label="Messages" endSlot={<XDSBadge>3</XDSBadge>} />',
+ code: '<XDSButton label="Messages" endSlot={<XDSBadge label={3} />} />',
},
{
label: 'endSlot——图标、标签和徽章',
- code: '<XDSButton label="Edit" icon={<PencilIcon />} endSlot={<XDSBadge>New</XDSBadge>}>Edit</XDSButton>',
+ code: '<XDSButton label="Edit" icon={<PencilIcon />} endSlot={<XDSBadge label="New" />}>Edit</XDSButton>',
},
{
label: 'endSlot——带徽章的设置按钮',
- code: `<XDSButton label="Settings" icon={<GearIcon />} endSlot={<XDSBadge>New</XDSBadge>}>
+ code: `<XDSButton label="Settings" icon={<GearIcon />} endSlot={<XDSBadge label="New" />}>
Settings
</XDSButton>`,
},
diff --git a/packages/core/src/Button/XDSButton.test.tsx b/packages/core/src/Button/XDSButton.test.tsx
index 729d68284f..b86be7a14a 100644
--- a/packages/core/src/Button/XDSButton.test.tsx
+++ b/packages/core/src/Button/XDSButton.test.tsx
@@ -105,7 +105,7 @@ describe('XDSButton', () => {
render(
<XDSButton
label="Click me"
- endSlot={<XDSBadge data-testid="end">3</XDSBadge>}
+ endSlot={<XDSBadge data-testid="end" label={3} />}
/>,
);
const button = screen.getByRole('button');
@@ -118,7 +118,7 @@ describe('XDSButton', () => {
render(
<XDSButton
label="Accessible name"
- endSlot={<XDSBadge data-testid="end">New</XDSBadge>}>
+ endSlot={<XDSBadge data-testid="end" label='New' />}>
Custom content
</XDSButton>,
);
@@ -132,7 +132,7 @@ describe('XDSButton', () => {
<XDSButton
label="Settings"
icon={<span data-testid="icon">⚙</span>}
- endSlot={<XDSBadge data-testid="end">New</XDSBadge>}>
+ endSlot={<XDSBadge data-testid="end" label='New' />}>
Settings
</XDSButton>,
);
@@ -158,7 +158,7 @@ describe('XDSButton', () => {
<XDSButton
label="Settings"
icon={<span data-testid="icon">⚙</span>}
- endSlot={<XDSBadge data-testid="end">3</XDSBadge>}
+ endSlot={<XDSBadge data-testid="end" label={3} />}
/>,
);
expect(screen.getByTestId('icon')).toBeInTheDocument();
@@ -169,7 +169,7 @@ describe('XDSButton', () => {
render(
<XDSButton
label="Test"
- endSlot={<XDSBadge data-testid="end">3</XDSBadge>}
+ endSlot={<XDSBadge data-testid="end" label={3} />}
/>,
);
const badge = screen.getByTestId('end');
@@ -185,7 +185,7 @@ describe('XDSButton', () => {
<XDSButton
label="Submit"
isLoading
- endSlot={<XDSBadge data-testid="end">3</XDSBadge>}
+ endSlot={<XDSBadge data-testid="end" label={3} />}
/>,
);
// endSlot should still be in the DOM
diff --git a/packages/core/src/SideNav/SideNav.doc.mjs b/packages/core/src/SideNav/SideNav.doc.mjs
index ba14abce70..ca618ecd20 100644
--- a/packages/core/src/SideNav/SideNav.doc.mjs
+++ b/packages/core/src/SideNav/SideNav.doc.mjs
@@ -100,7 +100,7 @@ export const docs = {
label="Projects"
icon={FolderIcon}
href="/projects"
- endContent={<XDSBadge>3</XDSBadge>}
+ endContent={<XDSBadge label={3} />}
/>
</XDSSideNavSection>
@@ -320,7 +320,7 @@ export const docs = {
selectedIcon={HomeIconSolid}
isSelected
href="/dashboard"
- endContent={<XDSBadge>3</XDSBadge>}
+ endContent={<XDSBadge label={3} />}
/>`,
},
{
@@ -376,7 +376,7 @@ export const docs = {
},
{
label: 'With end content and hidden header',
- code: `<XDSSideNavSection title="Settings" endContent={<XDSBadge>New</XDSBadge>}>
+ code: `<XDSSideNavSection title="Settings" endContent={<XDSBadge label="New" />}>
<XDSSideNavItem label="General" href="/settings/general" />
<XDSSideNavItem label="Security" href="/settings/security" />
</XDSSideNavSection>`,
@@ -535,7 +535,7 @@ export const docsZh = {
label="Projects"
icon={FolderIcon}
href="/projects"
- endContent={<XDSBadge>3</XDSBadge>}
+ endContent={<XDSBadge label={3} />}
/>
</XDSSideNavSection>
@@ -755,7 +755,7 @@ export const docsZh = {
selectedIcon={HomeIconSolid}
isSelected
href="/dashboard"
- endContent={<XDSBadge>3</XDSBadge>}
+ endContent={<XDSBadge label={3} />}
/>`,
},
{
@@ -811,7 +811,7 @@ export const docsZh = {
},
{
label: '带尾部内容和隐藏头部',
- code: `<XDSSideNavSection title="Settings" endContent={<XDSBadge>New</XDSBadge>}>
+ code: `<XDSSideNavSection title="Settings" endContent={<XDSBadge label="New" />}>
<XDSSideNavItem label="General" href="/settings/general" />
<XDSSideNavItem label="Security" href="/settings/security" />
</XDSSideNavSection>`,
diff --git a/packages/core/src/Table/Table.doc.mjs b/packages/core/src/Table/Table.doc.mjs
index f7b5bec767..67f9347ac6 100644
--- a/packages/core/src/Table/Table.doc.mjs
+++ b/packages/core/src/Table/Table.doc.mjs
@@ -47,9 +47,7 @@ export const docs = {
renderCell: user => (
<XDSHStack gap={2} align="center">
<XDSStatusDot status={user.isActive ? 'positive' : 'negative'} />
- <XDSBadge variant={user.isActive ? 'success' : 'error'}>
- {user.isActive ? 'Active' : 'Inactive'}
- </XDSBadge>
+ <XDSBadge variant={user.isActive ? 'success' : 'error'} label={user.isActive ? 'Active' : 'Inactive'} />
</XDSHStack>
),
},
@@ -113,9 +111,9 @@ export const docs = {
: tx.status === 'pending'
? 'warning'
: 'error'
- }>
- {tx.status}
- </XDSBadge>
+ }
+ label={tx.status}
+ />
),
},
]}
@@ -135,7 +133,7 @@ export const docs = {
</XDSHStack>
</XDSTableCell>
<XDSTableCell>
- <XDSBadge variant="success">Active</XDSBadge>
+ <XDSBadge variant="success" label="Active" />
</XDSTableCell>
</XDSTableRow>
</XDSTable>`,
@@ -544,9 +542,7 @@ export const docsZh = {
renderCell: user => (
<XDSHStack gap={2} align="center">
<XDSStatusDot status={user.isActive ? 'positive' : 'negative'} />
- <XDSBadge variant={user.isActive ? 'success' : 'error'}>
- {user.isActive ? 'Active' : 'Inactive'}
- </XDSBadge>
+ <XDSBadge variant={user.isActive ? 'success' : 'error'} label={user.isActive ? 'Active' : 'Inactive'} />
</XDSHStack>
),
},
@@ -610,9 +606,9 @@ export const docsZh = {
: tx.status === 'pending'
? 'warning'
: 'error'
- }>
- {tx.status}
- </XDSBadge>
+ }
+ label={tx.status}
+ />
),
},
]}
@@ -632,7 +628,7 @@ export const docsZh = {
</XDSHStack>
</XDSTableCell>
<XDSTableCell>
- <XDSBadge variant="success">Active</XDSBadge>
+ <XDSBadge variant="success" label="Active" />
</XDSTableCell>
</XDSTableRow>
</XDSTable>`,