Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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-card-owns-branding.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
Comment on lines +1 to +2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add a release entry for packages/ui.

This PR changes the exported CardProps API and Card.Root output. The empty changeset will not describe or schedule that package change. Add the appropriate package version and release note.

As per coding guidelines: “Use Changesets for version management and changelogs.” Based on learnings: empty changesets are acceptable for documentation-only or non-published changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/mosaic-card-owns-branding.md around lines 1 - 2, Add a Changesets
release entry in mosaic-card-owns-branding.md for packages/ui, specifying the
appropriate version bump for the exported CardProps and Card.Root changes and a
concise release note describing those API/output changes; do not leave the
changeset front matter empty.

Sources: Coding guidelines, Learnings

2 changes: 2 additions & 0 deletions packages/swingset/src/stories/card.component.stories.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,12 @@ export const meta: StoryMeta = {
_variants: {
alignment: { start: {}, center: {} },
elevation: { card: {}, flush: {}, overlay: {} },
renderBranding: { true: {}, false: {} },
},
_defaultVariants: {
alignment: 'start',
elevation: 'card',
renderBranding: true,
},
},
};
Expand Down
30 changes: 29 additions & 1 deletion packages/ui/src/mosaic/components/card/card.styles.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import * as stylex from '@stylexjs/stylex';

import { colorVars, radiusVars, space } from '../../tokens.stylex';
import { colorVars, radiusVars, space, typeScaleVars } from '../../tokens.stylex';

