feat(ui): add Mosaic Item component#9234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexcarpenter merged 15 commits into from
Jul 30, 2026
Merged

feat(ui): add Mosaic Item component #9234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
71b7813
fix(ui): resolve @clerk/headless types from source in Mosaic dts build
alexcarpenter Jul 23, 2026
af52934
feat(ui): add Mosaic Item component with StyleX styling
alexcarpenter Jul 23, 2026
526e8e6
refactor(ui): simplify Mosaic Item styles and API
alexcarpenter Jul 28, 2026
c066685
docs(repo): update Mosaic styling contract to the StyleX class approach
alexcarpenter Jul 28, 2026
46d0634
refactor(ui): adopt shared MosaicComponentProps in Mosaic Item
alexcarpenter Jul 29, 2026
d8c39c4
fix(ui): update Mosaic Item styles to current token scale
alexcarpenter Jul 29, 2026
d93a7fa
dial in item component
alexcarpenter Jul 29, 2026
7ccd7be
simplify
alexcarpenter Jul 29, 2026
150f757
feat(ui): single-line truncate Mosaic Item title and description
alexcarpenter Jul 29, 2026
38821c6
button up story
alexcarpenter Jul 29, 2026
6905db8
feat(ui): derive Mosaic Item density from variant
alexcarpenter Jul 29, 2026
85c95c0
fix(swingset): remove unused ArrowIcon from Item stories
alexcarpenter Jul 29, 2026
bdfacdd
fix(ui): drop role=list from Mosaic Item Group
alexcarpenter Jul 29, 2026
280ce8f
add size fit option to avatar
alexcarpenter Jul 29, 2026
c8a8e3e
update stories
alexcarpenter Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/mosaic-item.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
1 change: 1 addition & 0 deletions packages/swingset/src/components/DocsViewer.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ const docModules: Record<string, Record<string, React.ComponentType>> = {
button: dynamic(() => import('../stories/button.mdx')),
card: dynamic(() => import('../stories/card.component.mdx')),
input: dynamic(() => import('../stories/input.mdx')),
item: dynamic(() => import('../stories/item.mdx')),
dialog: dynamic(() => import('../stories/dialog.component.mdx')),
heading: dynamic(() => import('../stories/heading.mdx')),
icon: dynamic(() => import('../stories/icon.mdx')),
Expand Down
14 changes: 14 additions & 0 deletions packages/swingset/src/lib/registry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ import {
meta as inputMeta,
Sizes as InputSizes,
} from '../stories/input.stories';
import {
Default as ItemDefault,
Group as ItemGroup,
Interactive as ItemInteractive,
meta as itemMeta,
} from '../stories/item.stories';
import { meta as menuMeta } from '../stories/menu.stories';
import {
Default as OrganizationProfileDefault,
Expand DownExpand Up@@ -149,6 +155,13 @@ const inputModule: StoryModule = { meta: inputMeta, Default, Sizes: InputSizes,

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

const itemModule: StoryModule = {
meta: itemMeta,
Default: ItemDefault,
Interactive: ItemInteractive,
Group: ItemGroup,
};

const headingModule: StoryModule = {
meta: headingMeta,
Default: HeadingDefault,
Expand DownExpand Up@@ -204,6 +217,7 @@ export const registry: StoryModule[] = [
buttonModule,
cardComponentModule,
inputModule,
itemModule,
dialogComponentModule,
headingModule,
iconModule,
Expand Down
89 changes: 89 additions & 0 deletions packages/swingset/src/stories/item.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import * as ItemStories from './item.stories';

# Item

Item is a flexible row for lists of accounts, organizations, and settings in Mosaic. It's composed from parts via dot syntax (`Item.Root`, `Item.Media`, `Item.Content`, `Item.Title`, …). `Item.Root` renders as a `<div>` by default; pass it a `render` prop to make a row an interactive link or button, which adds hover and cursor affordances.

## Example

<Story
name='Default'
storyModule={ItemStories}
/>

### Interactive

<Story
name='Interactive'
storyModule={ItemStories}
/>

### Group

<Story
name='Group'
storyModule={ItemStories}
/>

## Usage

```tsx
import { Avatar } from '@clerk/ui/mosaic/components/avatar';
import { Item } from '@clerk/ui/mosaic/components/item';

<Item.Group>
<Item.Root render={({ children, ...props }) => <a {...props} href='/org'>{children}</a>}>
<Item.Media>
<Avatar.Root shape='square' size='md'>
<Avatar.Image src={org.imageUrl} alt='' />
<Avatar.Fallback>{org.name[0]}</Avatar.Fallback>
</Avatar.Root>
</Item.Media>
<Item.Content>
<Item.Title>Test Organization</Item.Title>
<Item.Description>Member</Item.Description>
</Item.Content>
<Item.Actions>
<Button variant='outline'>Manage</Button>
</Item.Actions>
</Item.Root>
</Item.Group>;
Comment thread
alexcarpenter marked this conversation as resolved.
```

## Parts

| Part | Class | Description |
| -------------------- | ------------------------ | -------------------------------------------------------------------- |
| `Item.Root` | `cl-item` | Root row. Renders a `<div>`, or a custom element via `render`. |
| `Item.Media` | `cl-item-media` | Leading (or trailing) media: icon, image, or avatar. |
| `Item.Content` | `cl-item-content` | Vertical stack that grows to fill the row between media and actions. |
| `Item.Title` | `cl-item-title` | Primary label. |
| `Item.Description` | `cl-item-description` | Secondary text. Renders a `<p>`. |
| `Item.Actions` | `cl-item-actions` | Trailing controls (buttons, badges). |
| `Item.Header` | `cl-item-header` | Header row above a group: a label with optional actions. |
| `Item.HeaderTitle` | `cl-item-header-title` | Label text within an `Item.Header`. |
| `Item.HeaderActions` | `cl-item-header-actions` | Trailing controls within an `Item.Header`. |
| `Item.Group` | `cl-item-group` | Vertical wrapper around a set of rows (layout only, no role). |
| `Item.Separator` | `cl-item-separator` | Thin divider (`<hr>`) between rows. |

Every part accepts a `render` prop for element polymorphism and forwards a ref.

## Styling

The root reflects its state as `data-*` attributes on `.cl-item`, so consumers can scope overrides without touching StyleX's hashed atoms:

| Prop | Attribute | Values | Default |
| --------- | ------------------ | ----------------------------------- | -------- |
| `variant` | `data-variant` | `entity` \| `action` | `entity` |
| `render` | `data-interactive` | present when a `render` is provided | — |

`variant` sets the row's vertical density (`entity` is standard, `action` is denser) and, on interactive rows, promotes the title color.

```css
/* Re-theme interactive rows */
.cl-item[data-interactive] {
background-color: var(--cl-color-card);
}
```

`Item.Media` sizes to its child and centers it; its height follows the row. Bring your own icon, avatar, or image at whatever dimensions you need, then size the slot by sizing that child. Colors, radii, and spacing all resolve from the Mosaic tokens (`--cl-color-*`, `--cl-radius-*`, `--cl-spacing`).
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(ui): add Mosaic Item component#9234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 15 commits into

from

Jul 30, 2026
 Merged


feat(ui): add Mosaic Item component
#9234
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


15 commits


Select commit
Hold shift + click to select a range
71b7813

fix(ui): resolve @clerk/headless types from source in Mosaic dts build


alexcarpenter Jul 23, 2026
af52934

feat(ui): add Mosaic Item component with StyleX styling


alexcarpenter Jul 23, 2026
526e8e6

refactor(ui): simplify Mosaic Item styles and API


alexcarpenter Jul 28, 2026
c066685

docs(repo): update Mosaic styling contract to the StyleX class approach


alexcarpenter Jul 28, 2026
46d0634

refactor(ui): adopt shared MosaicComponentProps in Mosaic Item


alexcarpenter Jul 29, 2026
d8c39c4

fix(ui): update Mosaic Item styles to current token scale


alexcarpenter Jul 29, 2026
d93a7fa

dial in item component


alexcarpenter Jul 29, 2026
7ccd7be

simplify


alexcarpenter Jul 29, 2026
150f757

feat(ui): single-line truncate Mosaic Item title and description


alexcarpenter Jul 29, 2026
38821c6

button up story


alexcarpenter Jul 29, 2026
6905db8

feat(ui): derive Mosaic Item density from variant


alexcarpenter Jul 29, 2026
85c95c0

fix(swingset): remove unused ArrowIcon from Item stories


alexcarpenter Jul 29, 2026
bdfacdd

fix(ui): drop role=list from Mosaic Item Group


alexcarpenter Jul 29, 2026
280ce8f

add size fit option to avatar


alexcarpenter Jul 29, 2026
c8a8e3e

update stories


alexcarpenter Jul 29, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/mosaic-item.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/src/components/DocsViewer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ const docModules: Record<string, Record<string, React.ComponentType>> = {
 button: dynamic(() => import('../stories/button.mdx')),
 card: dynamic(() => import('../stories/card.component.mdx')),
 input: dynamic(() => import('../stories/input.mdx')),
 item: dynamic(() => import('../stories/item.mdx')),
 dialog: dynamic(() => import('../stories/dialog.component.mdx')),
 heading: dynamic(() => import('../stories/heading.mdx')),
 icon: dynamic(() => import('../stories/icon.mdx')),
Expand Down

14 changes: 14 additions & 0 deletions
packages/swingset/src/lib/registry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ import {
 meta as inputMeta,
 Sizes as InputSizes,
} from '../stories/input.stories';
import {
 Default as ItemDefault,
 Group as ItemGroup,
 Interactive as ItemInteractive,
 meta as itemMeta,
} from '../stories/item.stories';
import { meta as menuMeta } from '../stories/menu.stories';
import {
 Default as OrganizationProfileDefault,
Expand DownExpand Up@@ -149,6 +155,13 @@ const inputModule: StoryModule = { meta: inputMeta, Default, Sizes: InputSizes,

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

const itemModule: StoryModule = {
 meta: itemMeta,
 Default: ItemDefault,
 Interactive: ItemInteractive,
 Group: ItemGroup,
};

const headingModule: StoryModule = {
 meta: headingMeta,
 Default: HeadingDefault,
Expand DownExpand Up@@ -204,6 +217,7 @@ export const registry: StoryModule[] = [
 buttonModule,
 cardComponentModule,
 inputModule,
 itemModule,
 dialogComponentModule,
 headingModule,
 iconModule,
Expand Down

89 changes: 89 additions & 0 deletions
packages/swingset/src/stories/item.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import * as ItemStories from './item.stories';

# Item

Item is a flexible row for lists of accounts, organizations, and settings in Mosaic. It's composed from parts via dot syntax (`Item.Root`, `Item.Media`, `Item.Content`, `Item.Title`, …). `Item.Root` renders as a `<div>` by default; pass it a `render` prop to make a row an interactive link or button, which adds hover and cursor affordances.

## Example

<Story
 name='Default'
 storyModule={ItemStories}
/>

### Interactive

<Story
 name='Interactive'
 storyModule={ItemStories}
/>

### Group

<Story
 name='Group'
 storyModule={ItemStories}
/>

## Usage

```tsx
import { Avatar } from '@clerk/ui/mosaic/components/avatar';
import { Item } from '@clerk/ui/mosaic/components/item';

<Item.Group>
 <Item.Root render={({ children, ...props }) => <a {...props} href='/org'>{children}</a>}>
 <Item.Media>
 <Avatar.Root shape='square' size='md'>
 <Avatar.Image src={org.imageUrl} alt='' />
 <Avatar.Fallback>{org.name[0]}</Avatar.Fallback>
 </Avatar.Root>
 </Item.Media>
 <Item.Content>
 <Item.Title>Test Organization</Item.Title>
 <Item.Description>Member</Item.Description>
 </Item.Content>
 <Item.Actions>
 <Button variant='outline'>Manage</Button>
 </Item.Actions>
 </Item.Root>
</Item.Group>;
Comment thread
alexcarpenter marked this conversation as resolved.

```

## Parts

| Part | Class | Description |
| -------------------- | ------------------------ | -------------------------------------------------------------------- |
| `Item.Root` | `cl-item` | Root row. Renders a `<div>`, or a custom element via `render`. |
| `Item.Media` | `cl-item-media` | Leading (or trailing) media: icon, image, or avatar. |
| `Item.Content` | `cl-item-content` | Vertical stack that grows to fill the row between media and actions. |
| `Item.Title` | `cl-item-title` | Primary label. |
| `Item.Description` | `cl-item-description` | Secondary text. Renders a `<p>`. |
| `Item.Actions` | `cl-item-actions` | Trailing controls (buttons, badges). |
| `Item.Header` | `cl-item-header` | Header row above a group: a label with optional actions. |
| `Item.HeaderTitle` | `cl-item-header-title` | Label text within an `Item.Header`. |
| `Item.HeaderActions` | `cl-item-header-actions` | Trailing controls within an `Item.Header`. |
| `Item.Group` | `cl-item-group` | Vertical wrapper around a set of rows (layout only, no role). |
| `Item.Separator` | `cl-item-separator` | Thin divider (`<hr>`) between rows. |

Every part accepts a `render` prop for element polymorphism and forwards a ref.

## Styling

The root reflects its state as `data-*` attributes on `.cl-item`, so consumers can scope overrides without touching StyleX's hashed atoms:

| Prop | Attribute | Values | Default |
| --------- | ------------------ | ----------------------------------- | -------- |
| `variant` | `data-variant` | `entity` \| `action` | `entity` |
| `render` | `data-interactive` | present when a `render` is provided | — |

`variant` sets the row's vertical density (`entity` is standard, `action` is denser) and, on interactive rows, promotes the title color.

```css
/* Re-theme interactive rows */
.cl-item[data-interactive] {
 background-color: var(--cl-color-card);
}
```

`Item.Media` sizes to its child and centers it; its height follows the row. Bring your own icon, avatar, or image at whatever dimensions you need, then size the slot by sizing that child. Colors, radii, and spacing all resolve from the Mosaic tokens (`--cl-color-*`, `--cl-radius-*`, `--cl-spacing`).
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(ui): add Mosaic Item component#9234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 15 commits into

from

Jul 30, 2026
 Merged


feat(ui): add Mosaic Item component
#9234
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


15 commits


Select commit
Hold shift + click to select a range
71b7813

fix(ui): resolve @clerk/headless types from source in Mosaic dts build


alexcarpenter Jul 23, 2026
af52934

feat(ui): add Mosaic Item component with StyleX styling


alexcarpenter Jul 23, 2026
526e8e6

refactor(ui): simplify Mosaic Item styles and API


alexcarpenter Jul 28, 2026
c066685

docs(repo): update Mosaic styling contract to the StyleX class approach


alexcarpenter Jul 28, 2026
46d0634

refactor(ui): adopt shared MosaicComponentProps in Mosaic Item


alexcarpenter Jul 29, 2026
d8c39c4

fix(ui): update Mosaic Item styles to current token scale


alexcarpenter Jul 29, 2026
d93a7fa

dial in item component


alexcarpenter Jul 29, 2026
7ccd7be

simplify


alexcarpenter Jul 29, 2026
150f757

feat(ui): single-line truncate Mosaic Item title and description


alexcarpenter Jul 29, 2026
38821c6

button up story


alexcarpenter Jul 29, 2026
6905db8

feat(ui): derive Mosaic Item density from variant


alexcarpenter Jul 29, 2026
85c95c0

fix(swingset): remove unused ArrowIcon from Item stories


alexcarpenter Jul 29, 2026
bdfacdd

fix(ui): drop role=list from Mosaic Item Group


alexcarpenter Jul 29, 2026
280ce8f

add size fit option to avatar


alexcarpenter Jul 29, 2026
c8a8e3e

update stories


alexcarpenter Jul 29, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/mosaic-item.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/src/components/DocsViewer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ const docModules: Record<string, Record<string, React.ComponentType>> = {
 button: dynamic(() => import('../stories/button.mdx')),
 card: dynamic(() => import('../stories/card.component.mdx')),
 input: dynamic(() => import('../stories/input.mdx')),
 item: dynamic(() => import('../stories/item.mdx')),
 dialog: dynamic(() => import('../stories/dialog.component.mdx')),
 heading: dynamic(() => import('../stories/heading.mdx')),
 icon: dynamic(() => import('../stories/icon.mdx')),
Expand Down

14 changes: 14 additions & 0 deletions
packages/swingset/src/lib/registry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ import {
 meta as inputMeta,
 Sizes as InputSizes,
} from '../stories/input.stories';
import {
 Default as ItemDefault,
 Group as ItemGroup,
 Interactive as ItemInteractive,
 meta as itemMeta,
} from '../stories/item.stories';
import { meta as menuMeta } from '../stories/menu.stories';
import {
 Default as OrganizationProfileDefault,
Expand DownExpand Up@@ -149,6 +155,13 @@ const inputModule: StoryModule = { meta: inputMeta, Default, Sizes: InputSizes,

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

const itemModule: StoryModule = {
 meta: itemMeta,
 Default: ItemDefault,
 Interactive: ItemInteractive,
 Group: ItemGroup,
};

const headingModule: StoryModule = {
 meta: headingMeta,
 Default: HeadingDefault,
Expand DownExpand Up@@ -204,6 +217,7 @@ export const registry: StoryModule[] = [
 buttonModule,
 cardComponentModule,
 inputModule,
 itemModule,
 dialogComponentModule,
 headingModule,
 iconModule,
Expand Down

89 changes: 89 additions & 0 deletions
packages/swingset/src/stories/item.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import * as ItemStories from './item.stories';

# Item

Item is a flexible row for lists of accounts, organizations, and settings in Mosaic. It's composed from parts via dot syntax (`Item.Root`, `Item.Media`, `Item.Content`, `Item.Title`, …). `Item.Root` renders as a `<div>` by default; pass it a `render` prop to make a row an interactive link or button, which adds hover and cursor affordances.

## Example

<Story
 name='Default'
 storyModule={ItemStories}
/>

### Interactive

<Story
 name='Interactive'
 storyModule={ItemStories}
/>

### Group

<Story
 name='Group'
 storyModule={ItemStories}
/>

## Usage

```tsx
import { Avatar } from '@clerk/ui/mosaic/components/avatar';
import { Item } from '@clerk/ui/mosaic/components/item';

<Item.Group>
 <Item.Root render={({ children, ...props }) => <a {...props} href='/org'>{children}</a>}>
 <Item.Media>
 <Avatar.Root shape='square' size='md'>
 <Avatar.Image src={org.imageUrl} alt='' />
 <Avatar.Fallback>{org.name[0]}</Avatar.Fallback>
 </Avatar.Root>
 </Item.Media>
 <Item.Content>
 <Item.Title>Test Organization</Item.Title>
 <Item.Description>Member</Item.Description>
 </Item.Content>
 <Item.Actions>
 <Button variant='outline'>Manage</Button>
 </Item.Actions>
 </Item.Root>
</Item.Group>;
Comment thread
alexcarpenter marked this conversation as resolved.

```

## Parts

| Part | Class | Description |
| -------------------- | ------------------------ | -------------------------------------------------------------------- |
| `Item.Root` | `cl-item` | Root row. Renders a `<div>`, or a custom element via `render`. |
| `Item.Media` | `cl-item-media` | Leading (or trailing) media: icon, image, or avatar. |
| `Item.Content` | `cl-item-content` | Vertical stack that grows to fill the row between media and actions. |
| `Item.Title` | `cl-item-title` | Primary label. |
| `Item.Description` | `cl-item-description` | Secondary text. Renders a `<p>`. |
| `Item.Actions` | `cl-item-actions` | Trailing controls (buttons, badges). |
| `Item.Header` | `cl-item-header` | Header row above a group: a label with optional actions. |
| `Item.HeaderTitle` | `cl-item-header-title` | Label text within an `Item.Header`. |
| `Item.HeaderActions` | `cl-item-header-actions` | Trailing controls within an `Item.Header`. |
| `Item.Group` | `cl-item-group` | Vertical wrapper around a set of rows (layout only, no role). |
| `Item.Separator` | `cl-item-separator` | Thin divider (`<hr>`) between rows. |

Every part accepts a `render` prop for element polymorphism and forwards a ref.

## Styling

The root reflects its state as `data-*` attributes on `.cl-item`, so consumers can scope overrides without touching StyleX's hashed atoms:

| Prop | Attribute | Values | Default |
| --------- | ------------------ | ----------------------------------- | -------- |
| `variant` | `data-variant` | `entity` \| `action` | `entity` |
| `render` | `data-interactive` | present when a `render` is provided | — |

`variant` sets the row's vertical density (`entity` is standard, `action` is denser) and, on interactive rows, promotes the title color.

```css
/* Re-theme interactive rows */
.cl-item[data-interactive] {
 background-color: var(--cl-color-card);
}
```

`Item.Media` sizes to its child and centers it; its height follows the row. Bring your own icon, avatar, or image at whatever dimensions you need, then size the slot by sizing that child. Colors, radii, and spacing all resolve from the Mosaic tokens (`--cl-color-*`, `--cl-radius-*`, `--cl-spacing`).
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(ui): add Mosaic Item component#9234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 15 commits into

from

Jul 30, 2026
 Merged


feat(ui): add Mosaic Item component
#9234
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


15 commits


Select commit
Hold shift + click to select a range
71b7813

fix(ui): resolve @clerk/headless types from source in Mosaic dts build


alexcarpenter Jul 23, 2026
af52934

feat(ui): add Mosaic Item component with StyleX styling


alexcarpenter Jul 23, 2026
526e8e6

refactor(ui): simplify Mosaic Item styles and API


alexcarpenter Jul 28, 2026
c066685

docs(repo): update Mosaic styling contract to the StyleX class approach


alexcarpenter Jul 28, 2026
46d0634

refactor(ui): adopt shared MosaicComponentProps in Mosaic Item


alexcarpenter Jul 29, 2026
d8c39c4

fix(ui): update Mosaic Item styles to current token scale


alexcarpenter Jul 29, 2026
d93a7fa

dial in item component


alexcarpenter Jul 29, 2026
7ccd7be

simplify


alexcarpenter Jul 29, 2026
150f757

feat(ui): single-line truncate Mosaic Item title and description


alexcarpenter Jul 29, 2026
38821c6

button up story


alexcarpenter Jul 29, 2026
6905db8

feat(ui): derive Mosaic Item density from variant


alexcarpenter Jul 29, 2026
85c95c0

fix(swingset): remove unused ArrowIcon from Item stories


alexcarpenter Jul 29, 2026
bdfacdd

fix(ui): drop role=list from Mosaic Item Group


alexcarpenter Jul 29, 2026
280ce8f

add size fit option to avatar


alexcarpenter Jul 29, 2026
c8a8e3e

update stories


alexcarpenter Jul 29, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/mosaic-item.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/src/components/DocsViewer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ const docModules: Record<string, Record<string, React.ComponentType>> = {
 button: dynamic(() => import('../stories/button.mdx')),
 card: dynamic(() => import('../stories/card.component.mdx')),
 input: dynamic(() => import('../stories/input.mdx')),
 item: dynamic(() => import('../stories/item.mdx')),
 dialog: dynamic(() => import('../stories/dialog.component.mdx')),
 heading: dynamic(() => import('../stories/heading.mdx')),
 icon: dynamic(() => import('../stories/icon.mdx')),
Expand Down

14 changes: 14 additions & 0 deletions
packages/swingset/src/lib/registry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ import {
 meta as inputMeta,
 Sizes as InputSizes,
} from '../stories/input.stories';
import {
 Default as ItemDefault,
 Group as ItemGroup,
 Interactive as ItemInteractive,
 meta as itemMeta,
} from '../stories/item.stories';
import { meta as menuMeta } from '../stories/menu.stories';
import {
 Default as OrganizationProfileDefault,
Expand DownExpand Up@@ -149,6 +155,13 @@ const inputModule: StoryModule = { meta: inputMeta, Default, Sizes: InputSizes,

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

const itemModule: StoryModule = {
 meta: itemMeta,
 Default: ItemDefault,
 Interactive: ItemInteractive,
 Group: ItemGroup,
};

const headingModule: StoryModule = {
 meta: headingMeta,
 Default: HeadingDefault,
Expand DownExpand Up@@ -204,6 +217,7 @@ export const registry: StoryModule[] = [
 buttonModule,
 cardComponentModule,
 inputModule,
 itemModule,
 dialogComponentModule,
 headingModule,
 iconModule,
Expand Down

89 changes: 89 additions & 0 deletions
packages/swingset/src/stories/item.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import * as ItemStories from './item.stories';

# Item

Item is a flexible row for lists of accounts, organizations, and settings in Mosaic. It's composed from parts via dot syntax (`Item.Root`, `Item.Media`, `Item.Content`, `Item.Title`, …). `Item.Root` renders as a `<div>` by default; pass it a `render` prop to make a row an interactive link or button, which adds hover and cursor affordances.

## Example

<Story
 name='Default'
 storyModule={ItemStories}
/>

### Interactive

<Story
 name='Interactive'
 storyModule={ItemStories}
/>

### Group

<Story
 name='Group'
 storyModule={ItemStories}
/>

## Usage

```tsx
import { Avatar } from '@clerk/ui/mosaic/components/avatar';
import { Item } from '@clerk/ui/mosaic/components/item';

<Item.Group>
 <Item.Root render={({ children, ...props }) => <a {...props} href='/org'>{children}</a>}>
 <Item.Media>
 <Avatar.Root shape='square' size='md'>
 <Avatar.Image src={org.imageUrl} alt='' />
 <Avatar.Fallback>{org.name[0]}</Avatar.Fallback>
 </Avatar.Root>
 </Item.Media>
 <Item.Content>
 <Item.Title>Test Organization</Item.Title>
 <Item.Description>Member</Item.Description>
 </Item.Content>
 <Item.Actions>
 <Button variant='outline'>Manage</Button>
 </Item.Actions>
 </Item.Root>
</Item.Group>;
Comment thread
alexcarpenter marked this conversation as resolved.

```

## Parts

| Part | Class | Description |
| -------------------- | ------------------------ | -------------------------------------------------------------------- |
| `Item.Root` | `cl-item` | Root row. Renders a `<div>`, or a custom element via `render`. |
| `Item.Media` | `cl-item-media` | Leading (or trailing) media: icon, image, or avatar. |
| `Item.Content` | `cl-item-content` | Vertical stack that grows to fill the row between media and actions. |
| `Item.Title` | `cl-item-title` | Primary label. |
| `Item.Description` | `cl-item-description` | Secondary text. Renders a `<p>`. |
| `Item.Actions` | `cl-item-actions` | Trailing controls (buttons, badges). |
| `Item.Header` | `cl-item-header` | Header row above a group: a label with optional actions. |
| `Item.HeaderTitle` | `cl-item-header-title` | Label text within an `Item.Header`. |
| `Item.HeaderActions` | `cl-item-header-actions` | Trailing controls within an `Item.Header`. |
| `Item.Group` | `cl-item-group` | Vertical wrapper around a set of rows (layout only, no role). |
| `Item.Separator` | `cl-item-separator` | Thin divider (`<hr>`) between rows. |

Every part accepts a `render` prop for element polymorphism and forwards a ref.

## Styling

The root reflects its state as `data-*` attributes on `.cl-item`, so consumers can scope overrides without touching StyleX's hashed atoms:

| Prop | Attribute | Values | Default |
| --------- | ------------------ | ----------------------------------- | -------- |
| `variant` | `data-variant` | `entity` \| `action` | `entity` |
| `render` | `data-interactive` | present when a `render` is provided | — |

`variant` sets the row's vertical density (`entity` is standard, `action` is denser) and, on interactive rows, promotes the title color.

```css
/* Re-theme interactive rows */
.cl-item[data-interactive] {
 background-color: var(--cl-color-card);
}
```

`Item.Media` sizes to its child and centers it; its height follows the row. Bring your own icon, avatar, or image at whatever dimensions you need, then size the slot by sizing that child. Colors, radii, and spacing all resolve from the Mosaic tokens (`--cl-color-*`, `--cl-radius-*`, `--cl-spacing`).
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(ui): add Mosaic Item component#9234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 15 commits into

from

Jul 30, 2026
 Merged


feat(ui): add Mosaic Item component
#9234
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


15 commits


Select commit
Hold shift + click to select a range
71b7813

fix(ui): resolve @clerk/headless types from source in Mosaic dts build


alexcarpenter Jul 23, 2026
af52934

feat(ui): add Mosaic Item component with StyleX styling


alexcarpenter Jul 23, 2026
526e8e6

refactor(ui): simplify Mosaic Item styles and API


alexcarpenter Jul 28, 2026
c066685

docs(repo): update Mosaic styling contract to the StyleX class approach


alexcarpenter Jul 28, 2026
46d0634

refactor(ui): adopt shared MosaicComponentProps in Mosaic Item


alexcarpenter Jul 29, 2026
d8c39c4

fix(ui): update Mosaic Item styles to current token scale


alexcarpenter Jul 29, 2026
d93a7fa

dial in item component


alexcarpenter Jul 29, 2026
7ccd7be

simplify


alexcarpenter Jul 29, 2026
150f757

feat(ui): single-line truncate Mosaic Item title and description


alexcarpenter Jul 29, 2026
38821c6

button up story


alexcarpenter Jul 29, 2026
6905db8

feat(ui): derive Mosaic Item density from variant


alexcarpenter Jul 29, 2026
85c95c0

fix(swingset): remove unused ArrowIcon from Item stories


alexcarpenter Jul 29, 2026
bdfacdd

fix(ui): drop role=list from Mosaic Item Group


alexcarpenter Jul 29, 2026
280ce8f

add size fit option to avatar


alexcarpenter Jul 29, 2026
c8a8e3e

update stories


alexcarpenter Jul 29, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/mosaic-item.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/src/components/DocsViewer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ const docModules: Record<string, Record<string, React.ComponentType>> = {
 button: dynamic(() => import('../stories/button.mdx')),
 card: dynamic(() => import('../stories/card.component.mdx')),
 input: dynamic(() => import('../stories/input.mdx')),
 item: dynamic(() => import('../stories/item.mdx')),
 dialog: dynamic(() => import('../stories/dialog.component.mdx')),
 heading: dynamic(() => import('../stories/heading.mdx')),
 icon: dynamic(() => import('../stories/icon.mdx')),
Expand Down

14 changes: 14 additions & 0 deletions
packages/swingset/src/lib/registry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ import {
 meta as inputMeta,
 Sizes as InputSizes,
} from '../stories/input.stories';
import {
 Default as ItemDefault,
 Group as ItemGroup,
 Interactive as ItemInteractive,
 meta as itemMeta,
} from '../stories/item.stories';
import { meta as menuMeta } from '../stories/menu.stories';
import {
 Default as OrganizationProfileDefault,
Expand DownExpand Up@@ -149,6 +155,13 @@ const inputModule: StoryModule = { meta: inputMeta, Default, Sizes: InputSizes,

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

const itemModule: StoryModule = {
 meta: itemMeta,
 Default: ItemDefault,
 Interactive: ItemInteractive,
 Group: ItemGroup,
};

const headingModule: StoryModule = {
 meta: headingMeta,
 Default: HeadingDefault,
Expand DownExpand Up@@ -204,6 +217,7 @@ export const registry: StoryModule[] = [
 buttonModule,
 cardComponentModule,
 inputModule,
 itemModule,
 dialogComponentModule,
 headingModule,
 iconModule,
Expand Down

89 changes: 89 additions & 0 deletions
packages/swingset/src/stories/item.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import * as ItemStories from './item.stories';

# Item

Item is a flexible row for lists of accounts, organizations, and settings in Mosaic. It's composed from parts via dot syntax (`Item.Root`, `Item.Media`, `Item.Content`, `Item.Title`, …). `Item.Root` renders as a `<div>` by default; pass it a `render` prop to make a row an interactive link or button, which adds hover and cursor affordances.

## Example

<Story
 name='Default'
 storyModule={ItemStories}
/>

### Interactive

<Story
 name='Interactive'
 storyModule={ItemStories}
/>

### Group

<Story
 name='Group'
 storyModule={ItemStories}
/>

## Usage

```tsx
import { Avatar } from '@clerk/ui/mosaic/components/avatar';
import { Item } from '@clerk/ui/mosaic/components/item';

<Item.Group>
 <Item.Root render={({ children, ...props }) => <a {...props} href='/org'>{children}</a>}>
 <Item.Media>
 <Avatar.Root shape='square' size='md'>
 <Avatar.Image src={org.imageUrl} alt='' />
 <Avatar.Fallback>{org.name[0]}</Avatar.Fallback>
 </Avatar.Root>
 </Item.Media>
 <Item.Content>
 <Item.Title>Test Organization</Item.Title>
 <Item.Description>Member</Item.Description>
 </Item.Content>
 <Item.Actions>
 <Button variant='outline'>Manage</Button>
 </Item.Actions>
 </Item.Root>
</Item.Group>;
Comment thread
alexcarpenter marked this conversation as resolved.

```

## Parts

| Part | Class | Description |
| -------------------- | ------------------------ | -------------------------------------------------------------------- |
| `Item.Root` | `cl-item` | Root row. Renders a `<div>`, or a custom element via `render`. |
| `Item.Media` | `cl-item-media` | Leading (or trailing) media: icon, image, or avatar. |
| `Item.Content` | `cl-item-content` | Vertical stack that grows to fill the row between media and actions. |
| `Item.Title` | `cl-item-title` | Primary label. |
| `Item.Description` | `cl-item-description` | Secondary text. Renders a `<p>`. |
| `Item.Actions` | `cl-item-actions` | Trailing controls (buttons, badges). |
| `Item.Header` | `cl-item-header` | Header row above a group: a label with optional actions. |
| `Item.HeaderTitle` | `cl-item-header-title` | Label text within an `Item.Header`. |
| `Item.HeaderActions` | `cl-item-header-actions` | Trailing controls within an `Item.Header`. |
| `Item.Group` | `cl-item-group` | Vertical wrapper around a set of rows (layout only, no role). |
| `Item.Separator` | `cl-item-separator` | Thin divider (`<hr>`) between rows. |

Every part accepts a `render` prop for element polymorphism and forwards a ref.

## Styling

The root reflects its state as `data-*` attributes on `.cl-item`, so consumers can scope overrides without touching StyleX's hashed atoms:

| Prop | Attribute | Values | Default |
| --------- | ------------------ | ----------------------------------- | -------- |
| `variant` | `data-variant` | `entity` \| `action` | `entity` |
| `render` | `data-interactive` | present when a `render` is provided | — |

`variant` sets the row's vertical density (`entity` is standard, `action` is denser) and, on interactive rows, promotes the title color.

```css
/* Re-theme interactive rows */
.cl-item[data-interactive] {
 background-color: var(--cl-color-card);
}
```

`Item.Media` sizes to its child and centers it; its height follows the row. Bring your own icon, avatar, or image at whatever dimensions you need, then size the slot by sizing that child. Colors, radii, and spacing all resolve from the Mosaic tokens (`--cl-color-*`, `--cl-radius-*`, `--cl-spacing`).
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(ui): add Mosaic Item component#9234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 15 commits into

from

Jul 30, 2026
 Merged


feat(ui): add Mosaic Item component
#9234
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


15 commits


Select commit
Hold shift + click to select a range
71b7813

fix(ui): resolve @clerk/headless types from source in Mosaic dts build


alexcarpenter Jul 23, 2026
af52934

feat(ui): add Mosaic Item component with StyleX styling


alexcarpenter Jul 23, 2026
526e8e6

refactor(ui): simplify Mosaic Item styles and API


alexcarpenter Jul 28, 2026
c066685

docs(repo): update Mosaic styling contract to the StyleX class approach


alexcarpenter Jul 28, 2026
46d0634

refactor(ui): adopt shared MosaicComponentProps in Mosaic Item


alexcarpenter Jul 29, 2026
d8c39c4

fix(ui): update Mosaic Item styles to current token scale


alexcarpenter Jul 29, 2026
d93a7fa

dial in item component


alexcarpenter Jul 29, 2026
7ccd7be

simplify


alexcarpenter Jul 29, 2026
150f757

feat(ui): single-line truncate Mosaic Item title and description


alexcarpenter Jul 29, 2026
38821c6

button up story


alexcarpenter Jul 29, 2026
6905db8

feat(ui): derive Mosaic Item density from variant


alexcarpenter Jul 29, 2026
85c95c0

fix(swingset): remove unused ArrowIcon from Item stories


alexcarpenter Jul 29, 2026
bdfacdd

fix(ui): drop role=list from Mosaic Item Group


alexcarpenter Jul 29, 2026
280ce8f

add size fit option to avatar


alexcarpenter Jul 29, 2026
c8a8e3e

update stories


alexcarpenter Jul 29, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/mosaic-item.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/src/components/DocsViewer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ const docModules: Record<string, Record<string, React.ComponentType>> = {
 button: dynamic(() => import('../stories/button.mdx')),
 card: dynamic(() => import('../stories/card.component.mdx')),
 input: dynamic(() => import('../stories/input.mdx')),
 item: dynamic(() => import('../stories/item.mdx')),
 dialog: dynamic(() => import('../stories/dialog.component.mdx')),
 heading: dynamic(() => import('../stories/heading.mdx')),
 icon: dynamic(() => import('../stories/icon.mdx')),
Expand Down

14 changes: 14 additions & 0 deletions
packages/swingset/src/lib/registry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ import {
 meta as inputMeta,
 Sizes as InputSizes,
} from '../stories/input.stories';
import {
 Default as ItemDefault,
 Group as ItemGroup,
 Interactive as ItemInteractive,
 meta as itemMeta,
} from '../stories/item.stories';
import { meta as menuMeta } from '../stories/menu.stories';
import {
 Default as OrganizationProfileDefault,
Expand DownExpand Up@@ -149,6 +155,13 @@ const inputModule: StoryModule = { meta: inputMeta, Default, Sizes: InputSizes,

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

const itemModule: StoryModule = {
 meta: itemMeta,
 Default: ItemDefault,
 Interactive: ItemInteractive,
 Group: ItemGroup,
};

const headingModule: StoryModule = {
 meta: headingMeta,
 Default: HeadingDefault,
Expand DownExpand Up@@ -204,6 +217,7 @@ export const registry: StoryModule[] = [
 buttonModule,
 cardComponentModule,
 inputModule,
 itemModule,
 dialogComponentModule,
 headingModule,
 iconModule,
Expand Down

89 changes: 89 additions & 0 deletions
packages/swingset/src/stories/item.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import * as ItemStories from './item.stories';

# Item

Item is a flexible row for lists of accounts, organizations, and settings in Mosaic. It's composed from parts via dot syntax (`Item.Root`, `Item.Media`, `Item.Content`, `Item.Title`, …). `Item.Root` renders as a `<div>` by default; pass it a `render` prop to make a row an interactive link or button, which adds hover and cursor affordances.

## Example

<Story
 name='Default'
 storyModule={ItemStories}
/>

### Interactive

<Story
 name='Interactive'
 storyModule={ItemStories}
/>

### Group

<Story
 name='Group'
 storyModule={ItemStories}
/>

## Usage

```tsx
import { Avatar } from '@clerk/ui/mosaic/components/avatar';
import { Item } from '@clerk/ui/mosaic/components/item';

<Item.Group>
 <Item.Root render={({ children, ...props }) => <a {...props} href='/org'>{children}</a>}>
 <Item.Media>
 <Avatar.Root shape='square' size='md'>
 <Avatar.Image src={org.imageUrl} alt='' />
 <Avatar.Fallback>{org.name[0]}</Avatar.Fallback>
 </Avatar.Root>
 </Item.Media>
 <Item.Content>
 <Item.Title>Test Organization</Item.Title>
 <Item.Description>Member</Item.Description>
 </Item.Content>
 <Item.Actions>
 <Button variant='outline'>Manage</Button>
 </Item.Actions>
 </Item.Root>
</Item.Group>;
Comment thread
alexcarpenter marked this conversation as resolved.

```

## Parts

| Part | Class | Description |
| -------------------- | ------------------------ | -------------------------------------------------------------------- |
| `Item.Root` | `cl-item` | Root row. Renders a `<div>`, or a custom element via `render`. |
| `Item.Media` | `cl-item-media` | Leading (or trailing) media: icon, image, or avatar. |
| `Item.Content` | `cl-item-content` | Vertical stack that grows to fill the row between media and actions. |
| `Item.Title` | `cl-item-title` | Primary label. |
| `Item.Description` | `cl-item-description` | Secondary text. Renders a `<p>`. |
| `Item.Actions` | `cl-item-actions` | Trailing controls (buttons, badges). |
| `Item.Header` | `cl-item-header` | Header row above a group: a label with optional actions. |
| `Item.HeaderTitle` | `cl-item-header-title` | Label text within an `Item.Header`. |
| `Item.HeaderActions` | `cl-item-header-actions` | Trailing controls within an `Item.Header`. |
| `Item.Group` | `cl-item-group` | Vertical wrapper around a set of rows (layout only, no role). |
| `Item.Separator` | `cl-item-separator` | Thin divider (`<hr>`) between rows. |

Every part accepts a `render` prop for element polymorphism and forwards a ref.

## Styling

The root reflects its state as `data-*` attributes on `.cl-item`, so consumers can scope overrides without touching StyleX's hashed atoms:

| Prop | Attribute | Values | Default |
| --------- | ------------------ | ----------------------------------- | -------- |
| `variant` | `data-variant` | `entity` \| `action` | `entity` |
| `render` | `data-interactive` | present when a `render` is provided | — |

`variant` sets the row's vertical density (`entity` is standard, `action` is denser) and, on interactive rows, promotes the title color.

```css
/* Re-theme interactive rows */
.cl-item[data-interactive] {
 background-color: var(--cl-color-card);
}
```

`Item.Media` sizes to its child and centers it; its height follows the row. Bring your own icon, avatar, or image at whatever dimensions you need, then size the slot by sizing that child. Colors, radii, and spacing all resolve from the Mosaic tokens (`--cl-color-*`, `--cl-radius-*`, `--cl-spacing`).
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(ui): add Mosaic Item component#9234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 15 commits into

from

Jul 30, 2026
 Merged


feat(ui): add Mosaic Item component
#9234
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


15 commits


Select commit
Hold shift + click to select a range
71b7813

fix(ui): resolve @clerk/headless types from source in Mosaic dts build


alexcarpenter Jul 23, 2026
af52934

feat(ui): add Mosaic Item component with StyleX styling


alexcarpenter Jul 23, 2026
526e8e6

refactor(ui): simplify Mosaic Item styles and API


alexcarpenter Jul 28, 2026
c066685

docs(repo): update Mosaic styling contract to the StyleX class approach


alexcarpenter Jul 28, 2026
46d0634

refactor(ui): adopt shared MosaicComponentProps in Mosaic Item


alexcarpenter Jul 29, 2026
d8c39c4

fix(ui): update Mosaic Item styles to current token scale


alexcarpenter Jul 29, 2026
d93a7fa

dial in item component


alexcarpenter Jul 29, 2026
7ccd7be

simplify


alexcarpenter Jul 29, 2026
150f757

feat(ui): single-line truncate Mosaic Item title and description


alexcarpenter Jul 29, 2026
38821c6

button up story


alexcarpenter Jul 29, 2026
6905db8

feat(ui): derive Mosaic Item density from variant


alexcarpenter Jul 29, 2026
85c95c0

fix(swingset): remove unused ArrowIcon from Item stories


alexcarpenter Jul 29, 2026
bdfacdd

fix(ui): drop role=list from Mosaic Item Group


alexcarpenter Jul 29, 2026
280ce8f

add size fit option to avatar


alexcarpenter Jul 29, 2026
c8a8e3e

update stories


alexcarpenter Jul 29, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/mosaic-item.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/src/components/DocsViewer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ const docModules: Record<string, Record<string, React.ComponentType>> = {
 button: dynamic(() => import('../stories/button.mdx')),
 card: dynamic(() => import('../stories/card.component.mdx')),
 input: dynamic(() => import('../stories/input.mdx')),
 item: dynamic(() => import('../stories/item.mdx')),
 dialog: dynamic(() => import('../stories/dialog.component.mdx')),
 heading: dynamic(() => import('../stories/heading.mdx')),
 icon: dynamic(() => import('../stories/icon.mdx')),
Expand Down

14 changes: 14 additions & 0 deletions
packages/swingset/src/lib/registry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ import {
 meta as inputMeta,
 Sizes as InputSizes,
} from '../stories/input.stories';
import {
 Default as ItemDefault,
 Group as ItemGroup,
 Interactive as ItemInteractive,
 meta as itemMeta,
} from '../stories/item.stories';
import { meta as menuMeta } from '../stories/menu.stories';
import {
 Default as OrganizationProfileDefault,
Expand DownExpand Up@@ -149,6 +155,13 @@ const inputModule: StoryModule = { meta: inputMeta, Default, Sizes: InputSizes,

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

const itemModule: StoryModule = {
 meta: itemMeta,
 Default: ItemDefault,
 Interactive: ItemInteractive,
 Group: ItemGroup,
};

const headingModule: StoryModule = {
 meta: headingMeta,
 Default: HeadingDefault,
Expand DownExpand Up@@ -204,6 +217,7 @@ export const registry: StoryModule[] = [
 buttonModule,
 cardComponentModule,
 inputModule,
 itemModule,
 dialogComponentModule,
 headingModule,
 iconModule,
Expand Down

89 changes: 89 additions & 0 deletions
packages/swingset/src/stories/item.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import * as ItemStories from './item.stories';

# Item

Item is a flexible row for lists of accounts, organizations, and settings in Mosaic. It's composed from parts via dot syntax (`Item.Root`, `Item.Media`, `Item.Content`, `Item.Title`, …). `Item.Root` renders as a `<div>` by default; pass it a `render` prop to make a row an interactive link or button, which adds hover and cursor affordances.

## Example

<Story
 name='Default'
 storyModule={ItemStories}
/>

### Interactive

<Story
 name='Interactive'
 storyModule={ItemStories}
/>

### Group

<Story
 name='Group'
 storyModule={ItemStories}
/>

## Usage

```tsx
import { Avatar } from '@clerk/ui/mosaic/components/avatar';
import { Item } from '@clerk/ui/mosaic/components/item';

<Item.Group>
 <Item.Root render={({ children, ...props }) => <a {...props} href='/org'>{children}</a>}>
 <Item.Media>
 <Avatar.Root shape='square' size='md'>
 <Avatar.Image src={org.imageUrl} alt='' />
 <Avatar.Fallback>{org.name[0]}</Avatar.Fallback>
 </Avatar.Root>
 </Item.Media>
 <Item.Content>
 <Item.Title>Test Organization</Item.Title>
 <Item.Description>Member</Item.Description>
 </Item.Content>
 <Item.Actions>
 <Button variant='outline'>Manage</Button>
 </Item.Actions>
 </Item.Root>
</Item.Group>;
Comment thread
alexcarpenter marked this conversation as resolved.

```

## Parts

| Part | Class | Description |
| -------------------- | ------------------------ | -------------------------------------------------------------------- |
| `Item.Root` | `cl-item` | Root row. Renders a `<div>`, or a custom element via `render`. |
| `Item.Media` | `cl-item-media` | Leading (or trailing) media: icon, image, or avatar. |
| `Item.Content` | `cl-item-content` | Vertical stack that grows to fill the row between media and actions. |
| `Item.Title` | `cl-item-title` | Primary label. |
| `Item.Description` | `cl-item-description` | Secondary text. Renders a `<p>`. |
| `Item.Actions` | `cl-item-actions` | Trailing controls (buttons, badges). |
| `Item.Header` | `cl-item-header` | Header row above a group: a label with optional actions. |
| `Item.HeaderTitle` | `cl-item-header-title` | Label text within an `Item.Header`. |
| `Item.HeaderActions` | `cl-item-header-actions` | Trailing controls within an `Item.Header`. |
| `Item.Group` | `cl-item-group` | Vertical wrapper around a set of rows (layout only, no role). |
| `Item.Separator` | `cl-item-separator` | Thin divider (`<hr>`) between rows. |

Every part accepts a `render` prop for element polymorphism and forwards a ref.

## Styling

The root reflects its state as `data-*` attributes on `.cl-item`, so consumers can scope overrides without touching StyleX's hashed atoms:

| Prop | Attribute | Values | Default |
| --------- | ------------------ | ----------------------------------- | -------- |
| `variant` | `data-variant` | `entity` \| `action` | `entity` |
| `render` | `data-interactive` | present when a `render` is provided | — |

`variant` sets the row's vertical density (`entity` is standard, `action` is denser) and, on interactive rows, promotes the title color.

```css
/* Re-theme interactive rows */
.cl-item[data-interactive] {
 background-color: var(--cl-color-card);
}
```

`Item.Media` sizes to its child and centers it; its height follows the row. Bring your own icon, avatar, or image at whatever dimensions you need, then size the slot by sizing that child. Colors, radii, and spacing all resolve from the Mosaic tokens (`--cl-color-*`, `--cl-radius-*`, `--cl-spacing`).
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(ui): add Mosaic Item component#9234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 15 commits into

from

Jul 30, 2026
 Merged


feat(ui): add Mosaic Item component
#9234
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


15 commits


Select commit
Hold shift + click to select a range
71b7813

fix(ui): resolve @clerk/headless types from source in Mosaic dts build


alexcarpenter Jul 23, 2026
af52934

feat(ui): add Mosaic Item component with StyleX styling


alexcarpenter Jul 23, 2026
526e8e6

refactor(ui): simplify Mosaic Item styles and API


alexcarpenter Jul 28, 2026
c066685

docs(repo): update Mosaic styling contract to the StyleX class approach


alexcarpenter Jul 28, 2026
46d0634

refactor(ui): adopt shared MosaicComponentProps in Mosaic Item


alexcarpenter Jul 29, 2026
d8c39c4

fix(ui): update Mosaic Item styles to current token scale


alexcarpenter Jul 29, 2026
d93a7fa

dial in item component


alexcarpenter Jul 29, 2026
7ccd7be

simplify


alexcarpenter Jul 29, 2026
150f757

feat(ui): single-line truncate Mosaic Item title and description


alexcarpenter Jul 29, 2026
38821c6

button up story


alexcarpenter Jul 29, 2026
6905db8

feat(ui): derive Mosaic Item density from variant


alexcarpenter Jul 29, 2026
85c95c0

fix(swingset): remove unused ArrowIcon from Item stories


alexcarpenter Jul 29, 2026
bdfacdd

fix(ui): drop role=list from Mosaic Item Group


alexcarpenter Jul 29, 2026
280ce8f

add size fit option to avatar


alexcarpenter Jul 29, 2026
c8a8e3e

update stories


alexcarpenter Jul 29, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/mosaic-item.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/src/components/DocsViewer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ const docModules: Record<string, Record<string, React.ComponentType>> = {
 button: dynamic(() => import('../stories/button.mdx')),
 card: dynamic(() => import('../stories/card.component.mdx')),
 input: dynamic(() => import('../stories/input.mdx')),
 item: dynamic(() => import('../stories/item.mdx')),
 dialog: dynamic(() => import('../stories/dialog.component.mdx')),
 heading: dynamic(() => import('../stories/heading.mdx')),
 icon: dynamic(() => import('../stories/icon.mdx')),
Expand Down

14 changes: 14 additions & 0 deletions
packages/swingset/src/lib/registry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ import {
 meta as inputMeta,
 Sizes as InputSizes,
} from '../stories/input.stories';
import {
 Default as ItemDefault,
 Group as ItemGroup,
 Interactive as ItemInteractive,
 meta as itemMeta,
} from '../stories/item.stories';
import { meta as menuMeta } from '../stories/menu.stories';
import {
 Default as OrganizationProfileDefault,
Expand DownExpand Up@@ -149,6 +155,13 @@ const inputModule: StoryModule = { meta: inputMeta, Default, Sizes: InputSizes,

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

const itemModule: StoryModule = {
 meta: itemMeta,
 Default: ItemDefault,
 Interactive: ItemInteractive,
 Group: ItemGroup,
};

const headingModule: StoryModule = {
 meta: headingMeta,
 Default: HeadingDefault,
Expand DownExpand Up@@ -204,6 +217,7 @@ export const registry: StoryModule[] = [
 buttonModule,
 cardComponentModule,
 inputModule,
 itemModule,
 dialogComponentModule,
 headingModule,
 iconModule,
Expand Down

89 changes: 89 additions & 0 deletions
packages/swingset/src/stories/item.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import * as ItemStories from './item.stories';

# Item

Item is a flexible row for lists of accounts, organizations, and settings in Mosaic. It's composed from parts via dot syntax (`Item.Root`, `Item.Media`, `Item.Content`, `Item.Title`, …). `Item.Root` renders as a `<div>` by default; pass it a `render` prop to make a row an interactive link or button, which adds hover and cursor affordances.

## Example

<Story
 name='Default'
 storyModule={ItemStories}
/>

### Interactive

<Story
 name='Interactive'
 storyModule={ItemStories}
/>

### Group

<Story
 name='Group'
 storyModule={ItemStories}
/>

## Usage

```tsx
import { Avatar } from '@clerk/ui/mosaic/components/avatar';
import { Item } from '@clerk/ui/mosaic/components/item';

<Item.Group>
 <Item.Root render={({ children, ...props }) => <a {...props} href='/org'>{children}</a>}>
 <Item.Media>
 <Avatar.Root shape='square' size='md'>
 <Avatar.Image src={org.imageUrl} alt='' />
 <Avatar.Fallback>{org.name[0]}</Avatar.Fallback>
 </Avatar.Root>
 </Item.Media>
 <Item.Content>
 <Item.Title>Test Organization</Item.Title>
 <Item.Description>Member</Item.Description>
 </Item.Content>
 <Item.Actions>
 <Button variant='outline'>Manage</Button>
 </Item.Actions>
 </Item.Root>
</Item.Group>;
Comment thread
alexcarpenter marked this conversation as resolved.

```

## Parts

| Part | Class | Description |
| -------------------- | ------------------------ | -------------------------------------------------------------------- |
| `Item.Root` | `cl-item` | Root row. Renders a `<div>`, or a custom element via `render`. |
| `Item.Media` | `cl-item-media` | Leading (or trailing) media: icon, image, or avatar. |
| `Item.Content` | `cl-item-content` | Vertical stack that grows to fill the row between media and actions. |
| `Item.Title` | `cl-item-title` | Primary label. |
| `Item.Description` | `cl-item-description` | Secondary text. Renders a `<p>`. |
| `Item.Actions` | `cl-item-actions` | Trailing controls (buttons, badges). |
| `Item.Header` | `cl-item-header` | Header row above a group: a label with optional actions. |
| `Item.HeaderTitle` | `cl-item-header-title` | Label text within an `Item.Header`. |
| `Item.HeaderActions` | `cl-item-header-actions` | Trailing controls within an `Item.Header`. |
| `Item.Group` | `cl-item-group` | Vertical wrapper around a set of rows (layout only, no role). |
| `Item.Separator` | `cl-item-separator` | Thin divider (`<hr>`) between rows. |

Every part accepts a `render` prop for element polymorphism and forwards a ref.

## Styling

The root reflects its state as `data-*` attributes on `.cl-item`, so consumers can scope overrides without touching StyleX's hashed atoms:

| Prop | Attribute | Values | Default |
| --------- | ------------------ | ----------------------------------- | -------- |
| `variant` | `data-variant` | `entity` \| `action` | `entity` |
| `render` | `data-interactive` | present when a `render` is provided | — |

`variant` sets the row's vertical density (`entity` is standard, `action` is denser) and, on interactive rows, promotes the title color.

```css
/* Re-theme interactive rows */
.cl-item[data-interactive] {
 background-color: var(--cl-color-card);
}
```

`Item.Media` sizes to its child and centers it; its height follows the row. Bring your own icon, avatar, or image at whatever dimensions you need, then size the slot by sizing that child. Colors, radii, and spacing all resolve from the Mosaic tokens (`--cl-color-*`, `--cl-radius-*`, `--cl-spacing`).
Loading
Loading