Skip to content

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

TypeScript

fix(docsite): correct Chat group label and re-consolidate Navigation group (#2547)

Kenton Quatmanecb938746521
diff --git a/apps/docsite/scripts/generate-data.mjs b/apps/docsite/scripts/generate-data.mjs
index 23432a1015..95d0485026 100644
--- a/apps/docsite/scripts/generate-data.mjs
+++ b/apps/docsite/scripts/generate-data.mjs
@@ -520,6 +520,20 @@ export const componentCount = ${totalCount};
return {allComponents, totalCount};
}
+/**
+ * Humanize a raw group label (a PascalCase component/group name) into a
+ * spaced display label, e.g. 'TopNav' -> 'Top Nav', 'Chat' -> 'Chat'.
+ * Used as the group label when no member's name exactly matches the group
+ * (so the label doesn't fall back to an arbitrary member's displayName like
+ * 'Chat Composer' for the 'Chat' group).
+ */
+function humanizeGroupLabel(label) {
+ return label
+ .replace(/([a-z0-9])([A-Z])/g, '$1 $2')
+ .replace(/([A-Z]+)([A-Z][a-z])/g, '$1 $2')
+ .trim();
+}
+
function generateGroupedComponentRegistry(allComponents) {
console.log('Generating grouped component registry...');
@@ -591,10 +605,16 @@ function generateGroupedComponentRegistry(allComponents) {
if (members.length === 1) {
items.push({sortKey: members[0].name, item: {type: 'entry', name: members[0].name, displayName: members[0].displayName, href: members[0].href, description: members[0].description}});
} else {
- const canonical = members.find(m => m.name === label) || members[0];
- // Use the canonical member's already-required displayName as the
- // group label. Falls back to the raw label only as a safety net.
- items.push({sortKey: label, item: {type: 'group', label, displayName: canonical.displayName || label, description: canonical.description, entries: members.map(m => ({name: m.name, displayName: m.displayName, href: m.href}))}});
+ const canonical = members.find(m => m.name === label);
+ // Prefer the canonical member's already-required displayName as the
+ // group label. When no member's name matches the group label (e.g. the
+ // 'Chat' group has no component literally named 'Chat'), humanize the
+ // raw label instead of falling back to an arbitrary member's
+ // displayName (which produced labels like 'Chat Composer').
+ const groupDisplayName = canonical
+ ? canonical.displayName
+ : humanizeGroupLabel(label);
+ items.push({sortKey: label, item: {type: 'group', label, displayName: groupDisplayName, description: (canonical || members[0]).description, entries: members.map(m => ({name: m.name, displayName: m.displayName, href: m.href}))}});
}
}
for (const entry of ungrouped) {
diff --git a/packages/core/src/MobileNav/MobileNav.doc.mjs b/packages/core/src/MobileNav/MobileNav.doc.mjs
index e38704ed9a..76f707b2fc 100644
--- a/packages/core/src/MobileNav/MobileNav.doc.mjs
+++ b/packages/core/src/MobileNav/MobileNav.doc.mjs
@@ -5,7 +5,7 @@
export const docs = {
name: 'MobileNav',
displayName: 'Mobile Nav',
- group: 'MobileNav',
+ group: 'Navigation',
category: 'Navigation',
isHiddenFromOverview: true,
keywords: ["mobilenav","drawer","sidebar","navigation","hamburger","menu","offcanvas","slideout","navdrawer"],
diff --git a/packages/core/src/NavIcon/NavIcon.doc.mjs b/packages/core/src/NavIcon/NavIcon.doc.mjs
index 5b78c9f59e..40af44d0ce 100644
--- a/packages/core/src/NavIcon/NavIcon.doc.mjs
+++ b/packages/core/src/NavIcon/NavIcon.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'NavIcon',
displayName: 'Nav Icon',
+ group: 'Navigation',
category: 'Navigation',
isHiddenFromOverview: true,
hidden: false,
diff --git a/packages/core/src/NavMenu/NavMenu.doc.mjs b/packages/core/src/NavMenu/NavMenu.doc.mjs
index d2ba90310c..96fbf1530a 100644
--- a/packages/core/src/NavMenu/NavMenu.doc.mjs
+++ b/packages/core/src/NavMenu/NavMenu.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'NavHeadingMenu',
displayName: 'Nav Heading Menu',
+ group: 'Navigation',
category: 'Navigation',
isHiddenFromOverview: true,
hidden: false,
diff --git a/packages/core/src/SideNav/SideNav.doc.mjs b/packages/core/src/SideNav/SideNav.doc.mjs
index feebdd2b34..2e36c1829a 100644
--- a/packages/core/src/SideNav/SideNav.doc.mjs
+++ b/packages/core/src/SideNav/SideNav.doc.mjs
@@ -5,7 +5,7 @@
export const docs = {
name: 'SideNav',
displayName: 'Side Nav',
- group: 'SideNav',
+ group: 'Navigation',
category: 'Navigation',
keywords: ["sidenav","sidebar","navigation","drawer","menu","nav","aside","sidemenu","navmenu","sider","treeview"],
playground: {
diff --git a/packages/core/src/TopNav/TopNav.doc.mjs b/packages/core/src/TopNav/TopNav.doc.mjs
index 587aedca78..7ad6aee0a9 100644
--- a/packages/core/src/TopNav/TopNav.doc.mjs
+++ b/packages/core/src/TopNav/TopNav.doc.mjs
@@ -5,7 +5,7 @@
export const docs = {
name: 'TopNav',
displayName: 'Top Nav',
- group: 'TopNav',
+ group: 'Navigation',
category: 'Navigation',
keywords: ["topnav","navbar","appbar","header","toolbar","navigation","menubar","topbar"],
playground: {