export const styles = stylex.create({
root: {
Expand DownExpand Up@@ -35,6 +35,34 @@ export const styles = stylex.create({
borderTopWidth: '1px',
width: '100%',
},
branding: {
paddingBlock: space['3'],
paddingInline: space['6'],
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
textAlign: 'center',
},
brandingText: {
color: colorVars['--cl-color-neutral-faded'],
display: 'inline-block',
fontSize: typeScaleVars['--cl-text-xs-size'],
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textWrap: 'pretty',
},
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
alignItems: 'center',
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
verticalAlign: 'top',
height: space['4'],
},
});

export const elevations = stylex.create({
Expand Down
33 changes: 33 additions & 0 deletions packages/ui/src/mosaic/components/card/card.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,39 @@ describe('Mosaic Card', () => {
expect(footerRef.current).toHaveClass('cl-card-footer');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('signs the card with Clerk, in a tab of its own', () => {
render(
<Card.Root data-testid='root'>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

// The mark closes the card out. Held by position rather than by a class: the branding
// carries no slot for a consumer to reach, so a test has none to reach for either.
const branding = screen.getByTestId('root').lastElementChild;
expect(branding).toHaveTextContent('Secured by');

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(branding).toContainElement(logo);
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, so the caller reading
// `displayConfig.branded` turns the signature off rather than the card assuming it.
it('withholds the branding where the caller turns it off', () => {
render(
<Card.Root renderBranding={false}>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
});

it('supports custom elements through render on every slot', () => {
render(
<Card.Root render={props => <section {...props} />}>
Expand Down
44 changes: 43 additions & 1 deletion packages/ui/src/mosaic/components/card/card.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import React from 'react';

import type { MosaicComponentProps } from '../../props';
import { mergeStyleProps, themeProps } from '../../props';
import { ClerkLogo } from '../clerk-logo';
import { reset } from '../reset.styles';
import { TextContext } from '../text';
import { elevations, headerAlignments, styles } from './card.styles';
Expand All@@ -19,16 +20,51 @@ const CardVariantContext = React.createContext<{ alignment: CardAlignment; eleva
elevation: DEFAULT_ELEVATION,
});

/** Signs the foot of the card with "Secured by Clerk". */
function Branding() {
return (
<div {...stylex.props(reset.base, styles.branding)}>
<span {...stylex.props(reset.base, styles.brandingText)}>
Secured by{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(reset.base, styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</span>
</div>
);
}

/** Props for `Card.Root`, including native `div` props and the Mosaic `render` escape hatch. */
export interface CardProps extends MosaicComponentProps<'div'> {
/** Alignment applied to `Card.Header`. @default 'start' */
alignment?: CardAlignment;
/** Surface treatment applied to the card. @default 'card' */
elevation?: CardElevation;
/**
* Signs the foot of the card with "Secured by Clerk". An instance that has paid the branding off
* carries none of it, so a connected surface passes `displayConfig.branded` here.
*
* @default true
*/
renderBranding?: boolean;
}

const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
{ alignment = DEFAULT_ALIGNMENT, elevation = DEFAULT_ELEVATION, render, className, style, ...rest },
{
alignment = DEFAULT_ALIGNMENT,
elevation = DEFAULT_ELEVATION,
renderBranding = true,
render,
className,
style,
children,
...rest
},
ref,
) {
const element = useRender({
Expand All@@ -43,6 +79,12 @@ const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
style,
),
...rest,
children: (
<>
{children}
{renderBranding ? <Branding /> : null}
</>
),
},
});

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -638,23 +638,16 @@ describe('UserButtonView, the foot', () => {
expect(screen.getByRole('link', { name: 'Support' })).toHaveAttribute('href', '/support');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('sends the branding logo to Clerk, in a tab of its own', () => {
renderView();
// The card owns the mark; the popup only carries the answer through. An instance that has paid
// the branding off carries none of it, the way every other Clerk surface reads
// `displayConfig.branded`.
it('signs the popup with Clerk, and withholds the mark where the instance carries none', () => {
const { unmount } = renderView();
expect(within(popup()).getByRole('link', { name: 'Clerk' })).toBeInTheDocument();

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, the way every other Clerk
// surface reads `displayConfig.branded`.
it('withholds the branding where the instance carries none', () => {
renderView({ branded: false });

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
unmount();
renderView({ renderBranding: false });
expect(within(popup()).queryByRole('link', { name: 'Clerk' })).toBeNull();
});

// "All accounts" is one account, and the account's own row already signs out of it.
Expand Down
3 changes: 0 additions & 3 deletions packages/ui/src/mosaic/user-button/user-button.messages.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,6 @@ export const userButtonBase = {
organization: 'Manage organization',
createOrganization: 'Create organization',
},
branding: {
securedBy: 'Secured by',
},
};

/** Substitutes `{name}`-style placeholders. Replaced by the localization layer's own formatter. */
Expand Down
27 changes: 0 additions & 27 deletions packages/ui/src/mosaic/user-button/user-button.styles.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,33 +48,6 @@ export const styles = stylex.create({
justifyContent: 'center',
width: space['7'],
},

branding: {
gap: space['2'],
paddingBlock: space['3'],
alignItems: 'center',
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
color: colorVars['--cl-color-neutral-faded'],
display: 'flex',
fontSize: typeScaleVars['--cl-text-xs-size'],
justifyContent: 'center',
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textAlign: 'center',
},

// Matches the trigger's ring, so the two focusable things the surface owns focus alike.
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
},
});

// The trigger takes the corner of the workspace mark it carries: round for a person, squared for
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/mosaic/user-button/user-button.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,7 +139,7 @@ export interface UserButtonBrandingProps {
*
* @default true
*/
branded?: boolean;
renderBranding?: boolean;
}

export interface UserButtonBusyState {
Expand Down
49 changes: 20 additions & 29 deletions packages/ui/src/mosaic/user-button/user-button.view.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ import { Avatar } from '../components/avatar';
import { Badge } from '../components/badge';
import { Button, SubmitButton } from '../components/button';
import { Card } from '../components/card';
import { ClerkLogo } from '../components/clerk-logo';
import { Icon } from '../components/icon';
import { Item } from '../components/item';
import { Menu } from '../components/menu';
Expand DownExpand Up@@ -832,7 +831,7 @@ function SessionSection() {
);
}

/** The actions that close out the surface, plus the Clerk attribution. */
/** The actions that close out the surface. */
function Footer() {
const data = useUserButtonContext();

Expand DownExpand Up@@ -881,34 +880,21 @@ function Footer() {
r => r.id,
);

if (actions.length === 0) {
return null;
}

return (
<>
{actions.length > 0 ? (
<>
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
) : null}
{data.branded === false ? null : (
<div {...stylex.props(styles.branding)}>
{m.branding.securedBy}{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</div>
)}
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
);
}
Expand DownExpand Up@@ -1014,10 +1000,15 @@ export function UserButtonTrigger({

/** The popover surface: header, organizations, other accounts, and footer. */
export function UserButtonPopup(): ReactElement {
const { renderBranding } = useUserButtonContext();

return (
<Popover.Popup aria-label={m.popup.label}>
{/* The card lays its children out with a row gap; the rows read as one continuous list. */}
<Card.Root style={{ rowGap: 0 }}>
<Card.Root
style={{ rowGap: 0 }}
renderBranding={renderBranding}
>
<Header />
<OrganizationSection />
<SessionSection />
Expand Down
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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-card-owns-branding.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
Comment on lines +1 to +2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add a release entry for packages/ui.

This PR changes the exported CardProps API and Card.Root output. The empty changeset will not describe or schedule that package change. Add the appropriate package version and release note.

As per coding guidelines: “Use Changesets for version management and changelogs.” Based on learnings: empty changesets are acceptable for documentation-only or non-published changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/mosaic-card-owns-branding.md around lines 1 - 2, Add a Changesets
release entry in mosaic-card-owns-branding.md for packages/ui, specifying the
appropriate version bump for the exported CardProps and Card.Root changes and a
concise release note describing those API/output changes; do not leave the
changeset front matter empty.

Sources: Coding guidelines, Learnings

2 changes: 2 additions & 0 deletions packages/swingset/src/stories/card.component.stories.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,12 @@ export const meta: StoryMeta = {
_variants: {
alignment: { start: {}, center: {} },
elevation: { card: {}, flush: {}, overlay: {} },
renderBranding: { true: {}, false: {} },
},
_defaultVariants: {
alignment: 'start',
elevation: 'card',
renderBranding: true,
},
},
};
Expand Down
30 changes: 29 additions & 1 deletion packages/ui/src/mosaic/components/card/card.styles.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import * as stylex from '@stylexjs/stylex';

import { colorVars, radiusVars, space } from '../../tokens.stylex';
import { colorVars, radiusVars, space, typeScaleVars } from '../../tokens.stylex';

export const styles = stylex.create({
root: {
Expand DownExpand Up@@ -35,6 +35,34 @@ export const styles = stylex.create({
borderTopWidth: '1px',
width: '100%',
},
branding: {
paddingBlock: space['3'],
paddingInline: space['6'],
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
textAlign: 'center',
},
brandingText: {
color: colorVars['--cl-color-neutral-faded'],
display: 'inline-block',
fontSize: typeScaleVars['--cl-text-xs-size'],
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textWrap: 'pretty',
},
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
alignItems: 'center',
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
verticalAlign: 'top',
height: space['4'],
},
});

export const elevations = stylex.create({
Expand Down
33 changes: 33 additions & 0 deletions packages/ui/src/mosaic/components/card/card.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,39 @@ describe('Mosaic Card', () => {
expect(footerRef.current).toHaveClass('cl-card-footer');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('signs the card with Clerk, in a tab of its own', () => {
render(
<Card.Root data-testid='root'>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

// The mark closes the card out. Held by position rather than by a class: the branding
// carries no slot for a consumer to reach, so a test has none to reach for either.
const branding = screen.getByTestId('root').lastElementChild;
expect(branding).toHaveTextContent('Secured by');

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(branding).toContainElement(logo);
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, so the caller reading
// `displayConfig.branded` turns the signature off rather than the card assuming it.
it('withholds the branding where the caller turns it off', () => {
render(
<Card.Root renderBranding={false}>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
});

it('supports custom elements through render on every slot', () => {
render(
<Card.Root render={props => <section {...props} />}>
Expand Down
44 changes: 43 additions & 1 deletion packages/ui/src/mosaic/components/card/card.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import React from 'react';

import type { MosaicComponentProps } from '../../props';
import { mergeStyleProps, themeProps } from '../../props';
import { ClerkLogo } from '../clerk-logo';
import { reset } from '../reset.styles';
import { TextContext } from '../text';
import { elevations, headerAlignments, styles } from './card.styles';
Expand All@@ -19,16 +20,51 @@ const CardVariantContext = React.createContext<{ alignment: CardAlignment; eleva
elevation: DEFAULT_ELEVATION,
});

/** Signs the foot of the card with "Secured by Clerk". */
function Branding() {
return (
<div {...stylex.props(reset.base, styles.branding)}>
<span {...stylex.props(reset.base, styles.brandingText)}>
Secured by{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(reset.base, styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</span>
</div>
);
}

/** Props for `Card.Root`, including native `div` props and the Mosaic `render` escape hatch. */
export interface CardProps extends MosaicComponentProps<'div'> {
/** Alignment applied to `Card.Header`. @default 'start' */
alignment?: CardAlignment;
/** Surface treatment applied to the card. @default 'card' */
elevation?: CardElevation;
/**
* Signs the foot of the card with "Secured by Clerk". An instance that has paid the branding off
* carries none of it, so a connected surface passes `displayConfig.branded` here.
*
* @default true
*/
renderBranding?: boolean;
}

const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
{ alignment = DEFAULT_ALIGNMENT, elevation = DEFAULT_ELEVATION, render, className, style, ...rest },
{
alignment = DEFAULT_ALIGNMENT,
elevation = DEFAULT_ELEVATION,
renderBranding = true,
render,
className,
style,
children,
...rest
},
ref,
) {
const element = useRender({
Expand All@@ -43,6 +79,12 @@ const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
style,
),
...rest,
children: (
<>
{children}
{renderBranding ? <Branding /> : null}
</>
),
},
});

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -638,23 +638,16 @@ describe('UserButtonView, the foot', () => {
expect(screen.getByRole('link', { name: 'Support' })).toHaveAttribute('href', '/support');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('sends the branding logo to Clerk, in a tab of its own', () => {
renderView();
// The card owns the mark; the popup only carries the answer through. An instance that has paid
// the branding off carries none of it, the way every other Clerk surface reads
// `displayConfig.branded`.
it('signs the popup with Clerk, and withholds the mark where the instance carries none', () => {
const { unmount } = renderView();
expect(within(popup()).getByRole('link', { name: 'Clerk' })).toBeInTheDocument();

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, the way every other Clerk
// surface reads `displayConfig.branded`.
it('withholds the branding where the instance carries none', () => {
renderView({ branded: false });

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
unmount();
renderView({ renderBranding: false });
expect(within(popup()).queryByRole('link', { name: 'Clerk' })).toBeNull();
});

// "All accounts" is one account, and the account's own row already signs out of it.
Expand Down
3 changes: 0 additions & 3 deletions packages/ui/src/mosaic/user-button/user-button.messages.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,6 @@ export const userButtonBase = {
organization: 'Manage organization',
createOrganization: 'Create organization',
},
branding: {
securedBy: 'Secured by',
},
};

/** Substitutes `{name}`-style placeholders. Replaced by the localization layer's own formatter. */
Expand Down
27 changes: 0 additions & 27 deletions packages/ui/src/mosaic/user-button/user-button.styles.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,33 +48,6 @@ export const styles = stylex.create({
justifyContent: 'center',
width: space['7'],
},

branding: {
gap: space['2'],
paddingBlock: space['3'],
alignItems: 'center',
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
color: colorVars['--cl-color-neutral-faded'],
display: 'flex',
fontSize: typeScaleVars['--cl-text-xs-size'],
justifyContent: 'center',
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textAlign: 'center',
},

// Matches the trigger's ring, so the two focusable things the surface owns focus alike.
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
},
});

// The trigger takes the corner of the workspace mark it carries: round for a person, squared for
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/mosaic/user-button/user-button.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,7 +139,7 @@ export interface UserButtonBrandingProps {
*
* @default true
*/
branded?: boolean;
renderBranding?: boolean;
}

export interface UserButtonBusyState {
Expand Down
49 changes: 20 additions & 29 deletions packages/ui/src/mosaic/user-button/user-button.view.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ import { Avatar } from '../components/avatar';
import { Badge } from '../components/badge';
import { Button, SubmitButton } from '../components/button';
import { Card } from '../components/card';
import { ClerkLogo } from '../components/clerk-logo';
import { Icon } from '../components/icon';
import { Item } from '../components/item';
import { Menu } from '../components/menu';
Expand DownExpand Up@@ -832,7 +831,7 @@ function SessionSection() {
);
}

/** The actions that close out the surface, plus the Clerk attribution. */
/** The actions that close out the surface. */
function Footer() {
const data = useUserButtonContext();

Expand DownExpand Up@@ -881,34 +880,21 @@ function Footer() {
r => r.id,
);

if (actions.length === 0) {
return null;
}

return (
<>
{actions.length > 0 ? (
<>
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
) : null}
{data.branded === false ? null : (
<div {...stylex.props(styles.branding)}>
{m.branding.securedBy}{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</div>
)}
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
);
}
Expand DownExpand Up@@ -1014,10 +1000,15 @@ export function UserButtonTrigger({

/** The popover surface: header, organizations, other accounts, and footer. */
export function UserButtonPopup(): ReactElement {
const { renderBranding } = useUserButtonContext();

return (
<Popover.Popup aria-label={m.popup.label}>
{/* The card lays its children out with a row gap; the rows read as one continuous list. */}
<Card.Root style={{ rowGap: 0 }}>
<Card.Root
style={{ rowGap: 0 }}
renderBranding={renderBranding}
>
<Header />
<OrganizationSection />
<SessionSection />
Expand Down
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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-card-owns-branding.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
Comment on lines +1 to +2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add a release entry for packages/ui.

This PR changes the exported CardProps API and Card.Root output. The empty changeset will not describe or schedule that package change. Add the appropriate package version and release note.

As per coding guidelines: “Use Changesets for version management and changelogs.” Based on learnings: empty changesets are acceptable for documentation-only or non-published changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/mosaic-card-owns-branding.md around lines 1 - 2, Add a Changesets
release entry in mosaic-card-owns-branding.md for packages/ui, specifying the
appropriate version bump for the exported CardProps and Card.Root changes and a
concise release note describing those API/output changes; do not leave the
changeset front matter empty.

Sources: Coding guidelines, Learnings

2 changes: 2 additions & 0 deletions packages/swingset/src/stories/card.component.stories.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,12 @@ export const meta: StoryMeta = {
_variants: {
alignment: { start: {}, center: {} },
elevation: { card: {}, flush: {}, overlay: {} },
renderBranding: { true: {}, false: {} },
},
_defaultVariants: {
alignment: 'start',
elevation: 'card',
renderBranding: true,
},
},
};
Expand Down
30 changes: 29 additions & 1 deletion packages/ui/src/mosaic/components/card/card.styles.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import * as stylex from '@stylexjs/stylex';

import { colorVars, radiusVars, space } from '../../tokens.stylex';
import { colorVars, radiusVars, space, typeScaleVars } from '../../tokens.stylex';

export const styles = stylex.create({
root: {
Expand DownExpand Up@@ -35,6 +35,34 @@ export const styles = stylex.create({
borderTopWidth: '1px',
width: '100%',
},
branding: {
paddingBlock: space['3'],
paddingInline: space['6'],
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
textAlign: 'center',
},
brandingText: {
color: colorVars['--cl-color-neutral-faded'],
display: 'inline-block',
fontSize: typeScaleVars['--cl-text-xs-size'],
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textWrap: 'pretty',
},
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
alignItems: 'center',
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
verticalAlign: 'top',
height: space['4'],
},
});

export const elevations = stylex.create({
Expand Down
33 changes: 33 additions & 0 deletions packages/ui/src/mosaic/components/card/card.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,39 @@ describe('Mosaic Card', () => {
expect(footerRef.current).toHaveClass('cl-card-footer');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('signs the card with Clerk, in a tab of its own', () => {
render(
<Card.Root data-testid='root'>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

// The mark closes the card out. Held by position rather than by a class: the branding
// carries no slot for a consumer to reach, so a test has none to reach for either.
const branding = screen.getByTestId('root').lastElementChild;
expect(branding).toHaveTextContent('Secured by');

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(branding).toContainElement(logo);
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, so the caller reading
// `displayConfig.branded` turns the signature off rather than the card assuming it.
it('withholds the branding where the caller turns it off', () => {
render(
<Card.Root renderBranding={false}>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
});

it('supports custom elements through render on every slot', () => {
render(
<Card.Root render={props => <section {...props} />}>
Expand Down
44 changes: 43 additions & 1 deletion packages/ui/src/mosaic/components/card/card.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import React from 'react';

import type { MosaicComponentProps } from '../../props';
import { mergeStyleProps, themeProps } from '../../props';
import { ClerkLogo } from '../clerk-logo';
import { reset } from '../reset.styles';
import { TextContext } from '../text';
import { elevations, headerAlignments, styles } from './card.styles';
Expand All@@ -19,16 +20,51 @@ const CardVariantContext = React.createContext<{ alignment: CardAlignment; eleva
elevation: DEFAULT_ELEVATION,
});

/** Signs the foot of the card with "Secured by Clerk". */
function Branding() {
return (
<div {...stylex.props(reset.base, styles.branding)}>
<span {...stylex.props(reset.base, styles.brandingText)}>
Secured by{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(reset.base, styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</span>
</div>
);
}

/** Props for `Card.Root`, including native `div` props and the Mosaic `render` escape hatch. */
export interface CardProps extends MosaicComponentProps<'div'> {
/** Alignment applied to `Card.Header`. @default 'start' */
alignment?: CardAlignment;
/** Surface treatment applied to the card. @default 'card' */
elevation?: CardElevation;
/**
* Signs the foot of the card with "Secured by Clerk". An instance that has paid the branding off
* carries none of it, so a connected surface passes `displayConfig.branded` here.
*
* @default true
*/
renderBranding?: boolean;
}

const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
{ alignment = DEFAULT_ALIGNMENT, elevation = DEFAULT_ELEVATION, render, className, style, ...rest },
{
alignment = DEFAULT_ALIGNMENT,
elevation = DEFAULT_ELEVATION,
renderBranding = true,
render,
className,
style,
children,
...rest
},
ref,
) {
const element = useRender({
Expand All@@ -43,6 +79,12 @@ const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
style,
),
...rest,
children: (
<>
{children}
{renderBranding ? <Branding /> : null}
</>
),
},
});

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -638,23 +638,16 @@ describe('UserButtonView, the foot', () => {
expect(screen.getByRole('link', { name: 'Support' })).toHaveAttribute('href', '/support');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('sends the branding logo to Clerk, in a tab of its own', () => {
renderView();
// The card owns the mark; the popup only carries the answer through. An instance that has paid
// the branding off carries none of it, the way every other Clerk surface reads
// `displayConfig.branded`.
it('signs the popup with Clerk, and withholds the mark where the instance carries none', () => {
const { unmount } = renderView();
expect(within(popup()).getByRole('link', { name: 'Clerk' })).toBeInTheDocument();

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, the way every other Clerk
// surface reads `displayConfig.branded`.
it('withholds the branding where the instance carries none', () => {
renderView({ branded: false });

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
unmount();
renderView({ renderBranding: false });
expect(within(popup()).queryByRole('link', { name: 'Clerk' })).toBeNull();
});

// "All accounts" is one account, and the account's own row already signs out of it.
Expand Down
3 changes: 0 additions & 3 deletions packages/ui/src/mosaic/user-button/user-button.messages.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,6 @@ export const userButtonBase = {
organization: 'Manage organization',
createOrganization: 'Create organization',
},
branding: {
securedBy: 'Secured by',
},
};

/** Substitutes `{name}`-style placeholders. Replaced by the localization layer's own formatter. */
Expand Down
27 changes: 0 additions & 27 deletions packages/ui/src/mosaic/user-button/user-button.styles.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,33 +48,6 @@ export const styles = stylex.create({
justifyContent: 'center',
width: space['7'],
},

branding: {
gap: space['2'],
paddingBlock: space['3'],
alignItems: 'center',
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
color: colorVars['--cl-color-neutral-faded'],
display: 'flex',
fontSize: typeScaleVars['--cl-text-xs-size'],
justifyContent: 'center',
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textAlign: 'center',
},

// Matches the trigger's ring, so the two focusable things the surface owns focus alike.
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
},
});

// The trigger takes the corner of the workspace mark it carries: round for a person, squared for
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/mosaic/user-button/user-button.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,7 +139,7 @@ export interface UserButtonBrandingProps {
*
* @default true
*/
branded?: boolean;
renderBranding?: boolean;
}

export interface UserButtonBusyState {
Expand Down
49 changes: 20 additions & 29 deletions packages/ui/src/mosaic/user-button/user-button.view.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ import { Avatar } from '../components/avatar';
import { Badge } from '../components/badge';
import { Button, SubmitButton } from '../components/button';
import { Card } from '../components/card';
import { ClerkLogo } from '../components/clerk-logo';
import { Icon } from '../components/icon';
import { Item } from '../components/item';
import { Menu } from '../components/menu';
Expand DownExpand Up@@ -832,7 +831,7 @@ function SessionSection() {
);
}

/** The actions that close out the surface, plus the Clerk attribution. */
/** The actions that close out the surface. */
function Footer() {
const data = useUserButtonContext();

Expand DownExpand Up@@ -881,34 +880,21 @@ function Footer() {
r => r.id,
);

if (actions.length === 0) {
return null;
}

return (
<>
{actions.length > 0 ? (
<>
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
) : null}
{data.branded === false ? null : (
<div {...stylex.props(styles.branding)}>
{m.branding.securedBy}{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</div>
)}
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
);
}
Expand DownExpand Up@@ -1014,10 +1000,15 @@ export function UserButtonTrigger({

/** The popover surface: header, organizations, other accounts, and footer. */
export function UserButtonPopup(): ReactElement {
const { renderBranding } = useUserButtonContext();

return (
<Popover.Popup aria-label={m.popup.label}>
{/* The card lays its children out with a row gap; the rows read as one continuous list. */}
<Card.Root style={{ rowGap: 0 }}>
<Card.Root
style={{ rowGap: 0 }}
renderBranding={renderBranding}
>
<Header />
<OrganizationSection />
<SessionSection />
Expand Down
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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-card-owns-branding.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
Comment on lines +1 to +2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add a release entry for packages/ui.

This PR changes the exported CardProps API and Card.Root output. The empty changeset will not describe or schedule that package change. Add the appropriate package version and release note.

As per coding guidelines: “Use Changesets for version management and changelogs.” Based on learnings: empty changesets are acceptable for documentation-only or non-published changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/mosaic-card-owns-branding.md around lines 1 - 2, Add a Changesets
release entry in mosaic-card-owns-branding.md for packages/ui, specifying the
appropriate version bump for the exported CardProps and Card.Root changes and a
concise release note describing those API/output changes; do not leave the
changeset front matter empty.

Sources: Coding guidelines, Learnings

2 changes: 2 additions & 0 deletions packages/swingset/src/stories/card.component.stories.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,12 @@ export const meta: StoryMeta = {
_variants: {
alignment: { start: {}, center: {} },
elevation: { card: {}, flush: {}, overlay: {} },
renderBranding: { true: {}, false: {} },
},
_defaultVariants: {
alignment: 'start',
elevation: 'card',
renderBranding: true,
},
},
};
Expand Down
30 changes: 29 additions & 1 deletion packages/ui/src/mosaic/components/card/card.styles.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import * as stylex from '@stylexjs/stylex';

import { colorVars, radiusVars, space } from '../../tokens.stylex';
import { colorVars, radiusVars, space, typeScaleVars } from '../../tokens.stylex';

export const styles = stylex.create({
root: {
Expand DownExpand Up@@ -35,6 +35,34 @@ export const styles = stylex.create({
borderTopWidth: '1px',
width: '100%',
},
branding: {
paddingBlock: space['3'],
paddingInline: space['6'],
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
textAlign: 'center',
},
brandingText: {
color: colorVars['--cl-color-neutral-faded'],
display: 'inline-block',
fontSize: typeScaleVars['--cl-text-xs-size'],
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textWrap: 'pretty',
},
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
alignItems: 'center',
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
verticalAlign: 'top',
height: space['4'],
},
});

export const elevations = stylex.create({
Expand Down
33 changes: 33 additions & 0 deletions packages/ui/src/mosaic/components/card/card.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,39 @@ describe('Mosaic Card', () => {
expect(footerRef.current).toHaveClass('cl-card-footer');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('signs the card with Clerk, in a tab of its own', () => {
render(
<Card.Root data-testid='root'>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

// The mark closes the card out. Held by position rather than by a class: the branding
// carries no slot for a consumer to reach, so a test has none to reach for either.
const branding = screen.getByTestId('root').lastElementChild;
expect(branding).toHaveTextContent('Secured by');

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(branding).toContainElement(logo);
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, so the caller reading
// `displayConfig.branded` turns the signature off rather than the card assuming it.
it('withholds the branding where the caller turns it off', () => {
render(
<Card.Root renderBranding={false}>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
});

it('supports custom elements through render on every slot', () => {
render(
<Card.Root render={props => <section {...props} />}>
Expand Down
44 changes: 43 additions & 1 deletion packages/ui/src/mosaic/components/card/card.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import React from 'react';

import type { MosaicComponentProps } from '../../props';
import { mergeStyleProps, themeProps } from '../../props';
import { ClerkLogo } from '../clerk-logo';
import { reset } from '../reset.styles';
import { TextContext } from '../text';
import { elevations, headerAlignments, styles } from './card.styles';
Expand All@@ -19,16 +20,51 @@ const CardVariantContext = React.createContext<{ alignment: CardAlignment; eleva
elevation: DEFAULT_ELEVATION,
});

/** Signs the foot of the card with "Secured by Clerk". */
function Branding() {
return (
<div {...stylex.props(reset.base, styles.branding)}>
<span {...stylex.props(reset.base, styles.brandingText)}>
Secured by{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(reset.base, styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</span>
</div>
);
}

/** Props for `Card.Root`, including native `div` props and the Mosaic `render` escape hatch. */
export interface CardProps extends MosaicComponentProps<'div'> {
/** Alignment applied to `Card.Header`. @default 'start' */
alignment?: CardAlignment;
/** Surface treatment applied to the card. @default 'card' */
elevation?: CardElevation;
/**
* Signs the foot of the card with "Secured by Clerk". An instance that has paid the branding off
* carries none of it, so a connected surface passes `displayConfig.branded` here.
*
* @default true
*/
renderBranding?: boolean;
}

const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
{ alignment = DEFAULT_ALIGNMENT, elevation = DEFAULT_ELEVATION, render, className, style, ...rest },
{
alignment = DEFAULT_ALIGNMENT,
elevation = DEFAULT_ELEVATION,
renderBranding = true,
render,
className,
style,
children,
...rest
},
ref,
) {
const element = useRender({
Expand All@@ -43,6 +79,12 @@ const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
style,
),
...rest,
children: (
<>
{children}
{renderBranding ? <Branding /> : null}
</>
),
},
});

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -638,23 +638,16 @@ describe('UserButtonView, the foot', () => {
expect(screen.getByRole('link', { name: 'Support' })).toHaveAttribute('href', '/support');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('sends the branding logo to Clerk, in a tab of its own', () => {
renderView();
// The card owns the mark; the popup only carries the answer through. An instance that has paid
// the branding off carries none of it, the way every other Clerk surface reads
// `displayConfig.branded`.
it('signs the popup with Clerk, and withholds the mark where the instance carries none', () => {
const { unmount } = renderView();
expect(within(popup()).getByRole('link', { name: 'Clerk' })).toBeInTheDocument();

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, the way every other Clerk
// surface reads `displayConfig.branded`.
it('withholds the branding where the instance carries none', () => {
renderView({ branded: false });

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
unmount();
renderView({ renderBranding: false });
expect(within(popup()).queryByRole('link', { name: 'Clerk' })).toBeNull();
});

// "All accounts" is one account, and the account's own row already signs out of it.
Expand Down
3 changes: 0 additions & 3 deletions packages/ui/src/mosaic/user-button/user-button.messages.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,6 @@ export const userButtonBase = {
organization: 'Manage organization',
createOrganization: 'Create organization',
},
branding: {
securedBy: 'Secured by',
},
};

/** Substitutes `{name}`-style placeholders. Replaced by the localization layer's own formatter. */
Expand Down
27 changes: 0 additions & 27 deletions packages/ui/src/mosaic/user-button/user-button.styles.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,33 +48,6 @@ export const styles = stylex.create({
justifyContent: 'center',
width: space['7'],
},

branding: {
gap: space['2'],
paddingBlock: space['3'],
alignItems: 'center',
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
color: colorVars['--cl-color-neutral-faded'],
display: 'flex',
fontSize: typeScaleVars['--cl-text-xs-size'],
justifyContent: 'center',
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textAlign: 'center',
},

// Matches the trigger's ring, so the two focusable things the surface owns focus alike.
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
},
});

// The trigger takes the corner of the workspace mark it carries: round for a person, squared for
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/mosaic/user-button/user-button.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,7 +139,7 @@ export interface UserButtonBrandingProps {
*
* @default true
*/
branded?: boolean;
renderBranding?: boolean;
}

export interface UserButtonBusyState {
Expand Down
49 changes: 20 additions & 29 deletions packages/ui/src/mosaic/user-button/user-button.view.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ import { Avatar } from '../components/avatar';
import { Badge } from '../components/badge';
import { Button, SubmitButton } from '../components/button';
import { Card } from '../components/card';
import { ClerkLogo } from '../components/clerk-logo';
import { Icon } from '../components/icon';
import { Item } from '../components/item';
import { Menu } from '../components/menu';
Expand DownExpand Up@@ -832,7 +831,7 @@ function SessionSection() {
);
}

/** The actions that close out the surface, plus the Clerk attribution. */
/** The actions that close out the surface. */
function Footer() {
const data = useUserButtonContext();

Expand DownExpand Up@@ -881,34 +880,21 @@ function Footer() {
r => r.id,
);

if (actions.length === 0) {
return null;
}

return (
<>
{actions.length > 0 ? (
<>
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
) : null}
{data.branded === false ? null : (
<div {...stylex.props(styles.branding)}>
{m.branding.securedBy}{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</div>
)}
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
);
}
Expand DownExpand Up@@ -1014,10 +1000,15 @@ export function UserButtonTrigger({

/** The popover surface: header, organizations, other accounts, and footer. */
export function UserButtonPopup(): ReactElement {
const { renderBranding } = useUserButtonContext();

return (
<Popover.Popup aria-label={m.popup.label}>
{/* The card lays its children out with a row gap; the rows read as one continuous list. */}
<Card.Root style={{ rowGap: 0 }}>
<Card.Root
style={{ rowGap: 0 }}
renderBranding={renderBranding}
>
<Header />
<OrganizationSection />
<SessionSection />
Expand Down
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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-card-owns-branding.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
Comment on lines +1 to +2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add a release entry for packages/ui.

This PR changes the exported CardProps API and Card.Root output. The empty changeset will not describe or schedule that package change. Add the appropriate package version and release note.

As per coding guidelines: “Use Changesets for version management and changelogs.” Based on learnings: empty changesets are acceptable for documentation-only or non-published changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/mosaic-card-owns-branding.md around lines 1 - 2, Add a Changesets
release entry in mosaic-card-owns-branding.md for packages/ui, specifying the
appropriate version bump for the exported CardProps and Card.Root changes and a
concise release note describing those API/output changes; do not leave the
changeset front matter empty.

Sources: Coding guidelines, Learnings

2 changes: 2 additions & 0 deletions packages/swingset/src/stories/card.component.stories.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,12 @@ export const meta: StoryMeta = {
_variants: {
alignment: { start: {}, center: {} },
elevation: { card: {}, flush: {}, overlay: {} },
renderBranding: { true: {}, false: {} },
},
_defaultVariants: {
alignment: 'start',
elevation: 'card',
renderBranding: true,
},
},
};
Expand Down
30 changes: 29 additions & 1 deletion packages/ui/src/mosaic/components/card/card.styles.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import * as stylex from '@stylexjs/stylex';

import { colorVars, radiusVars, space } from '../../tokens.stylex';
import { colorVars, radiusVars, space, typeScaleVars } from '../../tokens.stylex';

export const styles = stylex.create({
root: {
Expand DownExpand Up@@ -35,6 +35,34 @@ export const styles = stylex.create({
borderTopWidth: '1px',
width: '100%',
},
branding: {
paddingBlock: space['3'],
paddingInline: space['6'],
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
textAlign: 'center',
},
brandingText: {
color: colorVars['--cl-color-neutral-faded'],
display: 'inline-block',
fontSize: typeScaleVars['--cl-text-xs-size'],
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textWrap: 'pretty',
},
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
alignItems: 'center',
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
verticalAlign: 'top',
height: space['4'],
},
});

export const elevations = stylex.create({
Expand Down
33 changes: 33 additions & 0 deletions packages/ui/src/mosaic/components/card/card.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,39 @@ describe('Mosaic Card', () => {
expect(footerRef.current).toHaveClass('cl-card-footer');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('signs the card with Clerk, in a tab of its own', () => {
render(
<Card.Root data-testid='root'>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

// The mark closes the card out. Held by position rather than by a class: the branding
// carries no slot for a consumer to reach, so a test has none to reach for either.
const branding = screen.getByTestId('root').lastElementChild;
expect(branding).toHaveTextContent('Secured by');

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(branding).toContainElement(logo);
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, so the caller reading
// `displayConfig.branded` turns the signature off rather than the card assuming it.
it('withholds the branding where the caller turns it off', () => {
render(
<Card.Root renderBranding={false}>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
});

it('supports custom elements through render on every slot', () => {
render(
<Card.Root render={props => <section {...props} />}>
Expand Down
44 changes: 43 additions & 1 deletion packages/ui/src/mosaic/components/card/card.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import React from 'react';

import type { MosaicComponentProps } from '../../props';
import { mergeStyleProps, themeProps } from '../../props';
import { ClerkLogo } from '../clerk-logo';
import { reset } from '../reset.styles';
import { TextContext } from '../text';
import { elevations, headerAlignments, styles } from './card.styles';
Expand All@@ -19,16 +20,51 @@ const CardVariantContext = React.createContext<{ alignment: CardAlignment; eleva
elevation: DEFAULT_ELEVATION,
});

/** Signs the foot of the card with "Secured by Clerk". */
function Branding() {
return (
<div {...stylex.props(reset.base, styles.branding)}>
<span {...stylex.props(reset.base, styles.brandingText)}>
Secured by{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(reset.base, styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</span>
</div>
);
}

/** Props for `Card.Root`, including native `div` props and the Mosaic `render` escape hatch. */
export interface CardProps extends MosaicComponentProps<'div'> {
/** Alignment applied to `Card.Header`. @default 'start' */
alignment?: CardAlignment;
/** Surface treatment applied to the card. @default 'card' */
elevation?: CardElevation;
/**
* Signs the foot of the card with "Secured by Clerk". An instance that has paid the branding off
* carries none of it, so a connected surface passes `displayConfig.branded` here.
*
* @default true
*/
renderBranding?: boolean;
}

const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
{ alignment = DEFAULT_ALIGNMENT, elevation = DEFAULT_ELEVATION, render, className, style, ...rest },
{
alignment = DEFAULT_ALIGNMENT,
elevation = DEFAULT_ELEVATION,
renderBranding = true,
render,
className,
style,
children,
...rest
},
ref,
) {
const element = useRender({
Expand All@@ -43,6 +79,12 @@ const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
style,
),
...rest,
children: (
<>
{children}
{renderBranding ? <Branding /> : null}
</>
),
},
});

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -638,23 +638,16 @@ describe('UserButtonView, the foot', () => {
expect(screen.getByRole('link', { name: 'Support' })).toHaveAttribute('href', '/support');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('sends the branding logo to Clerk, in a tab of its own', () => {
renderView();
// The card owns the mark; the popup only carries the answer through. An instance that has paid
// the branding off carries none of it, the way every other Clerk surface reads
// `displayConfig.branded`.
it('signs the popup with Clerk, and withholds the mark where the instance carries none', () => {
const { unmount } = renderView();
expect(within(popup()).getByRole('link', { name: 'Clerk' })).toBeInTheDocument();

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, the way every other Clerk
// surface reads `displayConfig.branded`.
it('withholds the branding where the instance carries none', () => {
renderView({ branded: false });

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
unmount();
renderView({ renderBranding: false });
expect(within(popup()).queryByRole('link', { name: 'Clerk' })).toBeNull();
});

// "All accounts" is one account, and the account's own row already signs out of it.
Expand Down
3 changes: 0 additions & 3 deletions packages/ui/src/mosaic/user-button/user-button.messages.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,6 @@ export const userButtonBase = {
organization: 'Manage organization',
createOrganization: 'Create organization',
},
branding: {
securedBy: 'Secured by',
},
};

/** Substitutes `{name}`-style placeholders. Replaced by the localization layer's own formatter. */
Expand Down
27 changes: 0 additions & 27 deletions packages/ui/src/mosaic/user-button/user-button.styles.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,33 +48,6 @@ export const styles = stylex.create({
justifyContent: 'center',
width: space['7'],
},

branding: {
gap: space['2'],
paddingBlock: space['3'],
alignItems: 'center',
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
color: colorVars['--cl-color-neutral-faded'],
display: 'flex',
fontSize: typeScaleVars['--cl-text-xs-size'],
justifyContent: 'center',
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textAlign: 'center',
},

// Matches the trigger's ring, so the two focusable things the surface owns focus alike.
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
},
});

// The trigger takes the corner of the workspace mark it carries: round for a person, squared for
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/mosaic/user-button/user-button.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,7 +139,7 @@ export interface UserButtonBrandingProps {
*
* @default true
*/
branded?: boolean;
renderBranding?: boolean;
}

export interface UserButtonBusyState {
Expand Down
49 changes: 20 additions & 29 deletions packages/ui/src/mosaic/user-button/user-button.view.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ import { Avatar } from '../components/avatar';
import { Badge } from '../components/badge';
import { Button, SubmitButton } from '../components/button';
import { Card } from '../components/card';
import { ClerkLogo } from '../components/clerk-logo';
import { Icon } from '../components/icon';
import { Item } from '../components/item';
import { Menu } from '../components/menu';
Expand DownExpand Up@@ -832,7 +831,7 @@ function SessionSection() {
);
}

/** The actions that close out the surface, plus the Clerk attribution. */
/** The actions that close out the surface. */
function Footer() {
const data = useUserButtonContext();

Expand DownExpand Up@@ -881,34 +880,21 @@ function Footer() {
r => r.id,
);

if (actions.length === 0) {
return null;
}

return (
<>
{actions.length > 0 ? (
<>
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
) : null}
{data.branded === false ? null : (
<div {...stylex.props(styles.branding)}>
{m.branding.securedBy}{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</div>
)}
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
);
}
Expand DownExpand Up@@ -1014,10 +1000,15 @@ export function UserButtonTrigger({

/** The popover surface: header, organizations, other accounts, and footer. */
export function UserButtonPopup(): ReactElement {
const { renderBranding } = useUserButtonContext();

return (
<Popover.Popup aria-label={m.popup.label}>
{/* The card lays its children out with a row gap; the rows read as one continuous list. */}
<Card.Root style={{ rowGap: 0 }}>
<Card.Root
style={{ rowGap: 0 }}
renderBranding={renderBranding}
>
<Header />
<OrganizationSection />
<SessionSection />
Expand Down
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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-card-owns-branding.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
Comment on lines +1 to +2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add a release entry for packages/ui.

This PR changes the exported CardProps API and Card.Root output. The empty changeset will not describe or schedule that package change. Add the appropriate package version and release note.

As per coding guidelines: “Use Changesets for version management and changelogs.” Based on learnings: empty changesets are acceptable for documentation-only or non-published changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/mosaic-card-owns-branding.md around lines 1 - 2, Add a Changesets
release entry in mosaic-card-owns-branding.md for packages/ui, specifying the
appropriate version bump for the exported CardProps and Card.Root changes and a
concise release note describing those API/output changes; do not leave the
changeset front matter empty.

Sources: Coding guidelines, Learnings

2 changes: 2 additions & 0 deletions packages/swingset/src/stories/card.component.stories.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,12 @@ export const meta: StoryMeta = {
_variants: {
alignment: { start: {}, center: {} },
elevation: { card: {}, flush: {}, overlay: {} },
renderBranding: { true: {}, false: {} },
},
_defaultVariants: {
alignment: 'start',
elevation: 'card',
renderBranding: true,
},
},
};
Expand Down
30 changes: 29 additions & 1 deletion packages/ui/src/mosaic/components/card/card.styles.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import * as stylex from '@stylexjs/stylex';

import { colorVars, radiusVars, space } from '../../tokens.stylex';
import { colorVars, radiusVars, space, typeScaleVars } from '../../tokens.stylex';

export const styles = stylex.create({
root: {
Expand DownExpand Up@@ -35,6 +35,34 @@ export const styles = stylex.create({
borderTopWidth: '1px',
width: '100%',
},
branding: {
paddingBlock: space['3'],
paddingInline: space['6'],
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
textAlign: 'center',
},
brandingText: {
color: colorVars['--cl-color-neutral-faded'],
display: 'inline-block',
fontSize: typeScaleVars['--cl-text-xs-size'],
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textWrap: 'pretty',
},
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
alignItems: 'center',
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
verticalAlign: 'top',
height: space['4'],
},
});

export const elevations = stylex.create({
Expand Down
33 changes: 33 additions & 0 deletions packages/ui/src/mosaic/components/card/card.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,39 @@ describe('Mosaic Card', () => {
expect(footerRef.current).toHaveClass('cl-card-footer');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('signs the card with Clerk, in a tab of its own', () => {
render(
<Card.Root data-testid='root'>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

// The mark closes the card out. Held by position rather than by a class: the branding
// carries no slot for a consumer to reach, so a test has none to reach for either.
const branding = screen.getByTestId('root').lastElementChild;
expect(branding).toHaveTextContent('Secured by');

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(branding).toContainElement(logo);
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, so the caller reading
// `displayConfig.branded` turns the signature off rather than the card assuming it.
it('withholds the branding where the caller turns it off', () => {
render(
<Card.Root renderBranding={false}>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
});

it('supports custom elements through render on every slot', () => {
render(
<Card.Root render={props => <section {...props} />}>
Expand Down
44 changes: 43 additions & 1 deletion packages/ui/src/mosaic/components/card/card.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import React from 'react';

import type { MosaicComponentProps } from '../../props';
import { mergeStyleProps, themeProps } from '../../props';
import { ClerkLogo } from '../clerk-logo';
import { reset } from '../reset.styles';
import { TextContext } from '../text';
import { elevations, headerAlignments, styles } from './card.styles';
Expand All@@ -19,16 +20,51 @@ const CardVariantContext = React.createContext<{ alignment: CardAlignment; eleva
elevation: DEFAULT_ELEVATION,
});

/** Signs the foot of the card with "Secured by Clerk". */
function Branding() {
return (
<div {...stylex.props(reset.base, styles.branding)}>
<span {...stylex.props(reset.base, styles.brandingText)}>
Secured by{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(reset.base, styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</span>
</div>
);
}

/** Props for `Card.Root`, including native `div` props and the Mosaic `render` escape hatch. */
export interface CardProps extends MosaicComponentProps<'div'> {
/** Alignment applied to `Card.Header`. @default 'start' */
alignment?: CardAlignment;
/** Surface treatment applied to the card. @default 'card' */
elevation?: CardElevation;
/**
* Signs the foot of the card with "Secured by Clerk". An instance that has paid the branding off
* carries none of it, so a connected surface passes `displayConfig.branded` here.
*
* @default true
*/
renderBranding?: boolean;
}

const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
{ alignment = DEFAULT_ALIGNMENT, elevation = DEFAULT_ELEVATION, render, className, style, ...rest },
{
alignment = DEFAULT_ALIGNMENT,
elevation = DEFAULT_ELEVATION,
renderBranding = true,
render,
className,
style,
children,
...rest
},
ref,
) {
const element = useRender({
Expand All@@ -43,6 +79,12 @@ const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
style,
),
...rest,
children: (
<>
{children}
{renderBranding ? <Branding /> : null}
</>
),
},
});

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -638,23 +638,16 @@ describe('UserButtonView, the foot', () => {
expect(screen.getByRole('link', { name: 'Support' })).toHaveAttribute('href', '/support');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('sends the branding logo to Clerk, in a tab of its own', () => {
renderView();
// The card owns the mark; the popup only carries the answer through. An instance that has paid
// the branding off carries none of it, the way every other Clerk surface reads
// `displayConfig.branded`.
it('signs the popup with Clerk, and withholds the mark where the instance carries none', () => {
const { unmount } = renderView();
expect(within(popup()).getByRole('link', { name: 'Clerk' })).toBeInTheDocument();

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, the way every other Clerk
// surface reads `displayConfig.branded`.
it('withholds the branding where the instance carries none', () => {
renderView({ branded: false });

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
unmount();
renderView({ renderBranding: false });
expect(within(popup()).queryByRole('link', { name: 'Clerk' })).toBeNull();
});

// "All accounts" is one account, and the account's own row already signs out of it.
Expand Down
3 changes: 0 additions & 3 deletions packages/ui/src/mosaic/user-button/user-button.messages.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,6 @@ export const userButtonBase = {
organization: 'Manage organization',
createOrganization: 'Create organization',
},
branding: {
securedBy: 'Secured by',
},
};

/** Substitutes `{name}`-style placeholders. Replaced by the localization layer's own formatter. */
Expand Down
27 changes: 0 additions & 27 deletions packages/ui/src/mosaic/user-button/user-button.styles.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,33 +48,6 @@ export const styles = stylex.create({
justifyContent: 'center',
width: space['7'],
},

branding: {
gap: space['2'],
paddingBlock: space['3'],
alignItems: 'center',
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
color: colorVars['--cl-color-neutral-faded'],
display: 'flex',
fontSize: typeScaleVars['--cl-text-xs-size'],
justifyContent: 'center',
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textAlign: 'center',
},

// Matches the trigger's ring, so the two focusable things the surface owns focus alike.
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
},
});

// The trigger takes the corner of the workspace mark it carries: round for a person, squared for
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/mosaic/user-button/user-button.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,7 +139,7 @@ export interface UserButtonBrandingProps {
*
* @default true
*/
branded?: boolean;
renderBranding?: boolean;
}

export interface UserButtonBusyState {
Expand Down
49 changes: 20 additions & 29 deletions packages/ui/src/mosaic/user-button/user-button.view.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ import { Avatar } from '../components/avatar';
import { Badge } from '../components/badge';
import { Button, SubmitButton } from '../components/button';
import { Card } from '../components/card';
import { ClerkLogo } from '../components/clerk-logo';
import { Icon } from '../components/icon';
import { Item } from '../components/item';
import { Menu } from '../components/menu';
Expand DownExpand Up@@ -832,7 +831,7 @@ function SessionSection() {
);
}

/** The actions that close out the surface, plus the Clerk attribution. */
/** The actions that close out the surface. */
function Footer() {
const data = useUserButtonContext();

Expand DownExpand Up@@ -881,34 +880,21 @@ function Footer() {
r => r.id,
);

if (actions.length === 0) {
return null;
}

return (
<>
{actions.length > 0 ? (
<>
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
) : null}
{data.branded === false ? null : (
<div {...stylex.props(styles.branding)}>
{m.branding.securedBy}{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</div>
)}
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
);
}
Expand DownExpand Up@@ -1014,10 +1000,15 @@ export function UserButtonTrigger({

/** The popover surface: header, organizations, other accounts, and footer. */
export function UserButtonPopup(): ReactElement {
const { renderBranding } = useUserButtonContext();

return (
<Popover.Popup aria-label={m.popup.label}>
{/* The card lays its children out with a row gap; the rows read as one continuous list. */}
<Card.Root style={{ rowGap: 0 }}>
<Card.Root
style={{ rowGap: 0 }}
renderBranding={renderBranding}
>
<Header />
<OrganizationSection />
<SessionSection />
Expand Down
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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-card-owns-branding.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
Comment on lines +1 to +2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add a release entry for packages/ui.

This PR changes the exported CardProps API and Card.Root output. The empty changeset will not describe or schedule that package change. Add the appropriate package version and release note.

As per coding guidelines: “Use Changesets for version management and changelogs.” Based on learnings: empty changesets are acceptable for documentation-only or non-published changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/mosaic-card-owns-branding.md around lines 1 - 2, Add a Changesets
release entry in mosaic-card-owns-branding.md for packages/ui, specifying the
appropriate version bump for the exported CardProps and Card.Root changes and a
concise release note describing those API/output changes; do not leave the
changeset front matter empty.

Sources: Coding guidelines, Learnings

2 changes: 2 additions & 0 deletions packages/swingset/src/stories/card.component.stories.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,12 @@ export const meta: StoryMeta = {
_variants: {
alignment: { start: {}, center: {} },
elevation: { card: {}, flush: {}, overlay: {} },
renderBranding: { true: {}, false: {} },
},
_defaultVariants: {
alignment: 'start',
elevation: 'card',
renderBranding: true,
},
},
};
Expand Down
30 changes: 29 additions & 1 deletion packages/ui/src/mosaic/components/card/card.styles.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import * as stylex from '@stylexjs/stylex';

import { colorVars, radiusVars, space } from '../../tokens.stylex';
import { colorVars, radiusVars, space, typeScaleVars } from '../../tokens.stylex';

export const styles = stylex.create({
root: {
Expand DownExpand Up@@ -35,6 +35,34 @@ export const styles = stylex.create({
borderTopWidth: '1px',
width: '100%',
},
branding: {
paddingBlock: space['3'],
paddingInline: space['6'],
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
textAlign: 'center',
},
brandingText: {
color: colorVars['--cl-color-neutral-faded'],
display: 'inline-block',
fontSize: typeScaleVars['--cl-text-xs-size'],
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textWrap: 'pretty',
},
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
alignItems: 'center',
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
verticalAlign: 'top',
height: space['4'],
},
});

export const elevations = stylex.create({
Expand Down
33 changes: 33 additions & 0 deletions packages/ui/src/mosaic/components/card/card.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,39 @@ describe('Mosaic Card', () => {
expect(footerRef.current).toHaveClass('cl-card-footer');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('signs the card with Clerk, in a tab of its own', () => {
render(
<Card.Root data-testid='root'>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

// The mark closes the card out. Held by position rather than by a class: the branding
// carries no slot for a consumer to reach, so a test has none to reach for either.
const branding = screen.getByTestId('root').lastElementChild;
expect(branding).toHaveTextContent('Secured by');

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(branding).toContainElement(logo);
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, so the caller reading
// `displayConfig.branded` turns the signature off rather than the card assuming it.
it('withholds the branding where the caller turns it off', () => {
render(
<Card.Root renderBranding={false}>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
});

it('supports custom elements through render on every slot', () => {
render(
<Card.Root render={props => <section {...props} />}>
Expand Down
44 changes: 43 additions & 1 deletion packages/ui/src/mosaic/components/card/card.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import React from 'react';

import type { MosaicComponentProps } from '../../props';
import { mergeStyleProps, themeProps } from '../../props';
import { ClerkLogo } from '../clerk-logo';
import { reset } from '../reset.styles';
import { TextContext } from '../text';
import { elevations, headerAlignments, styles } from './card.styles';
Expand All@@ -19,16 +20,51 @@ const CardVariantContext = React.createContext<{ alignment: CardAlignment; eleva
elevation: DEFAULT_ELEVATION,
});

/** Signs the foot of the card with "Secured by Clerk". */
function Branding() {
return (
<div {...stylex.props(reset.base, styles.branding)}>
<span {...stylex.props(reset.base, styles.brandingText)}>
Secured by{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(reset.base, styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</span>
</div>
);
}

/** Props for `Card.Root`, including native `div` props and the Mosaic `render` escape hatch. */
export interface CardProps extends MosaicComponentProps<'div'> {
/** Alignment applied to `Card.Header`. @default 'start' */
alignment?: CardAlignment;
/** Surface treatment applied to the card. @default 'card' */
elevation?: CardElevation;
/**
* Signs the foot of the card with "Secured by Clerk". An instance that has paid the branding off
* carries none of it, so a connected surface passes `displayConfig.branded` here.
*
* @default true
*/
renderBranding?: boolean;
}

const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
{ alignment = DEFAULT_ALIGNMENT, elevation = DEFAULT_ELEVATION, render, className, style, ...rest },
{
alignment = DEFAULT_ALIGNMENT,
elevation = DEFAULT_ELEVATION,
renderBranding = true,
render,
className,
style,
children,
...rest
},
ref,
) {
const element = useRender({
Expand All@@ -43,6 +79,12 @@ const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
style,
),
...rest,
children: (
<>
{children}
{renderBranding ? <Branding /> : null}
</>
),
},
});

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -638,23 +638,16 @@ describe('UserButtonView, the foot', () => {
expect(screen.getByRole('link', { name: 'Support' })).toHaveAttribute('href', '/support');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('sends the branding logo to Clerk, in a tab of its own', () => {
renderView();
// The card owns the mark; the popup only carries the answer through. An instance that has paid
// the branding off carries none of it, the way every other Clerk surface reads
// `displayConfig.branded`.
it('signs the popup with Clerk, and withholds the mark where the instance carries none', () => {
const { unmount } = renderView();
expect(within(popup()).getByRole('link', { name: 'Clerk' })).toBeInTheDocument();

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, the way every other Clerk
// surface reads `displayConfig.branded`.
it('withholds the branding where the instance carries none', () => {
renderView({ branded: false });

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
unmount();
renderView({ renderBranding: false });
expect(within(popup()).queryByRole('link', { name: 'Clerk' })).toBeNull();
});

// "All accounts" is one account, and the account's own row already signs out of it.
Expand Down
3 changes: 0 additions & 3 deletions packages/ui/src/mosaic/user-button/user-button.messages.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,6 @@ export const userButtonBase = {
organization: 'Manage organization',
createOrganization: 'Create organization',
},
branding: {
securedBy: 'Secured by',
},
};

/** Substitutes `{name}`-style placeholders. Replaced by the localization layer's own formatter. */
Expand Down
27 changes: 0 additions & 27 deletions packages/ui/src/mosaic/user-button/user-button.styles.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,33 +48,6 @@ export const styles = stylex.create({
justifyContent: 'center',
width: space['7'],
},

branding: {
gap: space['2'],
paddingBlock: space['3'],
alignItems: 'center',
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
color: colorVars['--cl-color-neutral-faded'],
display: 'flex',
fontSize: typeScaleVars['--cl-text-xs-size'],
justifyContent: 'center',
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textAlign: 'center',
},

// Matches the trigger's ring, so the two focusable things the surface owns focus alike.
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
},
});

// The trigger takes the corner of the workspace mark it carries: round for a person, squared for
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/mosaic/user-button/user-button.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,7 +139,7 @@ export interface UserButtonBrandingProps {
*
* @default true
*/
branded?: boolean;
renderBranding?: boolean;
}

export interface UserButtonBusyState {
Expand Down
49 changes: 20 additions & 29 deletions packages/ui/src/mosaic/user-button/user-button.view.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ import { Avatar } from '../components/avatar';
import { Badge } from '../components/badge';
import { Button, SubmitButton } from '../components/button';
import { Card } from '../components/card';
import { ClerkLogo } from '../components/clerk-logo';
import { Icon } from '../components/icon';
import { Item } from '../components/item';
import { Menu } from '../components/menu';
Expand DownExpand Up@@ -832,7 +831,7 @@ function SessionSection() {
);
}

/** The actions that close out the surface, plus the Clerk attribution. */
/** The actions that close out the surface. */
function Footer() {
const data = useUserButtonContext();

Expand DownExpand Up@@ -881,34 +880,21 @@ function Footer() {
r => r.id,
);

if (actions.length === 0) {
return null;
}

return (
<>
{actions.length > 0 ? (
<>
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
) : null}
{data.branded === false ? null : (
<div {...stylex.props(styles.branding)}>
{m.branding.securedBy}{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</div>
)}
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
);
}
Expand DownExpand Up@@ -1014,10 +1000,15 @@ export function UserButtonTrigger({

/** The popover surface: header, organizations, other accounts, and footer. */
export function UserButtonPopup(): ReactElement {
const { renderBranding } = useUserButtonContext();

return (
<Popover.Popup aria-label={m.popup.label}>
{/* The card lays its children out with a row gap; the rows read as one continuous list. */}
<Card.Root style={{ rowGap: 0 }}>
<Card.Root
style={{ rowGap: 0 }}
renderBranding={renderBranding}
>
<Header />
<OrganizationSection />
<SessionSection />
Expand Down
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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-card-owns-branding.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
Comment on lines +1 to +2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Add a release entry for packages/ui.

This PR changes the exported CardProps API and Card.Root output. The empty changeset will not describe or schedule that package change. Add the appropriate package version and release note.

As per coding guidelines: “Use Changesets for version management and changelogs.” Based on learnings: empty changesets are acceptable for documentation-only or non-published changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/mosaic-card-owns-branding.md around lines 1 - 2, Add a Changesets
release entry in mosaic-card-owns-branding.md for packages/ui, specifying the
appropriate version bump for the exported CardProps and Card.Root changes and a
concise release note describing those API/output changes; do not leave the
changeset front matter empty.

Sources: Coding guidelines, Learnings

2 changes: 2 additions & 0 deletions packages/swingset/src/stories/card.component.stories.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,12 @@ export const meta: StoryMeta = {
_variants: {
alignment: { start: {}, center: {} },
elevation: { card: {}, flush: {}, overlay: {} },
renderBranding: { true: {}, false: {} },
},
_defaultVariants: {
alignment: 'start',
elevation: 'card',
renderBranding: true,
},
},
};
Expand Down
30 changes: 29 additions & 1 deletion packages/ui/src/mosaic/components/card/card.styles.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import * as stylex from '@stylexjs/stylex';

import { colorVars, radiusVars, space } from '../../tokens.stylex';
import { colorVars, radiusVars, space, typeScaleVars } from '../../tokens.stylex';

export const styles = stylex.create({
root: {
Expand DownExpand Up@@ -35,6 +35,34 @@ export const styles = stylex.create({
borderTopWidth: '1px',
width: '100%',
},
branding: {
paddingBlock: space['3'],
paddingInline: space['6'],
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
textAlign: 'center',
},
brandingText: {
color: colorVars['--cl-color-neutral-faded'],
display: 'inline-block',
fontSize: typeScaleVars['--cl-text-xs-size'],
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textWrap: 'pretty',
},
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
alignItems: 'center',
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
verticalAlign: 'top',
height: space['4'],
},
});

export const elevations = stylex.create({
Expand Down
33 changes: 33 additions & 0 deletions packages/ui/src/mosaic/components/card/card.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,6 +137,39 @@ describe('Mosaic Card', () => {
expect(footerRef.current).toHaveClass('cl-card-footer');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('signs the card with Clerk, in a tab of its own', () => {
render(
<Card.Root data-testid='root'>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

// The mark closes the card out. Held by position rather than by a class: the branding
// carries no slot for a consumer to reach, so a test has none to reach for either.
const branding = screen.getByTestId('root').lastElementChild;
expect(branding).toHaveTextContent('Secured by');

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(branding).toContainElement(logo);
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, so the caller reading
// `displayConfig.branded` turns the signature off rather than the card assuming it.
it('withholds the branding where the caller turns it off', () => {
render(
<Card.Root renderBranding={false}>
<Card.Content>Content</Card.Content>
</Card.Root>,
);

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
});

it('supports custom elements through render on every slot', () => {
render(
<Card.Root render={props => <section {...props} />}>
Expand Down
44 changes: 43 additions & 1 deletion packages/ui/src/mosaic/components/card/card.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import React from 'react';

import type { MosaicComponentProps } from '../../props';
import { mergeStyleProps, themeProps } from '../../props';
import { ClerkLogo } from '../clerk-logo';
import { reset } from '../reset.styles';
import { TextContext } from '../text';
import { elevations, headerAlignments, styles } from './card.styles';
Expand All@@ -19,16 +20,51 @@ const CardVariantContext = React.createContext<{ alignment: CardAlignment; eleva
elevation: DEFAULT_ELEVATION,
});

/** Signs the foot of the card with "Secured by Clerk". */
function Branding() {
return (
<div {...stylex.props(reset.base, styles.branding)}>
<span {...stylex.props(reset.base, styles.brandingText)}>
Secured by{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(reset.base, styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</span>
</div>
);
}

/** Props for `Card.Root`, including native `div` props and the Mosaic `render` escape hatch. */
export interface CardProps extends MosaicComponentProps<'div'> {
/** Alignment applied to `Card.Header`. @default 'start' */
alignment?: CardAlignment;
/** Surface treatment applied to the card. @default 'card' */
elevation?: CardElevation;
/**
* Signs the foot of the card with "Secured by Clerk". An instance that has paid the branding off
* carries none of it, so a connected surface passes `displayConfig.branded` here.
*
* @default true
*/
renderBranding?: boolean;
}

const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
{ alignment = DEFAULT_ALIGNMENT, elevation = DEFAULT_ELEVATION, render, className, style, ...rest },
{
alignment = DEFAULT_ALIGNMENT,
elevation = DEFAULT_ELEVATION,
renderBranding = true,
render,
className,
style,
children,
...rest
},
ref,
) {
const element = useRender({
Expand All@@ -43,6 +79,12 @@ const Root = React.forwardRef<HTMLDivElement, CardProps>(function CardRoot(
style,
),
...rest,
children: (
<>
{children}
{renderBranding ? <Branding /> : null}
</>
),
},
});

Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -638,23 +638,16 @@ describe('UserButtonView, the foot', () => {
expect(screen.getByRole('link', { name: 'Support' })).toHaveAttribute('href', '/support');
});

// The logo names the link, so the mark is what a screen reader reaches rather than an unnamed link.
it('sends the branding logo to Clerk, in a tab of its own', () => {
renderView();
// The card owns the mark; the popup only carries the answer through. An instance that has paid
// the branding off carries none of it, the way every other Clerk surface reads
// `displayConfig.branded`.
it('signs the popup with Clerk, and withholds the mark where the instance carries none', () => {
const { unmount } = renderView();
expect(within(popup()).getByRole('link', { name: 'Clerk' })).toBeInTheDocument();

const logo = screen.getByRole('link', { name: 'Clerk' });
expect(logo).toHaveAttribute('href', 'https://go.clerk.com/components');
expect(logo).toHaveAttribute('target', '_blank');
expect(logo).toHaveAttribute('rel', 'noopener noreferrer');
});

// An instance that has paid the branding off carries none of it, the way every other Clerk
// surface reads `displayConfig.branded`.
it('withholds the branding where the instance carries none', () => {
renderView({ branded: false });

expect(screen.queryByText('Secured by')).toBeNull();
expect(screen.queryByRole('link', { name: 'Clerk' })).toBeNull();
unmount();
renderView({ renderBranding: false });
expect(within(popup()).queryByRole('link', { name: 'Clerk' })).toBeNull();
});

// "All accounts" is one account, and the account's own row already signs out of it.
Expand Down
3 changes: 0 additions & 3 deletions packages/ui/src/mosaic/user-button/user-button.messages.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,9 +37,6 @@ export const userButtonBase = {
organization: 'Manage organization',
createOrganization: 'Create organization',
},
branding: {
securedBy: 'Secured by',
},
};

/** Substitutes `{name}`-style placeholders. Replaced by the localization layer's own formatter. */
Expand Down
27 changes: 0 additions & 27 deletions packages/ui/src/mosaic/user-button/user-button.styles.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,33 +48,6 @@ export const styles = stylex.create({
justifyContent: 'center',
width: space['7'],
},

branding: {
gap: space['2'],
paddingBlock: space['3'],
alignItems: 'center',
borderBlockStartColor: colorVars['--cl-color-border-faded'],
borderBlockStartStyle: 'solid',
borderBlockStartWidth: '1px',
color: colorVars['--cl-color-neutral-faded'],
display: 'flex',
fontSize: typeScaleVars['--cl-text-xs-size'],
justifyContent: 'center',
lineHeight: typeScaleVars['--cl-text-xs-leading'],
textAlign: 'center',
},

// Matches the trigger's ring, so the two focusable things the surface owns focus alike.
brandingLink: {
borderRadius: radiusVars['--cl-radius-sm'],
outline: {
default: 'none',
':focus-visible': `2px solid ${colorVars['--cl-color-primary']}`,
},
color: 'inherit',
display: 'inline-flex',
outlineOffset: '2px',
},
});

// The trigger takes the corner of the workspace mark it carries: round for a person, squared for
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/mosaic/user-button/user-button.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,7 +139,7 @@ export interface UserButtonBrandingProps {
*
* @default true
*/
branded?: boolean;
renderBranding?: boolean;
}

export interface UserButtonBusyState {
Expand Down
49 changes: 20 additions & 29 deletions packages/ui/src/mosaic/user-button/user-button.view.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ import { Avatar } from '../components/avatar';
import { Badge } from '../components/badge';
import { Button, SubmitButton } from '../components/button';
import { Card } from '../components/card';
import { ClerkLogo } from '../components/clerk-logo';
import { Icon } from '../components/icon';
import { Item } from '../components/item';
import { Menu } from '../components/menu';
Expand DownExpand Up@@ -832,7 +831,7 @@ function SessionSection() {
);
}

/** The actions that close out the surface, plus the Clerk attribution. */
/** The actions that close out the surface. */
function Footer() {
const data = useUserButtonContext();

Expand DownExpand Up@@ -881,34 +880,21 @@ function Footer() {
r => r.id,
);

if (actions.length === 0) {
return null;
}

return (
<>
{actions.length > 0 ? (
<>
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
) : null}
{data.branded === false ? null : (
<div {...stylex.props(styles.branding)}>
{m.branding.securedBy}{' '}
<a
href='https://go.clerk.com/components'
target='_blank'
rel='noopener noreferrer'
{...stylex.props(styles.brandingLink)}
>
<ClerkLogo height={14} />
</a>
</div>
)}
<Item.Separator />
<Item.Group>
{actions.map(action => (
<ActionRow
key={action.id}
{...action}
/>
))}
</Item.Group>
</>
);
}
Expand DownExpand Up@@ -1014,10 +1000,15 @@ export function UserButtonTrigger({

/** The popover surface: header, organizations, other accounts, and footer. */
export function UserButtonPopup(): ReactElement {
const { renderBranding } = useUserButtonContext();

return (
<Popover.Popup aria-label={m.popup.label}>
{/* The card lays its children out with a row gap; the rows read as one continuous list. */}
<Card.Root style={{ rowGap: 0 }}>
<Card.Root
style={{ rowGap: 0 }}
renderBranding={renderBranding}
>
<Header />
<OrganizationSection />
<SessionSection />
Expand Down
Loading