Skip to content

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

TypeScript

docs(Badge): mark label as required, as its props type is (#8008)

Cindy Zhang10930261f628
diff --git a/.changeset/badge-label-required-doc.md b/.changeset/badge-label-required-doc.md
new file mode 100644
index 0000000000..e69923735b
--- /dev/null
+++ b/.changeset/badge-label-required-doc.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[docs] Badge's documentation marks `label` as required, as its props type already does. `astryx component Badge` and the docsite no longer list it as optional.
+
+@cixzhang
diff --git a/packages/cli/test/core-prop-docs.known-drift.json b/packages/cli/test/core-prop-docs.known-drift.json
index 0f47af79ed..e500884789 100644
--- a/packages/cli/test/core-prop-docs.known-drift.json
+++ b/packages/cli/test/core-prop-docs.known-drift.json
@@ -1,6 +1,5 @@
[
"src/AppShell/AppShell.doc.mjs AppShell.children required_mismatch",
- "src/Badge/Badge.doc.mjs Badge.label required_mismatch",
"src/Center/Center.doc.mjs Center.children required_mismatch",
"src/CommandPalette/CommandPaletteInput.doc.mjs CommandPaletteInput.onChange not_in_doc",
"src/ComplexSelector/ComplexSelector.doc.mjs ComplexSelector.description not_in_doc",
diff --git a/packages/core/src/Badge/Badge.doc.mjs b/packages/core/src/Badge/Badge.doc.mjs
index 0376f5d145..2b42697b8e 100644
--- a/packages/core/src/Badge/Badge.doc.mjs
+++ b/packages/core/src/Badge/Badge.doc.mjs
@@ -18,6 +18,7 @@ export const docs = {
{
name: 'label',
type: 'ReactNode',
+ required: true,
description:
'Badge text content. A badge is one line, so a label wider than the space available is cut with an ellipsis rather than escaping its container; a string or number label is also set as the badge\'s title so the full text stays reachable on hover.',
},
@@ -93,7 +94,7 @@ export const docsZh = {
description: '视觉样式变体。语义变体使用实色背景,非语义颜色变体使用浅色背景配彩色文字。',
default: "'neutral'",
},
- {name: 'label', type: 'ReactNode', description: '徽章文本内容。'},
+ {name: 'label', type: 'ReactNode', required: true, description: '徽章文本内容。'},
{name: 'icon', type: 'ReactNode', description: '可选的前置图标。'},
],
theming: {