An open source design system that's fully customizable and agent ready
TypeScript
feat(cli): messaging-shell page template — messaging archetype column frame (#3323)
David Petersen55edc6992a77
diff --git a/.changeset/messaging-shell-template.md b/.changeset/messaging-shell-template.mdnew file mode 100644index 0000000000..45d9a31fed--- /dev/null+++ b/.changeset/messaging-shell-template.md@@ -0,0 +1,8 @@+---+'@astryxdesign/cli': patch+'@astryxdesign/core': patch+---++[feat] New `messaging-shell` page template: Slack-style column frame (rail | sidebar | stream | thread panel) built on the Chat component family — dense rows, zero cards. Adds the `Shell - Messaging` template category.++@thedjpetersendiff --git a/packages/cli/templates/pages/messaging-shell/page.tsx b/packages/cli/templates/pages/messaging-shell/page.tsxnew file mode 100644index 0000000000..758b739233--- /dev/null+++ b/packages/cli/templates/pages/messaging-shell/page.tsx@@ -0,0 +1,676 @@+// Copyright (c) Meta Platforms, Inc. and affiliates.++'use client';++/**+ * Messaging Shell — Slack-style column frame for team messaging tools.+ *+ * Frame (desktop, left to right):+ * workspace rail 68px | channel sidebar 260px | message stream (fill) | thread panel 340px+ *+ * Container policy: dense rows, zero Cards. Channels and DMs are List/ListItem+ * rows, presence is AvatarStatusDot/StatusDot, unread counts are the only+ * Badge usage. The stream and thread are built on the Chat component family.+ *+ * Responsive contract:+ * >1024px — full four-column frame (rail | sidebar | stream | thread)+ * <=1024px — thread panel hidden; stream takes the reclaimed width+ * <=768px — sidebar also hidden; rail + stream keep full width+ *+ * Fixtures are deterministic: fixed ISO timestamps rendered via <Timestamp>,+ * no Date.now()/Math.random() anywhere.+ */++import {useState, type CSSProperties} from 'react';++import {+ Layout,+ LayoutContent,+ LayoutPanel,+ Stack,+ StackItem,+ HStack,+ VStack,+} from '@astryxdesign/core/Layout';+import {Text, Heading} from '@astryxdesign/core/Text';+import {+ ChatComposer,+ ChatLayout,+ ChatMessage,+ ChatMessageBubble,+ ChatMessageList,+ ChatMessageMetadata,+ ChatSystemMessage,+} from '@astryxdesign/core/Chat';+import {Avatar, AvatarStatusDot} from '@astryxdesign/core/Avatar';+import {StatusDot} from '@astryxdesign/core/StatusDot';+import {Badge} from '@astryxdesign/core/Badge';+import {List, ListItem} from '@astryxdesign/core/List';+import {Divider} from '@astryxdesign/core/Divider';+import {TextInput} from '@astryxdesign/core/TextInput';+import {Timestamp} from '@astryxdesign/core/Timestamp';+import {EmptyState} from '@astryxdesign/core/EmptyState';+import {Icon} from '@astryxdesign/core/Icon';+import {IconButton} from '@astryxdesign/core/IconButton';+import {useMediaQuery} from '@astryxdesign/core/hooks';++import {+ BellIcon,+ BookmarkIcon,+ ChatBubbleLeftRightIcon,+ Cog6ToothIcon,+ HashtagIcon,+ HomeIcon,+ InboxIcon,+ MagnifyingGlassIcon,+ PencilSquareIcon,+ UserGroupIcon,+ XMarkIcon,+} from '@heroicons/react/24/outline';++// ---------------------------------------------------------------------------+// Styles — plain CSS properties with semantic tokens only.+// ---------------------------------------------------------------------------++const styles: Record<string, CSSProperties> = {+ root: {+ height: '100dvh',+ width: '100%',+ },+ rail: {+ height: '100%',+ alignItems: 'center',+ paddingTop: 'var(--spacing-3)',+ paddingBottom: 'var(--spacing-3)',+ },+ railSpacer: {+ flex: 1,+ },+ sidebar: {+ height: '100%',+ minHeight: 0,+ },+ sidebarHeader: {+ alignItems: 'center',+ paddingInline: 'var(--spacing-3)',+ paddingBlock: 'var(--spacing-3)',+ },+ sidebarSearch: {+ paddingInline: 'var(--spacing-3)',+ paddingBottom: 'var(--spacing-2)',+ },+ sidebarScroll: {+ minHeight: 0,+ overflowY: 'auto',+ paddingInline: 'var(--spacing-2)',+ paddingBottom: 'var(--spacing-3)',+ },+ sectionGap: {+ marginTop: 'var(--spacing-4)',+ },+ streamColumn: {+ height: '100%',+ minHeight: 0,+ },+ streamHeader: {+ alignItems: 'center',+ paddingInline: 'var(--spacing-4)',+ paddingBlock: 'var(--spacing-3)',+ },+ streamTopic: {+ minWidth: 0,+ },+ chatArea: {+ minHeight: 0,+ display: 'flex',+ flexDirection: 'column',+ },+ chatFill: {+ flex: 1,+ minHeight: 0,+ },+ threadColumn: {+ height: '100%',+ minHeight: 0,+ },+ threadHeader: {+ alignItems: 'center',+ paddingInline: 'var(--spacing-3)',+ paddingBlock: 'var(--spacing-2)',+ },+ threadScroll: {+ minHeight: 0,+ overflowY: 'auto',+ paddingInline: 'var(--spacing-3)',+ paddingBlock: 'var(--spacing-3)',+ },+ threadComposer: {+ padding: 'var(--spacing-3)',+ },+};++// ---------------------------------------------------------------------------+// Deterministic fixtures — fixed ISO timestamps, stable ordering.+// ---------------------------------------------------------------------------++type Presence = 'online' | 'busy' | 'offline';++interface User {+ name: string;+}++const USERS: Record<string, User> = {+ mira: {name: 'Mira Chen'},+ devon: {name: 'Devon Park'},+ sasha: {name: 'Sasha Ortiz'},+ you: {name: 'Riley Quinn'},+};++interface Channel {+ id: string;+ name: string;+ topic: string;+ unread: number;+}++const CHANNELS: Channel[] = [+ {+ id: 'design-systems',+ name: 'design-systems',+ topic: 'Component APIs, tokens, and release coordination',+ unread: 0,+ },+ {+ id: 'frontend-guild',+ name: 'frontend-guild',+ topic: 'Cross-team frontend practices',+ unread: 4,+ },+ {+ id: 'releases',+ name: 'releases',+ topic: 'Release announcements and rollbacks',+ unread: 12,+ },+ {id: 'random', name: 'random', topic: 'Everything else', unread: 0},+];++interface DirectMessage {+ id: string;+ userId: string;+ presence: Presence;+ unread: number;+}++const DIRECT_MESSAGES: DirectMessage[] = [+ {id: 'dm-mira', userId: 'mira', presence: 'online', unread: 0},+ {id: 'dm-devon', userId: 'devon', presence: 'busy', unread: 2},+ {id: 'dm-sasha', userId: 'sasha', presence: 'offline', unread: 0},+];++// AvatarStatusDot supports success | neutral | error (no warning).+const PRESENCE_VARIANT: Record<Presence, 'success' | 'error' | 'neutral'> = {+ online: 'success',+ busy: 'error',+ offline: 'neutral',+};++const PRESENCE_LABEL: Record<Presence, string> = {+ online: 'Online',+ busy: 'Busy',+ offline: 'Offline',+};++/** One message group: consecutive bubbles from the same sender. */+interface StreamMessage {+ id: string;+ userId: string;+ time: string;+ bubbles: string[];+}++const MESSAGES_BY_CHANNEL: Record<string, StreamMessage[]> = {+ 'design-systems': [+ {+ id: 'm1',+ userId: 'mira',+ time: '2026-06-30T09:12:00',+ bubbles: [+ 'Morning! The Timestamp component now supports a `system_date` format — worth switching the audit log over.',+ 'I put the migration notes in the wiki under Decisions.',+ ],+ },+ {+ id: 'm2',+ userId: 'devon',+ time: '2026-06-30T09:15:00',+ bubbles: ['Nice. Does that unblock the incident console timeline work?'],+ },+ {+ id: 'm3',+ userId: 'you',+ time: '2026-06-30T09:17:00',+ bubbles: [+ 'It does — I will pick that up after the template review.',+ 'One question on the List density defaults, will start a thread.',+ ],+ },+ {+ id: 'm4',+ userId: 'sasha',+ time: '2026-06-30T09:24:00',+ bubbles: [+ 'Heads up: the token sync job ran clean overnight, no drift between core and the theme packages.',+ ],+ },+ {+ id: 'm5',+ userId: 'mira',+ time: '2026-06-30T09:26:00',+ bubbles: ['Great — closing out the drift task then.'],+ },+ ],+ 'frontend-guild': [+ {+ id: 'g1',+ userId: 'devon',+ time: '2026-06-30T08:40:00',+ bubbles: [+ 'Guild sync moved to Thursday this week to avoid the release freeze.',+ ],+ },+ {+ id: 'g2',+ userId: 'you',+ time: '2026-06-30T08:44:00',+ bubbles: ['Works for me — agenda doc is updated.'],+ },+ ],+};++interface ThreadReply {+ id: string;+ userId: string;+ time: string;+ text: string;+}++const THREAD_ROOT: ThreadReply = {+ id: 't0',+ userId: 'you',+ time: '2026-06-30T09:17:30',+ text: 'One question on the List density defaults — should channel sidebars use compact or balanced? The spec shows both.',+};++const THREAD_REPLIES: ThreadReply[] = [+ {+ id: 't1',+ userId: 'mira',+ time: '2026-06-30T09:19:00',+ text: 'Compact for navigation surfaces. Balanced is for content lists where descriptions carry weight.',+ },+ {+ id: 't2',+ userId: 'devon',+ time: '2026-06-30T09:21:00',+ text: 'Agreed — the sidebar rows here are a good reference implementation.',+ },+];++const RAIL_ITEMS = [+ {id: 'home', label: 'Home', icon: HomeIcon},+ {id: 'dms', label: 'Direct messages', icon: ChatBubbleLeftRightIcon},+ {id: 'activity', label: 'Activity', icon: BellIcon},+ {id: 'saved', label: 'Saved items', icon: BookmarkIcon},+];++// ---------------------------------------------------------------------------+// Stream message group — avatar + name on the first bubble, timestamp on the+// last, `group` positions tighten corner radii between consecutive bubbles.+// ---------------------------------------------------------------------------++function StreamMessageGroup({message}: {message: StreamMessage}) {+ const isSelf = message.userId === 'you';+ const user = USERS[message.userId];+ const lastIndex = message.bubbles.length - 1;++ return (+ <ChatMessage+ sender={isSelf ? 'user' : 'assistant'}+ avatar={isSelf ? undefined : <Avatar name={user.name} size="small" />}>+ {message.bubbles.map((text, index) => (+ <ChatMessageBubble+ key={`${message.id}-${index}`}+ group={+ message.bubbles.length === 1+ ? undefined+ : index === 0+ ? 'first'+ : index === lastIndex+ ? 'last'+ : 'middle'+ }+ name={!isSelf && index === 0 ? user.name : undefined}+ metadata={+ index === lastIndex ? (+ <ChatMessageMetadata+ timestamp={<Timestamp value={message.time} format="time" />}+ />+ ) : undefined+ }>+ {text}+ </ChatMessageBubble>+ ))}+ </ChatMessage>+ );+}++// ---------------------------------------------------------------------------+// Page+// ---------------------------------------------------------------------------++export default function MessagingShellPage() {+ const [selectedChannelId, setSelectedChannelId] = useState('design-systems');+ const [selectedDmId, setSelectedDmId] = useState<string | null>(null);+ const [isThreadOpen, setIsThreadOpen] = useState(true);+ const [searchQuery, setSearchQuery] = useState('');++ // Responsive contract (see file header).+ const isThreadHidden = useMediaQuery('(max-width: 1024px)');+ const isSidebarHidden = useMediaQuery('(max-width: 768px)');++ const selectedChannel =+ CHANNELS.find(channel => channel.id === selectedChannelId) ?? CHANNELS[0];+ const messages = MESSAGES_BY_CHANNEL[selectedChannel.id] ?? [];++ const normalizedQuery = searchQuery.trim().toLowerCase();+ const visibleChannels = CHANNELS.filter(channel =>+ channel.name.toLowerCase().includes(normalizedQuery),+ );+ const visibleDms = DIRECT_MESSAGES.filter(dm =>+ USERS[dm.userId].name.toLowerCase().includes(normalizedQuery),+ );++ const showThreadPanel = isThreadOpen && !isThreadHidden;++ const workspaceRail = (+ <VStack gap={2} style={styles.rail}>+ <Avatar name="Astryx HQ" size="small" />+ {RAIL_ITEMS.map(item => (+ <IconButton+ key={item.id}+ label={item.label}+ tooltip={item.label}+ icon={<Icon icon={item.icon} size="sm" color="inherit" />}+ variant={item.id === 'home' ? 'secondary' : 'ghost'}+ onClick={() => {}}+ />+ ))}+ <div style={styles.railSpacer} />+ <IconButton+ label="Settings"+ tooltip="Settings"+ icon={<Icon icon={Cog6ToothIcon} size="sm" color="inherit" />}+ variant="ghost"+ onClick={() => {}}+ />+ <Avatar+ name={USERS.you.name}+ size="small"+ status={<AvatarStatusDot variant="success" label="Online" />}+ />+ </VStack>+ );++ const channelSidebar = (+ <Stack direction="vertical" style={styles.sidebar}>+ <HStack gap={2} style={styles.sidebarHeader}>+ <StackItem size="fill">+ <Heading level={5}>Astryx HQ</Heading>+ </StackItem>+ <IconButton+ label="New message"+ tooltip="New message"+ icon={<Icon icon={PencilSquareIcon} size="sm" color="inherit" />}+ variant="ghost"+ size="sm"+ onClick={() => {}}+ />+ </HStack>+ <div style={styles.sidebarSearch}>+ <TextInput+ label="Jump to"+ isLabelHidden+ size="sm"+ placeholder="Jump to..."+ startIcon={MagnifyingGlassIcon}+ value={searchQuery}+ onChange={setSearchQuery}+ />+ </div>+ <StackItem size="fill" style={styles.sidebarScroll}>+ <List+ density="compact"+ hasDividers={false}+ header={+ <Text type="label" size="sm" color="secondary">+ Channels+ </Text>+ }>+ {visibleChannels.map(channel => (+ <ListItem+ key={channel.id}+ label={channel.name}+ isSelected={+ selectedDmId === null && channel.id === selectedChannelId+ }+ onClick={() => {+ setSelectedChannelId(channel.id);+ setSelectedDmId(null);+ }}+ startContent={+ <Icon icon={HashtagIcon} size="sm" color="secondary" />+ }+ endContent={+ channel.unread > 0 ? (+ <Badge label={String(channel.unread)} variant="neutral" />+ ) : undefined+ }+ />+ ))}+ </List>+ <div style={styles.sectionGap}>+ <List+ density="compact"+ hasDividers={false}+ header={+ <Text type="label" size="sm" color="secondary">+ Direct messages+ </Text>+ }>+ {visibleDms.map(dm => (+ <ListItem+ key={dm.id}+ label={USERS[dm.userId].name}+ isSelected={selectedDmId === dm.id}+ onClick={() => setSelectedDmId(dm.id)}+ startContent={+ <Avatar+ name={USERS[dm.userId].name}+ size="xsmall"+ status={+ <AvatarStatusDot+ variant={PRESENCE_VARIANT[dm.presence]}+ label={PRESENCE_LABEL[dm.presence]}+ />+ }+ />+ }+ endContent={+ dm.unread > 0 ? (+ <Badge label={String(dm.unread)} variant="neutral" />+ ) : undefined+ }+ />+ ))}+ </List>+ </div>+ </StackItem>+ </Stack>+ );++ const messageStream = (+ <Stack direction="vertical" style={styles.streamColumn}>+ <HStack gap={3} style={styles.streamHeader}>+ <Icon icon={HashtagIcon} size="sm" color="secondary" />+ <Heading level={5}>{selectedChannel.name}</Heading>+ <StackItem size="fill" style={styles.streamTopic}>+ <Text type="supporting" color="secondary" maxLines={1}>+ {selectedChannel.topic}+ </Text>+ </StackItem>+ <StatusDot variant="success" label="12 online" />+ <IconButton+ label="Members"+ tooltip="Members"+ icon={<Icon icon={UserGroupIcon} size="sm" color="inherit" />}+ variant="ghost"+ size="sm"+ onClick={() => {}}+ />+ </HStack>+ <Divider />+ <StackItem size="fill" style={styles.chatArea}>+ <div style={styles.chatFill}>+ <ChatLayout+ composer={+ <ChatComposer+ placeholder={`Message #${selectedChannel.name}`}+ onSubmit={() => {}}+ />+ }+ emptyState={+ <EmptyState+ icon={<Icon icon={InboxIcon} size="lg" />}+ title="No messages yet"+ description="Start the conversation — messages posted here are visible to the whole channel."+ />+ }>+ {messages.length > 0 ? (+ <ChatMessageList density="balanced">+ <ChatSystemMessage variant="divider">+ Tuesday, June 30+ </ChatSystemMessage>+ <ChatSystemMessage>+ Sasha Ortiz joined #{selectedChannel.name}+ </ChatSystemMessage>+ {messages.map(message => (+ <StreamMessageGroup key={message.id} message={message} />+ ))}+ </ChatMessageList>+ ) : null}+ </ChatLayout>+ </div>+ </StackItem>+ </Stack>+ );++ const threadPanel = (+ <Stack direction="vertical" style={styles.threadColumn}>+ <HStack gap={2} style={styles.threadHeader}>+ <StackItem size="fill">+ <HStack gap={2} style={{alignItems: 'baseline'}}>+ <Text weight="semibold">Thread</Text>+ <Text type="supporting" color="secondary">+ #{selectedChannel.name}+ </Text>+ </HStack>+ </StackItem>+ <IconButton+ label="Close thread"+ tooltip="Close thread"+ icon={<Icon icon={XMarkIcon} size="sm" color="inherit" />}+ variant="ghost"+ size="sm"+ onClick={() => setIsThreadOpen(false)}+ />+ </HStack>+ <Divider />+ <StackItem size="fill" style={styles.threadScroll}>+ <ChatMessageList density="compact">+ <ChatMessage+ sender="assistant"+ avatar={+ <Avatar name={USERS[THREAD_ROOT.userId].name} size="small" />+ }>+ <ChatMessageBubble+ name={USERS[THREAD_ROOT.userId].name}+ metadata={+ <ChatMessageMetadata+ timestamp={+ <Timestamp value={THREAD_ROOT.time} format="time" />+ }+ />+ }>+ {THREAD_ROOT.text}+ </ChatMessageBubble>+ </ChatMessage>+ <ChatSystemMessage variant="divider">+ {THREAD_REPLIES.length} replies+ </ChatSystemMessage>+ {THREAD_REPLIES.map(reply => (+ <ChatMessage+ key={reply.id}+ sender="assistant"+ avatar={<Avatar name={USERS[reply.userId].name} size="small" />}>+ <ChatMessageBubble+ name={USERS[reply.userId].name}+ metadata={+ <ChatMessageMetadata+ timestamp={<Timestamp value={reply.time} format="time" />}+ />+ }>+ {reply.text}+ </ChatMessageBubble>+ </ChatMessage>+ ))}+ </ChatMessageList>+ </StackItem>+ <div style={styles.threadComposer}>+ <ChatComposer+ density="compact"+ placeholder="Reply in thread..."+ onSubmit={() => {}}+ />+ </div>+ </Stack>+ );++ return (+ <div style={styles.root}>+ <Layout+ height="fill"+ start={+ <>+ <LayoutPanel width={68} padding={0}>+ {workspaceRail}+ </LayoutPanel>+ {!isSidebarHidden && (+ <LayoutPanel width={260} padding={0}>+ {channelSidebar}+ </LayoutPanel>+ )}+ </>+ }+ end={+ showThreadPanel ? (+ <LayoutPanel width={340} padding={0}>+ {threadPanel}+ </LayoutPanel>+ ) : undefined+ }+ content={<LayoutContent padding={0}>{messageStream}</LayoutContent>}+ />+ </div>+ );+}diff --git a/packages/cli/templates/pages/messaging-shell/template.doc.mjs b/packages/cli/templates/pages/messaging-shell/template.doc.mjsnew file mode 100644index 0000000000..0bdacddd74--- /dev/null+++ b/packages/cli/templates/pages/messaging-shell/template.doc.mjs@@ -0,0 +1,12 @@+// Copyright (c) Meta Platforms, Inc. and affiliates.++/** @type {import('../../../../core/src/docs-types').TemplateDoc} */+export const doc = {+ type: 'page',+ name: 'Messaging Shell',+ displayName: 'Messaging Shell',+ description:+ 'Slack-style messaging shell with a four-column frame (workspace rail, channel sidebar, message stream, thread panel) built on the Chat component family — dense rows, zero cards.',+ isReady: false,+ category: 'Shell - Messaging',+};diff --git a/packages/core/src/docs-types.ts b/packages/core/src/docs-types.tsindex 6fa9ad416e..b7d31dcd5b 100644--- a/packages/core/src/docs-types.ts+++ b/packages/core/src/docs-types.ts@@ -890,6 +890,7 @@ export type TemplateCategory =| 'Shell - Top Nav'| 'Shell - Top Nav + Left Sidebar'| 'Shell - Breadcrumb Driven Layout'+ | 'Shell - Messaging'| 'Shell - Blank';interface BaseTemplateDoc {