Skip to content

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

TypeScript

docs(core): playground defaults and slotElements for 10 high-priority components (#5102)

Jiun Shinea86c8bc1ad0
diff --git a/packages/core/src/Chat/ChatMessage.doc.mjs b/packages/core/src/Chat/ChatMessage.doc.mjs
index eb884bce1e..7c3da8833d 100644
--- a/packages/core/src/Chat/ChatMessage.doc.mjs
+++ b/packages/core/src/Chat/ChatMessage.doc.mjs
@@ -7,6 +7,17 @@ export const docs = {
subComponentOf: 'Chat',
displayName: 'Chat Message',
description: 'Sender context wrapper: handles avatar, name, metadata, and alignment based on sender role.',
+ playground: {
+ defaults: {
+ sender: 'assistant',
+ children: {
+ __element: 'ChatMessageBubble',
+ children: 'Here is the summary you asked for.',
+ },
+ avatar: {__element: 'Avatar', props: {name: 'Astra', size: 'sm'}},
+ },
+ wrapper: {component: 'Stack', props: {width: 480}},
+ },
props: [
{
name: 'sender',
@@ -19,6 +30,12 @@ export const docs = {
type: 'ReactNode',
description: 'Free-form content: bubbles, asset lists, tool calls, images. Custom (non-bubble) children render flush with the message edge; wrap them in a ghost ChatMessageBubble to align them with the bubble text column.',
required: true,
+ slotElements: [
+ {
+ __element: 'ChatMessageBubble',
+ children: 'Message text',
+ },
+ ],
},
{
name: 'avatar',
diff --git a/packages/core/src/Chat/ChatMessageList.doc.mjs b/packages/core/src/Chat/ChatMessageList.doc.mjs
index 13f516dc9a..ccafa852a4 100644
--- a/packages/core/src/Chat/ChatMessageList.doc.mjs
+++ b/packages/core/src/Chat/ChatMessageList.doc.mjs
@@ -8,12 +8,45 @@ export const docs = {
displayName: 'Chat Message List',
isHiddenFromOverview: true,
description: `Presentational message container with density context and infinite scroll support. Provides role="log" with aria-live="polite" for accessibility. A flex spacer pushes messages to the bottom when the list isn't full; set align="top" to start messages at the top instead.`,
+ playground: {
+ defaults: {
+ children: [
+ {
+ __element: 'ChatMessage',
+ props: {sender: 'user'},
+ children: {
+ __element: 'ChatMessageBubble',
+ children: 'Can you summarize this report?',
+ },
+ },
+ {
+ __element: 'ChatMessage',
+ props: {sender: 'assistant'},
+ children: {
+ __element: 'ChatMessageBubble',
+ children: 'Sure. Revenue is up 12% and churn is flat quarter over quarter.',
+ },
+ },
+ ],
+ },
+ wrapper: {component: 'Stack', props: {width: 480}},
+ },
props: [
{
name: 'children',
type: 'ReactNode',
description: 'Message elements: typically ChatMessage or ChatSystemMessage.',
required: true,
+ slotElements: [
+ {
+ __element: 'ChatMessage',
+ props: {sender: 'user'},
+ children: {
+ __element: 'ChatMessageBubble',
+ children: 'Message text',
+ },
+ },
+ ],
},
{
name: 'emptyState',
diff --git a/packages/core/src/SideNav/SideNavHeading.doc.mjs b/packages/core/src/SideNav/SideNavHeading.doc.mjs
index 5aaf4fe24c..e05d3bc1d1 100644
--- a/packages/core/src/SideNav/SideNavHeading.doc.mjs
+++ b/packages/core/src/SideNav/SideNavHeading.doc.mjs
@@ -8,6 +8,9 @@ export const docs = {
displayName: 'Side Nav Heading',
isHiddenFromOverview: true,
description: 'Product/suite/account heading with smart interaction boundary logic for links and a menu popover.',
+ playground: {
+ defaults: {heading: 'Acme Console', subheading: 'Production'},
+ },
props: [
{
name: 'heading',
diff --git a/packages/core/src/SideNav/SideNavItem.doc.mjs b/packages/core/src/SideNav/SideNavItem.doc.mjs
index bfcc0c6521..eb1fd9650b 100644
--- a/packages/core/src/SideNav/SideNavItem.doc.mjs
+++ b/packages/core/src/SideNav/SideNavItem.doc.mjs
@@ -8,6 +8,9 @@ export const docs = {
displayName: 'Side Nav Item',
isHiddenFromOverview: true,
description: 'Navigation item with icon, selected state, optional end content, and nesting support via children.',
+ playground: {
+ defaults: {label: 'Dashboard', icon: 'viewColumns', isSelected: true},
+ },
props: [
{
name: 'label',
diff --git a/packages/core/src/SideNav/SideNavSection.doc.mjs b/packages/core/src/SideNav/SideNavSection.doc.mjs
index e87b6abe84..072efd4032 100644
--- a/packages/core/src/SideNav/SideNavSection.doc.mjs
+++ b/packages/core/src/SideNav/SideNavSection.doc.mjs
@@ -8,6 +8,16 @@ export const docs = {
displayName: 'Side Nav Section',
isHiddenFromOverview: true,
description: 'Section grouping with an optional title, subtitle, and end content.',
+ playground: {
+ defaults: {
+ title: 'Workspace',
+ children: [
+ {__element: 'SideNavItem', props: {label: 'Dashboard', isSelected: true}},
+ {__element: 'SideNavItem', props: {label: 'Projects'}},
+ {__element: 'SideNavItem', props: {label: 'Settings'}},
+ ],
+ },
+ },
props: [
{
name: 'title',
diff --git a/packages/core/src/TabList/TabMenu.doc.mjs b/packages/core/src/TabList/TabMenu.doc.mjs
index dadeb82b77..ff1d983ef7 100644
--- a/packages/core/src/TabList/TabMenu.doc.mjs
+++ b/packages/core/src/TabList/TabMenu.doc.mjs
@@ -8,6 +8,20 @@ export const docs = {
displayName: 'Tab Menu',
isHiddenFromOverview: true,
description: "Overflow menu trigger that opens a dropdown of additional tab options, showing the selected option's label as the trigger text.",
+ // TabMenu requires TabList context; wrap it so the preview doesn't throw.
+ // The wrapper value matches none of the options, so the trigger shows its
+ // own label (the idle overflow state).
+ playground: {
+ defaults: {
+ label: 'More',
+ options: [
+ {value: 'settings', label: 'Settings'},
+ {value: 'integrations', label: 'Integrations'},
+ {value: 'billing', label: 'Billing'},
+ ],
+ },
+ wrapper: {component: 'TabList', props: {value: 'overview'}},
+ },
props: [
{
name: 'label',
diff --git a/packages/core/src/Toast/Toast.doc.mjs b/packages/core/src/Toast/Toast.doc.mjs
index 89b87c58e0..1bdb79e405 100644
--- a/packages/core/src/Toast/Toast.doc.mjs
+++ b/packages/core/src/Toast/Toast.doc.mjs
@@ -18,6 +18,10 @@ export const docs = {
'status',
],
+ playground: {
+ defaults: {body: 'Changes saved'},
+ },
+
props: [
{
name: 'body',
diff --git a/packages/core/src/TopNav/TopNavHeading.doc.mjs b/packages/core/src/TopNav/TopNavHeading.doc.mjs
index f349878a03..2f8a5f0d29 100644
--- a/packages/core/src/TopNav/TopNavHeading.doc.mjs
+++ b/packages/core/src/TopNav/TopNavHeading.doc.mjs
@@ -8,6 +8,9 @@ export const docs = {
displayName: 'Top Nav Heading',
isHiddenFromOverview: true,
description: 'Product/suite/account heading for the TopNav heading slot. Supports smart interaction boundary logic: logo, heading text, superheading/subheading with independent links, and an optional menu popover with automatic chevron indicator.',
+ playground: {
+ defaults: {superheading: 'Acme Suite', heading: 'Acme Console'},
+ },
props: [
{
name: 'logo',
diff --git a/packages/core/src/TopNav/TopNavItem.doc.mjs b/packages/core/src/TopNav/TopNavItem.doc.mjs
index 7ae860ccba..c0de6e015a 100644
--- a/packages/core/src/TopNav/TopNavItem.doc.mjs
+++ b/packages/core/src/TopNav/TopNavItem.doc.mjs
@@ -8,6 +8,9 @@ export const docs = {
displayName: 'Top Nav Item',
isHiddenFromOverview: true,
description: 'Navigation link item for use in TopNav startContent: renders as an anchor with hover and selected states.',
+ playground: {
+ defaults: {label: 'Projects', href: '#', isSelected: true},
+ },
props: [
{
name: 'label',
diff --git a/packages/core/src/TopNav/TopNavMenu.doc.mjs b/packages/core/src/TopNav/TopNavMenu.doc.mjs
index 76c859ea6b..5ecce00219 100644
--- a/packages/core/src/TopNav/TopNavMenu.doc.mjs
+++ b/packages/core/src/TopNav/TopNavMenu.doc.mjs
@@ -7,6 +7,16 @@ export const docs = {
subComponentOf: 'TopNav',
displayName: 'Top Nav Menu',
description: 'Navigation item that displays a hover-triggered popover menu with rich items containing an icon, title, and optional description.',
+ playground: {
+ defaults: {
+ label: 'Products',
+ items: [
+ {title: 'Analytics', description: 'Usage metrics and trends', href: '#'},
+ {title: 'Automation', description: 'Workflows and rules', href: '#'},
+ {title: 'Billing', href: '#'},
+ ],
+ },
+ },
props: [
{
name: 'label',