Skip to content

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

TypeScript

feat(docsite): add component categories and sub-component tagging (#2418)

Kenton Quatmanc546a979d659
diff --git a/apps/docsite/scripts/generate-data.mjs b/apps/docsite/scripts/generate-data.mjs
index 74776847e6..42f015ed7f 100644
--- a/apps/docsite/scripts/generate-data.mjs
+++ b/apps/docsite/scripts/generate-data.mjs
@@ -68,6 +68,8 @@ const HIDDEN_RE = /(?:^|\n) {0,4}hidden:\s*true/;
const NAME_RE = /(?:^|\n) {0,4}name:\s*['"]([^'"]+)['"]/;
const DISPLAY_NAME_RE = /(?:^|\n) {0,4}displayName:\s*['"]([^'"]+)['"]/;
const KEYWORDS_RE = /keywords:\s*\[([^\]]*)\]/;
+const CATEGORY_RE = /(?:^|\n) {0,4}category:\s*['"]([^'"]+)['"]/;
+const IS_HIDDEN_FROM_OVERVIEW_RE = /(?:^|\n) {0,4}isHiddenFromOverview:\s*true/;
function readDocMeta(docPath) {
try {
@@ -81,6 +83,8 @@ function readDocMeta(docPath) {
const keywords = kwMatch
? [...kwMatch[1].matchAll(/['"]([^'"]+)['"]/g)].map(m => m[1])
: [];
+ const categoryMatch = CATEGORY_RE.exec(content);
+ const isHiddenFromOverview = IS_HIDDEN_FROM_OVERVIEW_RE.test(content);
return {
group: groupMatch?.[1] ?? null,
description: descMatch?.[1] ?? '',
@@ -88,9 +92,11 @@ function readDocMeta(docPath) {
displayName: displayNameMatch?.[1] ?? null,
hidden,
keywords,
+ category: categoryMatch?.[1] ?? null,
+ isHiddenFromOverview,
};
} catch {
- return {group: null, description: '', name: null, displayName: null, hidden: false, keywords: []};
+ return {group: null, description: '', name: null, displayName: null, hidden: false, keywords: [], category: null, isHiddenFromOverview: false};
}
}
@@ -277,6 +283,8 @@ async function generateComponentRegistry() {
}
const group = doc.group || null;
+ const category = doc.category || null;
+ const isHiddenFromOverview = doc.isHiddenFromOverview ?? false;
const keywords = doc.keywords || [];
const hidden = doc.hidden ?? false;
const topDescription = doc.usage?.description || doc.description || '';
@@ -288,6 +296,9 @@ async function generateComponentRegistry() {
for (const sub of doc.components) {
const subName = (sub.name || '').replace(/^XDS/, '');
if (!subName) continue;
+ // Sub-entries whose name differs from the doc name are
+ // sub-components — hide them from the overview page.
+ const isSubEntry = subName !== doc.name;
pendingSubComponents.push({
name: subName,
displayName: requireDisplayName(
@@ -297,6 +308,8 @@ async function generateComponentRegistry() {
moduleName: sub.name || subName,
directory: entry.name,
group,
+ category,
+ isHiddenFromOverview: isHiddenFromOverview || isSubEntry,
description: sub.description || topDescription,
keywords,
hidden,
@@ -324,6 +337,8 @@ async function generateComponentRegistry() {
moduleName: name,
directory: entry.name,
group,
+ category,
+ isHiddenFromOverview,
description: topDescription,
keywords,
hidden,
@@ -350,6 +365,8 @@ async function generateComponentRegistry() {
moduleName: name.startsWith('use') ? name : `XDS${name}`,
directory: entry.name,
group,
+ category,
+ isHiddenFromOverview,
description: topDescription,
keywords,
hidden,
@@ -467,6 +484,10 @@ export interface ComponentEntry {
moduleName: string;
directory: string;
group: string | null;
+ /** Functional category for the overview gallery (Actions, Inputs, etc.) */
+ category: string | null;
+ /** Whether this component is hidden from the overview page. */
+ isHiddenFromOverview: boolean;
description: string;
keywords: string[];
hidden: boolean;
diff --git a/apps/docsite/src/app/(docs)/components/page.tsx b/apps/docsite/src/app/(docs)/components/page.tsx
index abdc1f361b..f598af2b01 100644
--- a/apps/docsite/src/app/(docs)/components/page.tsx
+++ b/apps/docsite/src/app/(docs)/components/page.tsx
@@ -6,22 +6,50 @@
'use client';
-import {useMemo} from 'react';
+import {useMemo, useState} from 'react';
import * as stylex from '@stylexjs/stylex';
+import {MagnifyingGlassIcon} from '@heroicons/react/24/outline';
import {XDSText} from '@xds/core/Text';
+import {XDSHeading} from '@xds/core/Text';
import {XDSVStack} from '@xds/core/Layout';
import {XDSSection} from '@xds/core/Section';
import {XDSGrid} from '@xds/core/Grid';
import {XDSClickableCard} from '@xds/core/ClickableCard';
+import {XDSTextInput} from '@xds/core/TextInput';
+import {XDSDivider} from '@xds/core/Divider';
+import {components as componentRegistry} from '../../../generated/componentRegistry';
import {blocks} from '../../../generated/blockRegistry';
import {ShowcaseThumbnail} from '../../../components/ShowcaseThumbnail';
-const showcases = blocks.filter(b => b.isShowcase);
+/**
+ * Category display order for the overview page.
+ * Sourced from component .doc.mjs `category` fields.
+ */
+const CATEGORIES = [
+ 'Actions',
+ 'Communications',
+ 'Containers',
+ 'Layout',
+ 'Inputs',
+ 'Lists',
+ 'Navigation',
+ 'Performance',
+] as const;
+
+/** Map of showcase blocks by component name for thumbnails */
+const showcaseMap = new Map(
+ blocks
+ .filter(b => b.isShowcase)
+ .map(b => [b.componentsUsed[0] || b.exampleFor, b]),
+);
const styles = stylex.create({
heroTitle: {
textAlign: 'center' as const,
},
+ categorySection: {
+ paddingBlock: 'var(--spacing-4)',
+ },
cardImage: {
display: 'block',
width: '100%',
@@ -31,18 +59,73 @@ const styles = stylex.create({
},
});
+interface CategoryItem {
+ name: string;
+ displayName: string;
+ description: string;
+ href: string;
+ category: string;
+ /** Showcase block for thumbnail, if available */
+ showcase: (typeof blocks)[number] | undefined;
+}
+
export default function ComponentsGalleryPage() {
- const items = useMemo(
- () =>
- showcases.map(b => ({
- name: b.displayName,
- description: b.description,
- slug: b.dirName,
- category: b.category,
- href: `/components/${b.componentsUsed[0] || b.category.split('/').pop()}`,
- })),
- [],
- );
+ const [query, setQuery] = useState('');
+
+ /** All categorized components (excluding hidden, hooks, and utilities) */
+ const categorizedItems = useMemo(() => {
+ const coreComponents = componentRegistry['@xds/core'] ?? [];
+ const items: CategoryItem[] = [];
+
+ for (const comp of coreComponents) {
+ // Skip components explicitly hidden from overview
+ if (comp.isHiddenFromOverview) continue;
+ // Skip hidden components
+ if (comp.hidden) continue;
+ // Skip hooks (they appear in the Utilities section)
+ if (comp.name.startsWith('use')) continue;
+ // Skip components without a category
+ if (!comp.category) continue;
+ // Skip utilities group
+ if (comp.group === 'Utilities') continue;
+
+ items.push({
+ name: comp.name,
+ displayName: comp.displayName,
+ description: comp.description,
+ href: `/components/${comp.name}`,
+ category: comp.category,
+ showcase: showcaseMap.get(comp.name),
+ });
+ }
+
+ return items;
+ }, []);
+
+ /** Filtered items based on search query */
+ const filteredItems = useMemo(() => {
+ const q = query.trim().toLowerCase();
+ if (!q) return categorizedItems;
+ return categorizedItems.filter(
+ item =>
+ item.name.toLowerCase().includes(q) ||
+ item.displayName.toLowerCase().includes(q) ||
+ item.description.toLowerCase().includes(q),
+ );
+ }, [categorizedItems, query]);
+
+ /** Group filtered items by category */
+ const groupedByCategory = useMemo(() => {
+ const map = new Map<string, CategoryItem[]>();
+ for (const cat of CATEGORIES) {
+ map.set(cat, []);
+ }
+ for (const item of filteredItems) {
+ const list = map.get(item.category);
+ if (list) list.push(item);
+ }
+ return map;
+ }, [filteredItems]);
return (
<XDSSection maxWidth="xl" padding={6}>
@@ -57,27 +140,53 @@ export default function ComponentsGalleryPage() {
</XDSText>
</XDSVStack>
- <XDSGrid columns={{minWidth: 300, repeat: 'fill'}} gap={4} rowGap={6}>
- {items.map(item => (
- <XDSVStack key={item.slug} gap={2}>
- <XDSClickableCard
- label={item.name}
- href={item.href}
- padding={0}
- variant="transparent">
- {item.category ? (
- <ShowcaseThumbnail
- dirName={item.slug}
- category={item.category}
- />
- ) : (
- <div {...stylex.props(styles.cardImage)} />
- )}
- </XDSClickableCard>
- <XDSText>{item.name}</XDSText>
+ <XDSTextInput
+ label="Search components"
+ isLabelHidden
+ value={query}
+ onChange={setQuery}
+ placeholder="Search components…"
+ startIcon={MagnifyingGlassIcon}
+ hasClear
+ />
+
+ {CATEGORIES.map(cat => {
+ const items = groupedByCategory.get(cat) ?? [];
+ if (items.length === 0) return null;
+
+ return (
+ <XDSVStack key={cat} gap={4} xstyle={styles.categorySection}>
+ <XDSHeading level={2}>{cat}</XDSHeading>
+
+ <XDSGrid
+ columns={{minWidth: 280, repeat: 'fill'}}
+ gap={4}
+ rowGap={6}>
+ {items.map(item => (
+ <XDSVStack key={item.name} gap={2}>
+ <XDSClickableCard
+ label={item.displayName}
+ href={item.href}
+ padding={0}
+ variant="transparent">
+ {item.showcase ? (
+ <ShowcaseThumbnail
+ dirName={item.showcase.dirName}
+ category={item.showcase.category}
+ />
+ ) : (
+ <div {...stylex.props(styles.cardImage)} />
+ )}
+ </XDSClickableCard>
+ <XDSText type="supporting">{item.displayName}</XDSText>
+ </XDSVStack>
+ ))}
+ </XDSGrid>
+
+ <XDSDivider />
</XDSVStack>
- ))}
- </XDSGrid>
+ );
+ })}
</XDSVStack>
</XDSSection>
);
diff --git a/packages/core/src/AlertDialog/AlertDialog.doc.mjs b/packages/core/src/AlertDialog/AlertDialog.doc.mjs
index 2a4fee6219..1fd2a7faa6 100644
--- a/packages/core/src/AlertDialog/AlertDialog.doc.mjs
+++ b/packages/core/src/AlertDialog/AlertDialog.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'AlertDialog',
displayName: 'Alert Dialog',
group: 'Dialog',
+ category: 'Containers',
keywords: [
'alert',
'alertdialog',
diff --git a/packages/core/src/AppShell/AppShell.doc.mjs b/packages/core/src/AppShell/AppShell.doc.mjs
index ea7bd5fdc1..3108841e94 100644
--- a/packages/core/src/AppShell/AppShell.doc.mjs
+++ b/packages/core/src/AppShell/AppShell.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'AppShell',
displayName: 'App Shell',
+ category: 'Containers',
keywords: ["appshell","layout","scaffold","sidebar","sidenav","topnav","header","navigation","dashboard","shell","page","frame"],
usage: {
description:
diff --git a/packages/core/src/AspectRatio/AspectRatio.doc.mjs b/packages/core/src/AspectRatio/AspectRatio.doc.mjs
index fcb0b25113..b1efe62e48 100644
--- a/packages/core/src/AspectRatio/AspectRatio.doc.mjs
+++ b/packages/core/src/AspectRatio/AspectRatio.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'AspectRatio',
displayName: 'Aspect Ratio',
+ category: 'Layout',
keywords: ["aspect-ratio","ratio","proportion","responsive","embed","container","widescreen","thumbnail","letterbox","crop"],
usage: {
description:
diff --git a/packages/core/src/Avatar/Avatar.doc.mjs b/packages/core/src/Avatar/Avatar.doc.mjs
index c7b5c2ba8c..3771718353 100644
--- a/packages/core/src/Avatar/Avatar.doc.mjs
+++ b/packages/core/src/Avatar/Avatar.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Avatar',
displayName: 'Avatar',
group: 'Avatar',
+ category: 'Communications',
keywords: ["avatar","profile","user","photo","thumbnail","initials","gravatar","pfp","userpic"],
usage: {
description:
diff --git a/packages/core/src/AvatarGroup/AvatarGroup.doc.mjs b/packages/core/src/AvatarGroup/AvatarGroup.doc.mjs
index 11ba8da630..40ccdc8bbb 100644
--- a/packages/core/src/AvatarGroup/AvatarGroup.doc.mjs
+++ b/packages/core/src/AvatarGroup/AvatarGroup.doc.mjs
@@ -5,6 +5,7 @@ export const docs = {
name: 'AvatarGroup',
displayName: 'Avatar Group',
group: 'Avatar',
+ category: 'Communications',
keywords: ['avatar', 'group', 'facepile', 'stack', 'overlap', 'participants', 'assignees', 'members', 'team'],
usage: {
description:
diff --git a/packages/core/src/Badge/Badge.doc.mjs b/packages/core/src/Badge/Badge.doc.mjs
index 096019a1eb..ebaeb2bfae 100644
--- a/packages/core/src/Badge/Badge.doc.mjs
+++ b/packages/core/src/Badge/Badge.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Badge',
displayName: 'Badge',
+ category: 'Communications',
keywords: ["badge","tag","chip","label","status","indicator","count","counter","pill","notification","marker"],
props: [
{
diff --git a/packages/core/src/Banner/Banner.doc.mjs b/packages/core/src/Banner/Banner.doc.mjs
index 6a8d231e74..20d911bb96 100644
--- a/packages/core/src/Banner/Banner.doc.mjs
+++ b/packages/core/src/Banner/Banner.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Banner',
displayName: 'Banner',
+ category: 'Communications',
keywords: ["banner","alert","notification","callout","notice","status","message","info","warning","error","success","toast"],
usage: {
description:
diff --git a/packages/core/src/Blockquote/Blockquote.doc.mjs b/packages/core/src/Blockquote/Blockquote.doc.mjs
index 634199ee0d..dd75c5cd22 100644
--- a/packages/core/src/Blockquote/Blockquote.doc.mjs
+++ b/packages/core/src/Blockquote/Blockquote.doc.mjs
@@ -7,6 +7,7 @@
export const docs = {
name: 'Blockquote',
displayName: 'Blockquote',
+ category: 'Communications',
keywords: ["blockquote","quote","citation","pullquote","quotation","cite","excerpt"],
props: [
{
diff --git a/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs b/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs
index 8dcb1d123c..7ac948360a 100644
--- a/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs
+++ b/packages/core/src/Breadcrumbs/Breadcrumbs.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Breadcrumbs',
displayName: 'Breadcrumbs',
group: 'Breadcrumbs',
+ category: 'Navigation',
keywords: ["breadcrumbs","breadcrumb","navigation","nav","crumbs","trail","path","hierarchy","wayfinding","steps"],
usage: {
description:
diff --git a/packages/core/src/Button/Button.doc.mjs b/packages/core/src/Button/Button.doc.mjs
index a6f5d210d1..05c1b4f420 100644
--- a/packages/core/src/Button/Button.doc.mjs
+++ b/packages/core/src/Button/Button.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Button',
displayName: 'Button',
group: 'Button',
+ category: 'Actions',
keywords: ["button","btn","cta","submit","action","loading","primary","secondary","ghost","destructive","danger"],
diff --git a/packages/core/src/ButtonGroup/ButtonGroup.doc.mjs b/packages/core/src/ButtonGroup/ButtonGroup.doc.mjs
index 99e319c3c2..dc4fb71136 100644
--- a/packages/core/src/ButtonGroup/ButtonGroup.doc.mjs
+++ b/packages/core/src/ButtonGroup/ButtonGroup.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'ButtonGroup',
displayName: 'Button Group',
group: 'Button',
+ category: 'Actions',
keywords: ["button-group","connected","split","toolbar","actions","grouped","buttons"],
playground: {
defaults: {
diff --git a/packages/core/src/Calendar/Calendar.doc.mjs b/packages/core/src/Calendar/Calendar.doc.mjs
index 83a0a44b2b..4934b4d534 100644
--- a/packages/core/src/Calendar/Calendar.doc.mjs
+++ b/packages/core/src/Calendar/Calendar.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Calendar',
displayName: 'Calendar',
+ category: 'Inputs',
keywords: ["calendar","datepicker","date picker","rangepicker","date range","monthview","daypicker"],
usage: {
description:
diff --git a/packages/core/src/Card/Card.doc.mjs b/packages/core/src/Card/Card.doc.mjs
index d52427ccdf..96c7b17dcf 100644
--- a/packages/core/src/Card/Card.doc.mjs
+++ b/packages/core/src/Card/Card.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Card',
displayName: 'Card',
group: 'Card',
+ category: 'Containers',
keywords: ["card","surface","panel","container","elevated","shadow","box","paper","tile","well"],
usage: {
description:
diff --git a/packages/core/src/Carousel/Carousel.doc.mjs b/packages/core/src/Carousel/Carousel.doc.mjs
index 6d8a85234d..b30f945c55 100644
--- a/packages/core/src/Carousel/Carousel.doc.mjs
+++ b/packages/core/src/Carousel/Carousel.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Carousel',
displayName: 'Carousel',
+ category: 'Lists',
keywords: ['carousel', 'slider', 'scroll', 'gallery', 'filmstrip', 'swiper', 'horizontal', 'overflow', 'snap'],
usage: {
description:
diff --git a/packages/core/src/Center/Center.doc.mjs b/packages/core/src/Center/Center.doc.mjs
index 191b427d83..f3fde67432 100644
--- a/packages/core/src/Center/Center.doc.mjs
+++ b/packages/core/src/Center/Center.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Center',
displayName: 'Center',
group: 'Layout',
+ category: 'Layout',
keywords: ["center","centered","centering","align","alignment","justify","flexbox","middle"],
props: [
{
diff --git a/packages/core/src/Chat/Chat.doc.mjs b/packages/core/src/Chat/Chat.doc.mjs
index 43ebca0a8d..169a832f80 100644
--- a/packages/core/src/Chat/Chat.doc.mjs
+++ b/packages/core/src/Chat/Chat.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Chat',
displayName: 'Chat',
group: 'Chat',
+ category: 'Communications',
keywords: ['chat', 'message', 'bubble', 'conversation', 'ai', 'assistant', 'thread', 'system-message', 'composer', 'mention', 'trigger', 'typeahead', 'token', 'imperative', 'tokenized-text'],
theming: {
targets: [
diff --git a/packages/core/src/Chat/ChatDictationButton.doc.mjs b/packages/core/src/Chat/ChatDictationButton.doc.mjs
index 3dfbe12236..172bc25c8f 100644
--- a/packages/core/src/Chat/ChatDictationButton.doc.mjs
+++ b/packages/core/src/Chat/ChatDictationButton.doc.mjs
@@ -6,6 +6,8 @@ export const docs = {
name: 'ChatDictationButton',
displayName: 'Chat Dictation Button',
group: 'Chat',
+ category: 'Communications',
+ isHiddenFromOverview: true,
hidden: false,
keywords: ['dictation', 'microphone', 'voice', 'speech', 'recording', 'stt', 'speech-to-text', 'voice-input', 'mic'],
diff --git a/packages/core/src/Chat/ChatToolCalls.doc.mjs b/packages/core/src/Chat/ChatToolCalls.doc.mjs
index 91a06710c6..38f9d91772 100644
--- a/packages/core/src/Chat/ChatToolCalls.doc.mjs
+++ b/packages/core/src/Chat/ChatToolCalls.doc.mjs
@@ -6,6 +6,8 @@ export const docs = {
name: 'ChatToolCalls',
displayName: 'Chat Tool Calls',
group: 'Chat',
+ category: 'Communications',
+ isHiddenFromOverview: true,
keywords: ['tool', 'function', 'call', 'invocation', 'llm', 'agent', 'bash', 'edit', 'read', 'search', 'status', 'running', 'error', 'complete', 'diff', 'stats'],
diff --git a/packages/core/src/CheckboxInput/CheckboxInput.doc.mjs b/packages/core/src/CheckboxInput/CheckboxInput.doc.mjs
index 6ddb9bad5a..544d9a07df 100644
--- a/packages/core/src/CheckboxInput/CheckboxInput.doc.mjs
+++ b/packages/core/src/CheckboxInput/CheckboxInput.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'CheckboxInput',
displayName: 'Checkbox Input',
group: 'Checkbox',
+ category: 'Inputs',
keywords: ["checkbox","check","toggle","tick","indeterminate","boolean","tristate"],
props: [
{
diff --git a/packages/core/src/CheckboxList/CheckboxList.doc.mjs b/packages/core/src/CheckboxList/CheckboxList.doc.mjs
index e83d3d02f5..2f4c035af4 100644
--- a/packages/core/src/CheckboxList/CheckboxList.doc.mjs
+++ b/packages/core/src/CheckboxList/CheckboxList.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'CheckboxList',
displayName: 'Checkbox List',
group: 'Checkbox',
+ category: 'Inputs',
keywords: ["checkboxlist","checkbox","checkboxgroup","multichoice","multiselect","checklist"],
components: [
{
diff --git a/packages/core/src/ClickableCard/ClickableCard.doc.mjs b/packages/core/src/ClickableCard/ClickableCard.doc.mjs
index 456d5d4371..99fb976787 100644
--- a/packages/core/src/ClickableCard/ClickableCard.doc.mjs
+++ b/packages/core/src/ClickableCard/ClickableCard.doc.mjs
@@ -5,6 +5,7 @@ export const docs = {
name: 'ClickableCard',
displayName: 'Clickable Card',
group: 'Card',
+ category: 'Actions',
keywords: ['card', 'clickable', 'interactive', 'navigation', 'action', 'link'],
usage: {
description: 'An interactive card for navigation or action targets. Nested interactive elements work independently.',
diff --git a/packages/core/src/CodeBlock/CodeBlock.doc.mjs b/packages/core/src/CodeBlock/CodeBlock.doc.mjs
index c58178c169..35906fc389 100644
--- a/packages/core/src/CodeBlock/CodeBlock.doc.mjs
+++ b/packages/core/src/CodeBlock/CodeBlock.doc.mjs
@@ -4,6 +4,7 @@
export const docs = {
name: 'CodeBlock',
displayName: 'Code Block',
+ category: 'Communications',
keywords: [
'code', 'syntax', 'highlight', 'snippet', 'prism', 'shiki',
'pre', 'monospace', 'codeblock', 'inline',
diff --git a/packages/core/src/Collapsible/Collapsible.doc.mjs b/packages/core/src/Collapsible/Collapsible.doc.mjs
index 3a656d0521..c68d275f94 100644
--- a/packages/core/src/Collapsible/Collapsible.doc.mjs
+++ b/packages/core/src/Collapsible/Collapsible.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Collapsible',
displayName: 'Collapsible',
group: 'Collapsible',
+ category: 'Containers',
keywords: ["accordion","collapse","expandable","disclosure","toggle","panel","foldable","expander","expand"],
playground: {
defaults: {
diff --git a/packages/core/src/CommandPalette/CommandPalette.doc.mjs b/packages/core/src/CommandPalette/CommandPalette.doc.mjs
index 7058e8f3be..997953f97a 100644
--- a/packages/core/src/CommandPalette/CommandPalette.doc.mjs
+++ b/packages/core/src/CommandPalette/CommandPalette.doc.mjs
@@ -5,6 +5,7 @@ export const docs = {
name: 'CommandPalette',
displayName: 'Command Palette',
group: 'CommandPalette',
+ category: 'Actions',
keywords: [
'command',
'spotlight',
diff --git a/packages/core/src/ContextMenu/ContextMenu.doc.mjs b/packages/core/src/ContextMenu/ContextMenu.doc.mjs
index 21bca8afd7..4b250daaea 100644
--- a/packages/core/src/ContextMenu/ContextMenu.doc.mjs
+++ b/packages/core/src/ContextMenu/ContextMenu.doc.mjs
@@ -5,6 +5,7 @@ export const docs = {
name: 'ContextMenu',
displayName: 'Context Menu',
group: 'ContextMenu',
+ category: 'Actions',
keywords: ["contextmenu","right-click","menu","popover","actions","context"],
theming: {
targets: [
diff --git a/packages/core/src/DateInput/DateInput.doc.mjs b/packages/core/src/DateInput/DateInput.doc.mjs
index ecdca3873d..a939016565 100644
--- a/packages/core/src/DateInput/DateInput.doc.mjs
+++ b/packages/core/src/DateInput/DateInput.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'DateInput',
displayName: 'Date Input',
group: 'DateInput',
+ category: 'Inputs',
keywords: ["dateinput","datepicker","datefield","calendar","dateselect","dateentry","datechooser"],
props: [
{
diff --git a/packages/core/src/DateRangeInput/DateRangeInput.doc.mjs b/packages/core/src/DateRangeInput/DateRangeInput.doc.mjs
index fb975790d1..00cf070a6e 100644
--- a/packages/core/src/DateRangeInput/DateRangeInput.doc.mjs
+++ b/packages/core/src/DateRangeInput/DateRangeInput.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'DateRangeInput',
displayName: 'Date Range Input',
group: 'DateInput',
+ category: 'Inputs',
keywords: ["daterangepicker","daterange","range","calendar","filter","analytics","period","schedule"],
props: [
{ name: 'label', type: 'string', description: 'Label text.', required: true },
diff --git a/packages/core/src/DateTimeInput/DateTimeInput.doc.mjs b/packages/core/src/DateTimeInput/DateTimeInput.doc.mjs
index ef6fcf1d95..00e3efec14 100644
--- a/packages/core/src/DateTimeInput/DateTimeInput.doc.mjs
+++ b/packages/core/src/DateTimeInput/DateTimeInput.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'DateTimeInput',
displayName: 'Date Time Input',
group: 'DateInput',
+ category: 'Inputs',
keywords: ["datetimepicker","datetime","datepicker","timepicker","calendar","schedule","event","deadline","timestamp"],
props: [
{
diff --git a/packages/core/src/Dialog/Dialog.doc.mjs b/packages/core/src/Dialog/Dialog.doc.mjs
index a15c62e18c..fe61ac0f45 100644
--- a/packages/core/src/Dialog/Dialog.doc.mjs
+++ b/packages/core/src/Dialog/Dialog.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Dialog',
displayName: 'Dialog',
group: 'Dialog',
+ category: 'Containers',
keywords: ["dialog","modal","popup","overlay","lightbox","alert","confirm","prompt","backdrop","focus trap","imperative"],
playground: {
defaults: {
diff --git a/packages/core/src/Divider/Divider.doc.mjs b/packages/core/src/Divider/Divider.doc.mjs
index d7955cfda5..71432b0acb 100644
--- a/packages/core/src/Divider/Divider.doc.mjs
+++ b/packages/core/src/Divider/Divider.doc.mjs
@@ -7,6 +7,7 @@
export const docs = {
name: 'Divider',
displayName: 'Divider',
+ category: 'Layout',
keywords: ["divider","separator","hr","rule","line","border","spacer","horizontal rule"],
props: [
{
diff --git a/packages/core/src/DropdownMenu/DropdownMenu.doc.mjs b/packages/core/src/DropdownMenu/DropdownMenu.doc.mjs
index 8109f6a9eb..b54494c71d 100644
--- a/packages/core/src/DropdownMenu/DropdownMenu.doc.mjs
+++ b/packages/core/src/DropdownMenu/DropdownMenu.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'DropdownMenu',
displayName: 'Dropdown Menu',
group: 'DropdownMenu',
+ category: 'Actions',
keywords: ["dropdown","menu","popover","select","actions","contextmenu","overflow","kebab","menubutton"],
theming: {
targets: [
diff --git a/packages/core/src/EmptyState/EmptyState.doc.mjs b/packages/core/src/EmptyState/EmptyState.doc.mjs
index dc1e98f296..d830df1bb6 100644
--- a/packages/core/src/EmptyState/EmptyState.doc.mjs
+++ b/packages/core/src/EmptyState/EmptyState.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'EmptyState',
displayName: 'Empty State',
+ category: 'Communications',
keywords: ["emptystate","empty","placeholder","nodata","blank","noresults","illustration","blankslate"],
props: [
{
diff --git a/packages/core/src/Field/Field.doc.mjs b/packages/core/src/Field/Field.doc.mjs
index eb3e3d4a54..19b7fc1bc8 100644
--- a/packages/core/src/Field/Field.doc.mjs
+++ b/packages/core/src/Field/Field.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Field',
displayName: 'Field',
group: 'Field',
+ category: 'Inputs',
keywords: ["field","formfield","formgroup","formcontrol","label","input","required","optional","helpertext","hint"],
playground: {
defaults: {
diff --git a/packages/core/src/FileInput/FileInput.doc.mjs b/packages/core/src/FileInput/FileInput.doc.mjs
index 5b48be6a0d..d5e84811d9 100644
--- a/packages/core/src/FileInput/FileInput.doc.mjs
+++ b/packages/core/src/FileInput/FileInput.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'FileInput',
displayName: 'File Input',
+ category: 'Inputs',
keywords: ["fileinput","file","upload","drag","drop","dropzone","attachment","browse"],
props: [
{
diff --git a/packages/core/src/FormLayout/FormLayout.doc.mjs b/packages/core/src/FormLayout/FormLayout.doc.mjs
index f6bb740ac3..35c6f2e384 100644
--- a/packages/core/src/FormLayout/FormLayout.doc.mjs
+++ b/packages/core/src/FormLayout/FormLayout.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'FormLayout',
displayName: 'Form Layout',
group: 'Layout',
+ category: 'Layout',
keywords: ["formlayout","form","fieldset","formgroup","formcontainer","fields","vertical","horizontal"],
props: [
{
diff --git a/packages/core/src/Grid/Grid.doc.mjs b/packages/core/src/Grid/Grid.doc.mjs
index 238952035e..53c38cc5dd 100644
--- a/packages/core/src/Grid/Grid.doc.mjs
+++ b/packages/core/src/Grid/Grid.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Grid',
displayName: 'Grid',
group: 'Layout',
+ category: 'Layout',
keywords: ["grid","columns","responsive","auto-fill","auto-fit","masonry","tiles","row","col","simplegrid","responsive grid","card grid"],
usage: {
description:
diff --git a/packages/core/src/HoverCard/HoverCard.doc.mjs b/packages/core/src/HoverCard/HoverCard.doc.mjs
index 83da1aa2c8..3400e7b6e0 100644
--- a/packages/core/src/HoverCard/HoverCard.doc.mjs
+++ b/packages/core/src/HoverCard/HoverCard.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'HoverCard',
displayName: 'Hover Card',
group: 'HoverCard',
+ category: 'Communications',
keywords: ["hovercard","hover card","popover","tooltip","preview card","flyout","overlay","hover popup"],
playground: {
defaults: {
diff --git a/packages/core/src/Icon/Icon.doc.mjs b/packages/core/src/Icon/Icon.doc.mjs
index 670878be11..685c392fee 100644
--- a/packages/core/src/Icon/Icon.doc.mjs
+++ b/packages/core/src/Icon/Icon.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Icon',
displayName: 'Icon',
+ category: 'Communications',
keywords: ["icon","svg","glyph","symbol","pictogram","graphic","vector"],
props: [
{
diff --git a/packages/core/src/IconButton/IconButton.doc.mjs b/packages/core/src/IconButton/IconButton.doc.mjs
index 03973034e1..2b73a7a146 100644
--- a/packages/core/src/IconButton/IconButton.doc.mjs
+++ b/packages/core/src/IconButton/IconButton.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'IconButton',
displayName: 'Icon Button',
group: 'Button',
+ category: 'Actions',
keywords: ['icon-button', 'icon', 'button', 'toolbar', 'action', 'compact'],
props: [
diff --git a/packages/core/src/InputGroup/InputGroup.doc.mjs b/packages/core/src/InputGroup/InputGroup.doc.mjs
index 5e17c9499c..01741b39d3 100644
--- a/packages/core/src/InputGroup/InputGroup.doc.mjs
+++ b/packages/core/src/InputGroup/InputGroup.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'InputGroup',
displayName: 'Input Group',
group: 'Field',
+ category: 'Inputs',
keywords: ["inputgroup","addon","prefix","suffix","connected","grouped","input"],
theming: {
targets: [
diff --git a/packages/core/src/Item/Item.doc.mjs b/packages/core/src/Item/Item.doc.mjs
index 25e1364ba9..db4072bc77 100644
--- a/packages/core/src/Item/Item.doc.mjs
+++ b/packages/core/src/Item/Item.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Item',
displayName: 'Item',
group: 'Item',
+ category: 'Lists',
keywords: ["item","list-item","media-object","row","cell","entity","contact","notification","preview"],
playground: {
defaults: {
diff --git a/packages/core/src/Kbd/Kbd.doc.mjs b/packages/core/src/Kbd/Kbd.doc.mjs
index 46d986a8dd..cf0bb51de0 100644
--- a/packages/core/src/Kbd/Kbd.doc.mjs
+++ b/packages/core/src/Kbd/Kbd.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Kbd',
displayName: 'Kbd',
+ category: 'Communications',
keywords: ["kbd","keyboard","shortcut","hotkey","keybinding","keystroke","keycombo","modifier","accelerator"],
props: [
{
diff --git a/packages/core/src/Layout/Layout.doc.mjs b/packages/core/src/Layout/Layout.doc.mjs
index 9f06d903a6..592f79bc58 100644
--- a/packages/core/src/Layout/Layout.doc.mjs
+++ b/packages/core/src/Layout/Layout.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Layout',
displayName: 'Layout',
group: 'Layout',
+ category: 'Layout',
keywords: ["layout","container","content","flex","box","wrapper","scaffold","page","shell"],
playground: {
defaults: {
diff --git a/packages/core/src/Lightbox/Lightbox.doc.mjs b/packages/core/src/Lightbox/Lightbox.doc.mjs
index 7bede2767e..8e6d4a2b05 100644
--- a/packages/core/src/Lightbox/Lightbox.doc.mjs
+++ b/packages/core/src/Lightbox/Lightbox.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Lightbox',
displayName: 'Lightbox',
+ category: 'Containers',
keywords: ["lightbox","image","video","viewer","gallery","zoom","fullscreen","media","photo","preview"],
props: [
{
diff --git a/packages/core/src/Link/Link.doc.mjs b/packages/core/src/Link/Link.doc.mjs
index e4a9733cb9..50b19fc516 100644
--- a/packages/core/src/Link/Link.doc.mjs
+++ b/packages/core/src/Link/Link.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Link',
displayName: 'Link',
+ category: 'Actions',
keywords: ["link","anchor","href","hyperlink","navigation","url","external","textlink"],
playground: {
defaults: {
diff --git a/packages/core/src/Link/LinkProvider.doc.mjs b/packages/core/src/Link/LinkProvider.doc.mjs
index 36a84e5d5c..c2d5928320 100644
--- a/packages/core/src/Link/LinkProvider.doc.mjs
+++ b/packages/core/src/Link/LinkProvider.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'LinkProvider',
displayName: 'Link Provider',
group: 'Utilities',
+ isHiddenFromOverview: true,
keywords: ['link', 'provider', 'router', 'nextjs', 'client-side-routing'],
usage: {
description: 'Wraps your app to replace the default <a> tag with a framework-specific link component (e.g. Next.js Link) for client-side routing across all XDS components.',
diff --git a/packages/core/src/List/List.doc.mjs b/packages/core/src/List/List.doc.mjs
index a310f7dd83..1976c76d0a 100644
--- a/packages/core/src/List/List.doc.mjs
+++ b/packages/core/src/List/List.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'List',
displayName: 'List',
group: 'List',
+ category: 'Lists',
keywords: ["list","listitem","listbox","menu","collection","items","ul","navlist"],
theming: {
targets: [
diff --git a/packages/core/src/Markdown/Markdown.doc.mjs b/packages/core/src/Markdown/Markdown.doc.mjs
index 7d0fac0063..744db8bb1f 100644
--- a/packages/core/src/Markdown/Markdown.doc.mjs
+++ b/packages/core/src/Markdown/Markdown.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Markdown',
displayName: 'Markdown',
+ category: 'Communications',
keywords: [
'markdown',
'rich text',
diff --git a/packages/core/src/MetadataList/MetadataList.doc.mjs b/packages/core/src/MetadataList/MetadataList.doc.mjs
index 8afcec451a..23826bced9 100644
--- a/packages/core/src/MetadataList/MetadataList.doc.mjs
+++ b/packages/core/src/MetadataList/MetadataList.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'MetadataList',
displayName: 'Metadata List',
group: 'MetadataList',
+ category: 'Lists',
keywords: ["metadata","description","definition","keyvalue","properties","details","attributes","summary"],
theming: {
targets: [
diff --git a/packages/core/src/MobileNav/MobileNav.doc.mjs b/packages/core/src/MobileNav/MobileNav.doc.mjs
index 047482169c..e924a2d36b 100644
--- a/packages/core/src/MobileNav/MobileNav.doc.mjs
+++ b/packages/core/src/MobileNav/MobileNav.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'MobileNav',
displayName: 'Mobile Nav',
group: 'MobileNav',
+ category: 'Navigation',
keywords: ["mobilenav","drawer","sidebar","navigation","hamburger","menu","offcanvas","slideout","navdrawer"],
props: [
{
diff --git a/packages/core/src/MoreMenu/MoreMenu.doc.mjs b/packages/core/src/MoreMenu/MoreMenu.doc.mjs
index f0e62dc2ee..92754869b0 100644
--- a/packages/core/src/MoreMenu/MoreMenu.doc.mjs
+++ b/packages/core/src/MoreMenu/MoreMenu.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'MoreMenu',
displayName: 'More Menu',
+ category: 'Actions',
keywords: ["moremenu","overflow","kebab","dotmenu","threedot","ellipsis","dropdown","contextmenu","actionmenu"],
props: [
{
diff --git a/packages/core/src/MultiSelector/MultiSelector.doc.mjs b/packages/core/src/MultiSelector/MultiSelector.doc.mjs
index 385661f5cb..a043937452 100644
--- a/packages/core/src/MultiSelector/MultiSelector.doc.mjs
+++ b/packages/core/src/MultiSelector/MultiSelector.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'MultiSelector',
displayName: 'Multi Selector',
group: 'Selector',
+ category: 'Inputs',
keywords: ['multiselect', 'checkbox', 'dropdown', 'multi', 'picker', 'checklist', 'facet', 'filter', 'select'],
theming: {
targets: [
diff --git a/packages/core/src/NavIcon/NavIcon.doc.mjs b/packages/core/src/NavIcon/NavIcon.doc.mjs
index db34c67f7b..5b78c9f59e 100644
--- a/packages/core/src/NavIcon/NavIcon.doc.mjs
+++ b/packages/core/src/NavIcon/NavIcon.doc.mjs
@@ -5,6 +5,8 @@
export const docs = {
name: 'NavIcon',
displayName: 'Nav Icon',
+ category: 'Navigation',
+ isHiddenFromOverview: true,
hidden: false,
keywords: ["navicon","iconbutton","toolbar icon","appbar icon","nav button"],
props: [
diff --git a/packages/core/src/NavMenu/NavMenu.doc.mjs b/packages/core/src/NavMenu/NavMenu.doc.mjs
index 7092512b5f..d2ba90310c 100644
--- a/packages/core/src/NavMenu/NavMenu.doc.mjs
+++ b/packages/core/src/NavMenu/NavMenu.doc.mjs
@@ -5,6 +5,8 @@
export const docs = {
name: 'NavHeadingMenu',
displayName: 'Nav Heading Menu',
+ category: 'Navigation',
+ isHiddenFromOverview: true,
hidden: false,
keywords: ['nav', 'menu', 'navigation', 'heading', 'menu-item', 'popover'],
usage: {
diff --git a/packages/core/src/NumberInput/NumberInput.doc.mjs b/packages/core/src/NumberInput/NumberInput.doc.mjs
index cd4b63f312..4bdda2f286 100644
--- a/packages/core/src/NumberInput/NumberInput.doc.mjs
+++ b/packages/core/src/NumberInput/NumberInput.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'NumberInput',
displayName: 'Number Input',
+ category: 'Inputs',
keywords: ["numberinput","numberfield","stepper","spinner","counter","increment","decrement","quantity","numberpicker"],
props: [
{
diff --git a/packages/core/src/Outline/Outline.doc.mjs b/packages/core/src/Outline/Outline.doc.mjs
index adfcc2d42c..e4dbd92fd8 100644
--- a/packages/core/src/Outline/Outline.doc.mjs
+++ b/packages/core/src/Outline/Outline.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Outline',
displayName: 'Outline',
group: 'Outline',
+ category: 'Navigation',
keywords: [
'outline',
'table of contents',
diff --git a/packages/core/src/OverflowList/OverflowList.doc.mjs b/packages/core/src/OverflowList/OverflowList.doc.mjs
index 89f329bafb..f9e62b9a05 100644
--- a/packages/core/src/OverflowList/OverflowList.doc.mjs
+++ b/packages/core/src/OverflowList/OverflowList.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'OverflowList',
displayName: 'Overflow List',
+ category: 'Lists',
keywords: [
'overflow',
'truncate',
diff --git a/packages/core/src/Pagination/Pagination.doc.mjs b/packages/core/src/Pagination/Pagination.doc.mjs
index 61706c359f..56a2698326 100644
--- a/packages/core/src/Pagination/Pagination.doc.mjs
+++ b/packages/core/src/Pagination/Pagination.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Pagination',
displayName: 'Pagination',
+ category: 'Navigation',
keywords: ["pagination","pager","paginator","pagenavigation","paging","paginate","pages","pagecontrol"],
props: [
{
diff --git a/packages/core/src/Popover/Popover.doc.mjs b/packages/core/src/Popover/Popover.doc.mjs
index 291dca9efb..cb6ca882fc 100644
--- a/packages/core/src/Popover/Popover.doc.mjs
+++ b/packages/core/src/Popover/Popover.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Popover',
displayName: 'Popover',
group: 'Popover',
+ category: 'Communications',
keywords: ["popover","popup","dropdown","tooltip","overlay","flyout","callout","popper","anchor","floating","bubble"],
components: [
{
diff --git a/packages/core/src/PowerSearch/PowerSearch.doc.mjs b/packages/core/src/PowerSearch/PowerSearch.doc.mjs
index a893058d47..4770bbbf20 100644
--- a/packages/core/src/PowerSearch/PowerSearch.doc.mjs
+++ b/packages/core/src/PowerSearch/PowerSearch.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'PowerSearch',
displayName: 'Power Search',
+ category: 'Inputs',
keywords: ["powersearch","search","searchbar","filter","filterbar","faceted","querybuilder","structured","omnibar"],
props: [
{
diff --git a/packages/core/src/ProgressBar/ProgressBar.doc.mjs b/packages/core/src/ProgressBar/ProgressBar.doc.mjs
index c51864f578..300b590050 100644
--- a/packages/core/src/ProgressBar/ProgressBar.doc.mjs
+++ b/packages/core/src/ProgressBar/ProgressBar.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'ProgressBar',
displayName: 'Progress Bar',
+ category: 'Performance',
keywords: ["progressbar","progress","loader","loading","linear","determinate","indeterminate","meter"],
props: [
{
diff --git a/packages/core/src/RadioList/RadioList.doc.mjs b/packages/core/src/RadioList/RadioList.doc.mjs
index 910eaa33d2..8534ee466d 100644
--- a/packages/core/src/RadioList/RadioList.doc.mjs
+++ b/packages/core/src/RadioList/RadioList.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'RadioList',
displayName: 'Radio List',
group: 'Radio',
+ category: 'Inputs',
keywords: ["radiolist","radio","radiogroup","radiobutton","optionlist","singlechoice","choicelist"],
theming: {
targets: [
diff --git a/packages/core/src/Resizable/Resizable.doc.mjs b/packages/core/src/Resizable/Resizable.doc.mjs
index 48d2e57ba5..a2b48eb321 100644
--- a/packages/core/src/Resizable/Resizable.doc.mjs
+++ b/packages/core/src/Resizable/Resizable.doc.mjs
@@ -5,6 +5,7 @@ export const docs = {
name: 'Resizable',
displayName: 'Resizable',
group: 'Resizable',
+ category: 'Layout',
keywords: [
'resize',
'resizable',
diff --git a/packages/core/src/Section/Section.doc.mjs b/packages/core/src/Section/Section.doc.mjs
index b9c28ee1c6..88e1485d97 100644
--- a/packages/core/src/Section/Section.doc.mjs
+++ b/packages/core/src/Section/Section.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Section',
displayName: 'Section',
group: 'Layout',
+ category: 'Containers',
keywords: ["section","panel","container","group","fieldset","region","block"],
props: [
{
diff --git a/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs b/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs
index 89f8f06f60..da53e658de 100644
--- a/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs
+++ b/packages/core/src/SegmentedControl/SegmentedControl.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'SegmentedControl',
displayName: 'Segmented Control',
group: 'SegmentedControl',
+ category: 'Inputs',
keywords: ['radio', 'tabs', 'toggle', 'toggle-group', 'pill', 'button-group', 'switch', 'segment', 'control'],
playground: {
defaults: {
diff --git a/packages/core/src/SelectableCard/SelectableCard.doc.mjs b/packages/core/src/SelectableCard/SelectableCard.doc.mjs
index 00ab7065c4..b0b25c826c 100644
--- a/packages/core/src/SelectableCard/SelectableCard.doc.mjs
+++ b/packages/core/src/SelectableCard/SelectableCard.doc.mjs
@@ -5,6 +5,7 @@ export const docs = {
name: 'SelectableCard',
displayName: 'Selectable Card',
group: 'Card',
+ category: 'Actions',
keywords: ['card', 'selectable', 'toggle', 'checkbox', 'radio', 'selection'],
usage: {
description: 'A card that toggles between selected and unselected states with an accent border. For navigation use ClickableCard.',
diff --git a/packages/core/src/Selector/Selector.doc.mjs b/packages/core/src/Selector/Selector.doc.mjs
index a41f9915a4..bc1f3a05a1 100644
--- a/packages/core/src/Selector/Selector.doc.mjs
+++ b/packages/core/src/Selector/Selector.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Selector',
displayName: 'Selector',
group: 'Selector',
+ category: 'Inputs',
keywords: ["selector","select","dropdown","combobox","picker","listbox","chooser","autocomplete","option","selectmenu"],
theming: {
targets: [
diff --git a/packages/core/src/SideNav/SideNav.doc.mjs b/packages/core/src/SideNav/SideNav.doc.mjs
index 2caba7d932..c345dd257c 100644
--- a/packages/core/src/SideNav/SideNav.doc.mjs
+++ b/packages/core/src/SideNav/SideNav.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'SideNav',
displayName: 'Side Nav',
group: 'SideNav',
+ category: 'Navigation',
keywords: ["sidenav","sidebar","navigation","drawer","menu","nav","aside","sidemenu","navmenu","sider","treeview"],
playground: {
defaults: {
diff --git a/packages/core/src/Skeleton/Skeleton.doc.mjs b/packages/core/src/Skeleton/Skeleton.doc.mjs
index 2ebbf70a3e..31b6f68eef 100644
--- a/packages/core/src/Skeleton/Skeleton.doc.mjs
+++ b/packages/core/src/Skeleton/Skeleton.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Skeleton',
displayName: 'Skeleton',
+ category: 'Performance',
keywords: ["skeleton","placeholder","loading","shimmer","pulse","loader","bone","ghost","preloader"],
props: [
{
diff --git a/packages/core/src/Slider/Slider.doc.mjs b/packages/core/src/Slider/Slider.doc.mjs
index eaac53fe82..13860f07fc 100644
--- a/packages/core/src/Slider/Slider.doc.mjs
+++ b/packages/core/src/Slider/Slider.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Slider',
displayName: 'Slider',
+ category: 'Inputs',
keywords: ["slider","range","slidebar","trackbar","scrubber","knob","thumb","rangeslider"],
playground: {
defaults: {
diff --git a/packages/core/src/Spinner/Spinner.doc.mjs b/packages/core/src/Spinner/Spinner.doc.mjs
index 8cdec7354f..6956ca187c 100644
--- a/packages/core/src/Spinner/Spinner.doc.mjs
+++ b/packages/core/src/Spinner/Spinner.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Spinner',
displayName: 'Spinner',
+ category: 'Performance',
keywords: ["spinner","loader","loading","circular","progress","spin","activity","busy","indeterminate"],
props: [
{
diff --git a/packages/core/src/Stack/Stack.doc.mjs b/packages/core/src/Stack/Stack.doc.mjs
index ff33e9ae65..39c6b19421 100644
--- a/packages/core/src/Stack/Stack.doc.mjs
+++ b/packages/core/src/Stack/Stack.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Stack',
displayName: 'Stack',
group: 'Layout',
+ category: 'Layout',
keywords: ["stack","hstack","vstack","flexbox","flex","spacing","gap","horizontal","vertical","row","column"],
theming: {
targets: [
diff --git a/packages/core/src/StatusDot/StatusDot.doc.mjs b/packages/core/src/StatusDot/StatusDot.doc.mjs
index 52c9d249e2..a28114f85d 100644
--- a/packages/core/src/StatusDot/StatusDot.doc.mjs
+++ b/packages/core/src/StatusDot/StatusDot.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'StatusDot',
displayName: 'Status Dot',
+ category: 'Communications',
keywords: ["statusdot","dot","indicator","status","signal","presence","availability","online","pip"],
props: [
{
diff --git a/packages/core/src/Switch/Switch.doc.mjs b/packages/core/src/Switch/Switch.doc.mjs
index 44d04f8f6c..000babaad5 100644
--- a/packages/core/src/Switch/Switch.doc.mjs
+++ b/packages/core/src/Switch/Switch.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Switch',
displayName: 'Switch',
+ category: 'Inputs',
keywords: ["switch","toggle","onoff","flipswitch","boolean","toggleswitch"],
props: [
{
diff --git a/packages/core/src/TabList/TabList.doc.mjs b/packages/core/src/TabList/TabList.doc.mjs
index 22f1b2b31d..b752fd984a 100644
--- a/packages/core/src/TabList/TabList.doc.mjs
+++ b/packages/core/src/TabList/TabList.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'TabList',
displayName: 'Tab List',
group: 'Tabs',
+ category: 'Navigation',
keywords: ["tabs","tabbar","tabstrip","navigation","tabpanel","tabgroup","segmented","navtabs","tab"],
playground: {
defaults: {
diff --git a/packages/core/src/Table/Table.doc.mjs b/packages/core/src/Table/Table.doc.mjs
index 0ee558b25f..63349654e9 100644
--- a/packages/core/src/Table/Table.doc.mjs
+++ b/packages/core/src/Table/Table.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Table',
displayName: 'Table',
group: 'Table',
+ category: 'Lists',
keywords: ["table","datatable","datagrid","spreadsheet","sorting","virtualized","columns","rows","selection","pinning"],
playground: {
defaults: {
diff --git a/packages/core/src/Text/Text.doc.mjs b/packages/core/src/Text/Text.doc.mjs
index d777e0924c..264b361ab7 100644
--- a/packages/core/src/Text/Text.doc.mjs
+++ b/packages/core/src/Text/Text.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Text',
displayName: 'Text',
+ category: 'Communications',
keywords: ["text","typography","label","paragraph","heading","caption","font","body","subtitle"],
playground: {
defaults: {
diff --git a/packages/core/src/TextArea/TextArea.doc.mjs b/packages/core/src/TextArea/TextArea.doc.mjs
index defeb0608b..fd856d65b7 100644
--- a/packages/core/src/TextArea/TextArea.doc.mjs
+++ b/packages/core/src/TextArea/TextArea.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'TextArea',
displayName: 'Text Area',
+ category: 'Inputs',
keywords: ["textarea","textfield","multiline","comment","message","autoresize","autosize","charlimit"],
props: [
{
diff --git a/packages/core/src/TextInput/TextInput.doc.mjs b/packages/core/src/TextInput/TextInput.doc.mjs
index bc1b21efcb..ae318bc637 100644
--- a/packages/core/src/TextInput/TextInput.doc.mjs
+++ b/packages/core/src/TextInput/TextInput.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'TextInput',
displayName: 'Text Input',
+ category: 'Inputs',
keywords: ["textinput","textfield","input","search","clearable","prefix","suffix","adornment","validation"],
props: [
{
diff --git a/packages/core/src/Thumbnail/Thumbnail.doc.mjs b/packages/core/src/Thumbnail/Thumbnail.doc.mjs
index d62518a895..e79a04bc3c 100644
--- a/packages/core/src/Thumbnail/Thumbnail.doc.mjs
+++ b/packages/core/src/Thumbnail/Thumbnail.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Thumbnail',
displayName: 'Thumbnail',
+ category: 'Communications',
keywords: ["thumbnail","attachment","preview","image","upload","dismiss","remove","loading"],
props: [
{
diff --git a/packages/core/src/TimeInput/TimeInput.doc.mjs b/packages/core/src/TimeInput/TimeInput.doc.mjs
index 18d9c6026e..83647de810 100644
--- a/packages/core/src/TimeInput/TimeInput.doc.mjs
+++ b/packages/core/src/TimeInput/TimeInput.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'TimeInput',
displayName: 'Time Input',
+ category: 'Inputs',
keywords: ["timeinput","timepicker","time","clock","hour","minute","ampm","timeselect","timefield","schedule"],
usage: {
diff --git a/packages/core/src/Timestamp/Timestamp.doc.mjs b/packages/core/src/Timestamp/Timestamp.doc.mjs
index e8e638f5d1..79bb421ed2 100644
--- a/packages/core/src/Timestamp/Timestamp.doc.mjs
+++ b/packages/core/src/Timestamp/Timestamp.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Timestamp',
displayName: 'Timestamp',
+ category: 'Communications',
keywords: ['date', 'time', 'datetime', 'relative', 'ago', 'clock', 'format', 'duration'],
props: [
{
diff --git a/packages/core/src/Toast/Toast.doc.mjs b/packages/core/src/Toast/Toast.doc.mjs
index 647dc909d7..5d2968661f 100644
--- a/packages/core/src/Toast/Toast.doc.mjs
+++ b/packages/core/src/Toast/Toast.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Toast',
displayName: 'Toast',
group: 'Toast',
+ category: 'Communications',
hiddenComponents: ['ToastViewport'],
keywords: ["toast","notification","snackbar","alert","message","feedback","status"],
diff --git a/packages/core/src/ToggleButton/ToggleButton.doc.mjs b/packages/core/src/ToggleButton/ToggleButton.doc.mjs
index f58d7cccf8..cf84032bc9 100644
--- a/packages/core/src/ToggleButton/ToggleButton.doc.mjs
+++ b/packages/core/src/ToggleButton/ToggleButton.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'ToggleButton',
displayName: 'Toggle Button',
group: 'Button',
+ category: 'Actions',
keywords: ["toggle","togglebutton","pressed","toolbar","formatting","segmented","button-group","exclusive","multi-select"],
playground: {
defaults: {
diff --git a/packages/core/src/Token/Token.doc.mjs b/packages/core/src/Token/Token.doc.mjs
index 44fef25336..a194fe7baf 100644
--- a/packages/core/src/Token/Token.doc.mjs
+++ b/packages/core/src/Token/Token.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Token',
displayName: 'Token',
+ category: 'Communications',
keywords: ["token","chip","tag","pill","label","removable","dismissible","filter chip","closable"],
props: [
{
diff --git a/packages/core/src/Tokenizer/Tokenizer.doc.mjs b/packages/core/src/Tokenizer/Tokenizer.doc.mjs
index 5ca80de1bd..7d5f6faa9f 100644
--- a/packages/core/src/Tokenizer/Tokenizer.doc.mjs
+++ b/packages/core/src/Tokenizer/Tokenizer.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Tokenizer',
displayName: 'Tokenizer',
+ category: 'Communications',
keywords: ["tokenizer","multiselect","multi-select","chips","tags","combobox","autocomplete","taginput","chipinput"],
props: [
{
diff --git a/packages/core/src/Toolbar/Toolbar.doc.mjs b/packages/core/src/Toolbar/Toolbar.doc.mjs
index dc7ae81f3f..9e4d91680f 100644
--- a/packages/core/src/Toolbar/Toolbar.doc.mjs
+++ b/packages/core/src/Toolbar/Toolbar.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Toolbar',
displayName: 'Toolbar',
+ category: 'Navigation',
keywords: ['toolbar', 'nav', 'bar', 'actions', 'buttonbar', 'header', 'footer', 'action-bar', 'control-bar'],
theming: {
targets: [
diff --git a/packages/core/src/Tooltip/Tooltip.doc.mjs b/packages/core/src/Tooltip/Tooltip.doc.mjs
index 243fa4338b..ed6d5007d9 100644
--- a/packages/core/src/Tooltip/Tooltip.doc.mjs
+++ b/packages/core/src/Tooltip/Tooltip.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Tooltip',
displayName: 'Tooltip',
group: 'Tooltip',
+ category: 'Communications',
playground: {
defaults: {
content: 'Helpful tooltip text',
diff --git a/packages/core/src/TopNav/TopNav.doc.mjs b/packages/core/src/TopNav/TopNav.doc.mjs
index 73c16f8122..c54ac76256 100644
--- a/packages/core/src/TopNav/TopNav.doc.mjs
+++ b/packages/core/src/TopNav/TopNav.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'TopNav',
displayName: 'Top Nav',
group: 'TopNav',
+ category: 'Navigation',
keywords: ["topnav","navbar","appbar","header","toolbar","navigation","menubar","topbar"],
playground: {
defaults: {
diff --git a/packages/core/src/TreeList/TreeList.doc.mjs b/packages/core/src/TreeList/TreeList.doc.mjs
index 03648046cd..537f79fae0 100644
--- a/packages/core/src/TreeList/TreeList.doc.mjs
+++ b/packages/core/src/TreeList/TreeList.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'TreeList',
displayName: 'Tree List',
group: 'TreeList',
+ category: 'Lists',
keywords: ['tree', 'hierarchy', 'nested', 'accordion', 'folder', 'expand', 'collapse', 'treeview', 'outline'],
playground: {
defaults: {
diff --git a/packages/core/src/Typeahead/Typeahead.doc.mjs b/packages/core/src/Typeahead/Typeahead.doc.mjs
index e9d191fdfe..fd014c3867 100644
--- a/packages/core/src/Typeahead/Typeahead.doc.mjs
+++ b/packages/core/src/Typeahead/Typeahead.doc.mjs
@@ -6,6 +6,7 @@ export const docs = {
name: 'Typeahead',
displayName: 'Typeahead',
group: 'Typeahead',
+ category: 'Inputs',
keywords: ["typeahead","autocomplete","combobox","searchbox","autosuggest","select","dropdown","lookup","searchable","suggestion","picker"],
components: [
{
diff --git a/packages/core/src/docs-types.ts b/packages/core/src/docs-types.ts
index c224754b73..267a47ae8d 100644
--- a/packages/core/src/docs-types.ts
+++ b/packages/core/src/docs-types.ts
@@ -413,6 +413,33 @@ interface BaseDoc {
* Groups cluster related components that are always used together
* or are variants of each other. */
group?: string;
+ /** Component category for the overview page gallery. Independent of
+ * `group` (which is for the sidebar). Categories represent the
+ * component's functional role in a UI.
+ *
+ * Valid values:
+ * - `'Actions'` — interactive components like buttons and links
+ * - `'Communications'` — informational display: tooltips, toasts, badges
+ * - `'Containers'` — wrappers: cards, dialogs, collapsibles
+ * - `'Layout'` — structural: grid, stack, center, dividers
+ * - `'Inputs'` — data entry: text fields, selectors, date pickers
+ * - `'Lists'` — data display in list/table form
+ * - `'Navigation'` — wayfinding: tabs, breadcrumbs, sidebars
+ * - `'Performance'` — progress indication: spinners, skeletons, bars */
+ category?:
+ | 'Actions'
+ | 'Communications'
+ | 'Containers'
+ | 'Layout'
+ | 'Inputs'
+ | 'Lists'
+ | 'Navigation'
+ | 'Performance';
+ /** When true, this component is excluded from the categorized overview
+ * page but remains in the sidebar and CLI. Use for sub-components that
+ * only make sense within a parent (e.g. BreadcrumbItem, DialogHeader)
+ * or internal primitives that shouldn't appear in the gallery. */
+ isHiddenFromOverview?: boolean;
/** Theming configuration. Documents the stable CSS class names
* rendered by this component that themes can target via `@scope`
* selectors in `defineTheme`. */
diff --git a/packages/lab/src/CircularProgress/CircularProgress.doc.mjs b/packages/lab/src/CircularProgress/CircularProgress.doc.mjs
index b31975aa15..d62191203e 100644
--- a/packages/lab/src/CircularProgress/CircularProgress.doc.mjs
+++ b/packages/lab/src/CircularProgress/CircularProgress.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'CircularProgress',
displayName: 'Circular Progress',
+ category: 'Performance',
keywords: ["circular","progress","radial","ring","arc","determinate","indeterminate","gauge","meter","donut"],
props: [
{
diff --git a/packages/lab/src/Stepper/Stepper.doc.mjs b/packages/lab/src/Stepper/Stepper.doc.mjs
index b55905dea3..d4f2d336e5 100644
--- a/packages/lab/src/Stepper/Stepper.doc.mjs
+++ b/packages/lab/src/Stepper/Stepper.doc.mjs
@@ -5,6 +5,7 @@
export const docs = {
name: 'Stepper',
displayName: 'Stepper',
+ category: 'Navigation',
group: 'Stepper',
keywords: ['stepper', 'steps', 'wizard', 'workflow', 'progress', 'multi-step', 'form wizard', 'onboarding'],
usage: {