Skip to content

Commit 14e5171

Browse files
feat(ui): add mosaic block/section/aio prototype layers (#8838)
Co-authored-by: Kyle MacDonald <kylemac@users.noreply.github.com>
1 parent d46f262 commit 14e5171

37 files changed

Lines changed: 1272 additions & 12 deletions

‎.changeset/calm-aliens-care.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

‎packages/headless/src/primitives/tabs/tabs-panel.tsx‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
11
'use client';
22

33
import { useMergeRefs } from '@floating-ui/react';
4-
import React, { useRef } from 'react';
4+
import React, { useRef, version } from 'react';
55

66
import { useTransition } from '../../hooks/use-transition';
77
import { type ComponentProps, mergeProps, renderElement } from '../../utils/render-element';
88
import { useTabsContext } from './tabs-context';
99

10+
const major = parseInt(version, 10);
11+
const isModernReact = major >= 19 || major === 0;
12+
13+
export function inertProps(active: boolean): Record<string, unknown> {
14+
if (!active) {
15+
return {};
16+
}
17+
return { inert: isModernReact ? true : '' };
18+
}
19+
1020
export interface TabsPanelProps extends ComponentProps<'div'> {
1121
value: string;
1222
/** When true, removes `hidden` so the panel stays in layout flow. */
@@ -51,11 +61,7 @@ export const TabsPanel = React.forwardRef<HTMLDivElement, TabsPanelProps>(functi
5161
role: 'tabpanel' as const,
5262
'aria-labelledby': tabId,
5363
tabIndex: 0,
54-
// `inert` must be a truthy string, not a boolean or empty string, to stay
55-
// correct across React 18 and 19: React 18 drops a boolean `true` and React
56-
// 19 treats `''` as falsy. `'true'` renders the (presence-based) attribute in
57-
// both. Matches the existing pattern in packages/ui PricingTableMatrix.
58-
inert: !isSelected ? 'true' : undefined,
64+
...inertProps(!isSelected),
5965
hidden: !isSelected && !shouldForceMount ? true : undefined,
6066
ref: combinedRef,
6167
...(shouldForceMount

‎packages/swingset/next.config.mjs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ const nextConfig = {
3030
webpack(config) {
3131
config.resolve.alias['@clerk/ui/mosaic'] = resolve(__dirname, '../ui/src/mosaic');
3232
// Consume @clerk/headless primitives from source (no dist build needed), mirroring Mosaic.
33+
// `/utils` lives outside `primitives/`, so alias it first (more specific wins).
34+
config.resolve.alias['@clerk/headless/utils'] = resolve(__dirname, '../headless/src/utils');
3335
config.resolve.alias['@clerk/headless'] = resolve(__dirname, '../headless/src/primitives');
3436
return config;
3537
},
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
'use client';
2+
3+
import Link from 'next/link';
4+
5+
export interface CompositionPiece {
6+
/** Display name of the piece (e.g. `Destructive`). */
7+
name: string;
8+
/** Route to the piece's page in swingset (e.g. `/blocks/destructive`). */
9+
href: string;
10+
/** Which Mosaic layer the piece lives in (e.g. `Blocks`, `Components`, `Primitives`). */
11+
layer: string;
12+
}
13+
14+
// Mosaic layers, high → low. Drives the order the composition groups render in.
15+
// Plural to match the sidebar group names.
16+
const LAYER_ORDER = ['AIO', 'Sections', 'Blocks', 'Components', 'Primitives'];
17+
18+
function layerRank(layer: string): number {
19+
const i = LAYER_ORDER.indexOf(layer);
20+
return i === -1 ? LAYER_ORDER.length : i;
21+
}
22+
23+
/**
24+
* The linked pieces shown inside a `<Story>`'s attached "Composition" footer, sorted
25+
* and grouped by Mosaic layer. Each piece links to its own page.
26+
*/
27+
export function CompositionPanel({ pieces }: { pieces: CompositionPiece[] }) {
28+
const groups = new Map<string, CompositionPiece[]>();
29+
for (const piece of pieces) {
30+
if (!groups.has(piece.layer)) {
31+
groups.set(piece.layer, []);
32+
}
33+
groups.get(piece.layer)?.push(piece);
34+
}
35+
36+
const sortedLayers = Array.from(groups.keys()).sort((a, b) => layerRank(a) - layerRank(b) || a.localeCompare(b));
37+
38+
return (
39+
<div className='flex flex-col gap-4 p-3'>
40+
{sortedLayers.map(layer => (
41+
<section
42+
key={layer}
43+
className='flex flex-col gap-2'
44+
>
45+
<div className='text-brand text-[10px] font-semibold uppercase tracking-widest'>{layer}</div>
46+
{groups
47+
.get(layer)
48+
?.slice()
49+
.sort((a, b) => a.name.localeCompare(b.name))
50+
.map(piece => (
51+
<Link
52+
key={piece.href}
53+
href={piece.href}
54+
className='text-muted-foreground hover:text-foreground font-mono text-xs'
55+
>
56+
{`<${piece.name} />`}
57+
</Link>
58+
))}
59+
</section>
60+
))}
61+
</div>
62+
);
63+
}

‎packages/swingset/src/components/DocsViewer.tsx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,24 @@ import { ViewSource } from './ViewSource';
1010
// MDX docs keyed by `group` slug → `component` slug. Group-aware so identically-named
1111
// entries (the headless `Dialog` primitive vs. the styled `Dialog` component) stay distinct.
1212
const docModules: Record<string, Record<string, React.ComponentType>> = {
13+
aio: {
14+
'organization-profile': dynamic(() => import('../stories/organization-profile.mdx')),
15+
},
16+
panels: {
17+
'organization-profile-general': dynamic(() => import('../stories/organization-profile-general.mdx')),
18+
},
19+
sections: {
20+
'leave-organization': dynamic(() => import('../stories/leave-organization.mdx')),
21+
'delete-organization': dynamic(() => import('../stories/delete-organization.mdx')),
22+
},
23+
blocks: {
24+
destructive: dynamic(() => import('../stories/destructive.mdx')),
25+
},
1326
components: {
1427
button: dynamic(() => import('../stories/button.mdx')),
1528
input: dynamic(() => import('../stories/input.mdx')),
1629
dialog: dynamic(() => import('../stories/dialog.component.mdx')),
30+
tabs: dynamic(() => import('../stories/tabs.component.mdx')),
1731
},
1832
primitives: {
1933
// Headless primitives — alphabetical.
Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,65 @@
11
'use client';
22

33
import { MosaicProvider } from '@clerk/ui/mosaic/MosaicProvider';
4+
import { Layers2Icon } from 'lucide-react';
45
import type React from 'react';
6+
import { useState } from 'react';
57

8+
import { Collapsible, CollapsibleContent, CollapsibleTrigger } from '@/components/ui/collapsible';
69
import { generateKnobs, initKnobValues } from '@/lib/generateKnobs';
710
import type { StoryModule } from '@/lib/types';
811

12+
import type { CompositionPiece } from './Composition';
13+
import { CompositionPanel } from './Composition';
14+
915
interface StoryEmbedProps {
1016
name: string;
1117
storyModule: StoryModule;
18+
/** When provided, a collapsible "Composition" footer is attached to the example card. */
19+
composition?: CompositionPiece[];
1220
}
1321

14-
export function StoryEmbed({ name, storyModule }: StoryEmbedProps) {
22+
export function StoryEmbed({ name, storyModule, composition }: StoryEmbedProps) {
1523
const StoryComp = storyModule[name] as React.ComponentType<Record<string, unknown>>;
24+
const [compositionOpen, setCompositionOpen] = useState(false);
25+
1626
if (!StoryComp) {
1727
return <div className='rounded bg-red-50 p-3 text-sm text-red-500'>Story &quot;{name}&quot; not found</div>;
1828
}
1929

2030
const knobs = generateKnobs(storyModule.meta);
2131
const defaultValues = initKnobValues(knobs);
2232

23-
return (
24-
<div className='not-prose border-border bg-background my-4 flex min-h-20 items-center justify-center rounded-lg border p-6'>
33+
const preview = (
34+
<div className='flex min-h-20 items-center justify-center p-6'>
2535
<MosaicProvider>
2636
<StoryComp {...defaultValues} />
2737
</MosaicProvider>
2838
</div>
2939
);
40+
41+
if (!composition) {
42+
return <div className='not-prose border-border bg-background my-4 rounded-lg border'>{preview}</div>;
43+
}
44+
45+
return (
46+
<Collapsible
47+
open={compositionOpen}
48+
onOpenChange={setCompositionOpen}
49+
className='not-prose border-border bg-background my-4 overflow-hidden rounded-lg border'
50+
>
51+
{preview}
52+
53+
<div className='flex items-center justify-start gap-1 border-t px-2 py-1.5'>
54+
<CollapsibleTrigger className='text-muted-foreground hover:text-foreground aria-expanded:bg-muted aria-expanded:text-foreground flex items-center gap-1 rounded px-2 py-1 text-xs'>
55+
<Layers2Icon className='size-3' />
56+
Composition
57+
</CollapsibleTrigger>
58+
</div>
59+
60+
<CollapsibleContent className='border-t'>
61+
<CompositionPanel pieces={composition} />
62+
</CollapsibleContent>
63+
</Collapsible>
64+
);
3065
}

‎packages/swingset/src/components/app-sidebar.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export function AppSidebar({ ...props }: React.ComponentProps<typeof Sidebar>) {
7878
isActive={pathname === href}
7979
render={<Link href={href} />}
8080
>
81-
<span className='truncate'>{mod.meta.title}</span>
81+
<span className='truncate'>{mod.meta.label ?? mod.meta.title}</span>
8282
<span className='text-sidebar-foreground/50 shrink-0 font-mono text-[10px] leading-none'>
8383
{`<${mod.meta.title} />`}
8484
</span>

‎packages/swingset/src/lib/registry.ts‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ import { meta as accordionMeta } from '../stories/accordion.stories';
33
import { meta as autocompleteMeta } from '../stories/autocomplete.stories';
44
import { Disabled, meta as buttonMeta, Primary, Sizes } from '../stories/button.stories';
55
import { meta as collapsibleMeta } from '../stories/collapsible.stories';
6+
import {
7+
Default as DeleteOrganizationDefault,
8+
meta as deleteOrganizationMeta,
9+
} from '../stories/delete-organization.stories';
10+
import { Default as DestructiveDefault, meta as destructiveMeta } from '../stories/destructive.stories';
611
import { Default as DialogDefault, meta as dialogComponentMeta } from '../stories/dialog.component.stories';
712
import { meta as dialogMeta } from '../stories/dialog.stories';
813
import {
@@ -12,20 +17,44 @@ import {
1217
meta as inputMeta,
1318
Sizes as InputSizes,
1419
} from '../stories/input.stories';
20+
import {
21+
Default as LeaveOrganizationDefault,
22+
meta as leaveOrganizationMeta,
23+
} from '../stories/leave-organization.stories';
1524
import { meta as menuMeta } from '../stories/menu.stories';
25+
import {
26+
Default as OrganizationProfileDefault,
27+
meta as organizationProfileMeta,
28+
} from '../stories/organization-profile.stories';
29+
import {
30+
Default as OrganizationProfileGeneralDefault,
31+
meta as organizationProfileGeneralMeta,
32+
} from '../stories/organization-profile-general.stories';
1633
import { meta as popoverMeta } from '../stories/popover.stories';
1734
import { meta as selectMeta } from '../stories/select.stories';
35+
import { Default as TabsComponentDefault, meta as tabsComponentMeta } from '../stories/tabs.component.stories';
1836
import { meta as tabsMeta } from '../stories/tabs.stories';
1937
import { meta as tooltipMeta } from '../stories/tooltip.stories';
2038
import { toSlug } from './slug';
2139
import type { StoryModule } from './types';
2240

41+
const destructiveModule: StoryModule = { meta: destructiveMeta, Default: DestructiveDefault };
42+
const leaveOrganizationModule: StoryModule = { meta: leaveOrganizationMeta, Default: LeaveOrganizationDefault };
43+
const deleteOrganizationModule: StoryModule = { meta: deleteOrganizationMeta, Default: DeleteOrganizationDefault };
44+
const organizationProfileModule: StoryModule = { meta: organizationProfileMeta, Default: OrganizationProfileDefault };
45+
const organizationProfileGeneralModule: StoryModule = {
46+
meta: organizationProfileGeneralMeta,
47+
Default: OrganizationProfileGeneralDefault,
48+
};
49+
2350
const buttonModule: StoryModule = { meta: buttonMeta, Primary, Sizes, Disabled };
2451

2552
const inputModule: StoryModule = { meta: inputMeta, Default, Sizes: InputSizes, Disabled: InputDisabled, Invalid };
2653

2754
const dialogComponentModule: StoryModule = { meta: dialogComponentMeta, Default: DialogDefault };
2855

56+
const tabsComponentModule: StoryModule = { meta: tabsComponentMeta, Default: TabsComponentDefault };
57+
2958
// Headless primitives carry just `meta` (no story functions). Like every component
3059
// they're documented as a single overview page; their live demos come from `<Story>` /
3160
// `<Preview>` embeds in the MDX, which import the stories module directly.
@@ -40,9 +69,20 @@ const tabsModule: StoryModule = { meta: tabsMeta };
4069
const tooltipModule: StoryModule = { meta: tooltipMeta };
4170

4271
export const registry: StoryModule[] = [
72+
// AIO
73+
organizationProfileModule,
74+
// Panels
75+
organizationProfileGeneralModule,
76+
// Sections
77+
leaveOrganizationModule,
78+
deleteOrganizationModule,
79+
// Blocks
80+
destructiveModule,
81+
// Components
4382
buttonModule,
4483
inputModule,
4584
dialogComponentModule,
85+
tabsComponentModule,
4686
// Primitives — alphabetical within the group.
4787
accordionModule,
4888
autocompleteModule,

‎packages/swingset/src/lib/slug.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
export function toSlug(str: string): string {
22
return str
3-
.replace(/([A-Z])/g, (m, c, i) => (i > 0 ? '-' : '') + c.toLowerCase())
3+
.replace(/([a-z])([A-Z])/g, '$1-$2')
44
.replace(/\s+/g, '-')
55
.replace(/-+/g, '-')
66
.replace(/^-/, '')

‎packages/swingset/src/lib/types.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ export type KnobValues = Record<string, string | boolean | number>;
3737
export interface StoryMeta {
3838
group: string;
3939
title: string;
40+
/**
41+
* Optional human-friendly label shown in the sidebar. Falls back to `title` when
42+
* omitted. Use this when the desired sidebar text differs from the component name
43+
* (which still drives the slug and the `<Title />` tag).
44+
*/
45+
label?: string;
4046
/**
4147
* Path to the file that exports the documented component, relative to the monorepo
4248
* root (e.g. `packages/ui/src/mosaic/components/button.tsx`). Rendered as a "View

0 commit comments

Comments
 (0)