Repository navigation
feat(mosaic): add Switcher and make UserButton list accounts only #10752
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
ebdc10f
feat(mosaic): add Switcher and make UserButton list accounts only
alexcarpenter 00aaaf6
test(mosaic): mark the rejected Switcher prop, not the JSX call
alexcarpenter c687d2e
docs(mosaic): address PR #10752 review feedback
alexcarpenter ea3f168
fix(mosaic): let Switcher take a mode chosen at runtime
alexcarpenter 058f5d5
docs(mosaic): note UserButtonProps for user-only menus in the changeset
alexcarpenter 81b7956
test(mosaic): cover the user-only UserButton in integration tests
alexcarpenter 7b7b8eb
feat(mosaic): theme the combined Switcher through .cl-switcher-* slots
alexcarpenter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| '@clerk/mosaic': minor | ||
| --- | ||
|
|
||
| **Breaking:** Add `Switcher`, the account and organization menu, and make `UserButton` list accounts only. `Switcher` takes `mode`: `'combined'` (the default) lists accounts and organizations, `'user'` lists accounts only, and `'organization'` lists organizations. `<UserButton />` is now `<Switcher mode='user' />` and `<OrganizationSwitcher />` is `<Switcher mode='organization' />`. Each mode takes only its own props, so TypeScript flags organization options on `UserButton` and `triggerVariant` outside `combined`. A `mode` chosen at runtime takes only the props every mode shares. | ||
|
|
||
| | Before | After | | ||
| | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | ||
| | `<UserButton />` (accounts and organizations) | `<Switcher />` | | ||
| | `<UserButton combined={false} />` | `<UserButton />` or `<Switcher mode='user' />` | | ||
| | `<UserButton triggerVariant='condensed' />` | `<Switcher triggerVariant='condensed' />` | | ||
| | Organization props on `UserButton` (`hidePersonal`, `afterSelectOrganizationUrl`, `createOrganizationUrl`, ...) | The same props on `Switcher` | | ||
| | `UserButtonProps` (combined menu) | `CombinedSwitcherProps` | | ||
| | `UserButtonProps` (user-only menu) | `UserButtonProps`, which now takes account options only | | ||
| | `.cl-user-button-*` classes on the combined menu | `.cl-switcher-*`; `UserButton` keeps `.cl-user-button-*` | | ||
|
|
||
| Find usages with `git grep -n -e "UserButton" -e "cl-user-button-"`. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
integration/templates/next-app-router-mosaic/src/app/mosaic-switcher.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| 'use client'; | ||
|
|
||
| import { Switcher, MosaicProvider } from '@clerk/mosaic'; | ||
|
|
||
| export function MosaicSwitcher() { | ||
| return ( | ||
| <MosaicProvider experimental={{ newProfiles: true }}> | ||
| <Switcher /> | ||
| </MosaicProvider> | ||
| ); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| import type { Organization } from '@clerk/backend'; | ||
| import type { BrowserContext, Page } from '@playwright/test'; | ||
| import { expect, test } from '@playwright/test'; | ||
|
|
||
| import type { FakeUser } from '../../testUtils'; | ||
| import { createTestUtils, testAgainstRunningApps } from '../../testUtils'; | ||
|
|
||
| testAgainstRunningApps({ withPattern: ['next.appRouterMosaic.*'] })('Mosaic Switcher @mosaic', ({ app }) => { | ||
| test.describe.configure({ mode: 'serial' }); | ||
|
|
||
| let fakeUser: FakeUser; | ||
| let organization: Organization; | ||
| const cleanups: Array<() => Promise<unknown>> = []; | ||
|
|
||
| test.beforeAll(async () => { | ||
| const u = await createTestUtils({ app }); | ||
| fakeUser = u.services.users.createFakeUser(test); | ||
| cleanups.push(() => fakeUser.deleteIfExists()); | ||
| const user = await u.services.users.createBapiUser(fakeUser); | ||
| organization = await u.services.clerk.organizations.createOrganization({ | ||
| name: `Mosaic ${Date.now()}`, | ||
| createdBy: user.id, | ||
| }); | ||
| cleanups.push(() => u.services.clerk.organizations.deleteOrganization(organization.id)); | ||
| }); | ||
|
|
||
| test.afterAll(async () => { | ||
| const results = await Promise.allSettled(cleanups.map(cleanup => cleanup())); | ||
| await app.teardown(); | ||
| const failures = results.flatMap(result => (result.status === 'rejected' ? [result.reason] : [])); | ||
| if (failures.length > 0) { | ||
| throw new AggregateError(failures, 'Mosaic Switcher cleanup failed'); | ||
| } | ||
| }); | ||
|
|
||
| const trigger = (page: Page) => page.getByRole('button', { name: /^Open account menu for / }); | ||
| const popup = (page: Page) => page.getByRole('dialog', { name: 'Account' }); | ||
|
|
||
| async function signIn({ page, context }: { page: Page; context: BrowserContext }, path = '/') { | ||
| const u = await createTestUtils({ app, page, context }); | ||
| await u.po.signIn.goTo(); | ||
| await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password }); | ||
| await u.page.goToRelative(path); | ||
| await u.po.expect.toBeSignedIn(); | ||
| await expect(trigger(page)).toBeVisible(); | ||
| return u; | ||
| } | ||
|
|
||
| async function openProfileSettings(page: Page) { | ||
| await popup(page).getByRole('button', { name: 'Settings' }).click(); | ||
| const profileSettings = page.getByRole('menuitem', { name: 'Manage profile' }); | ||
| const profile = page.getByRole('tab', { name: 'Account', exact: true }); | ||
| await profileSettings.or(profile).first().waitFor(); | ||
| if (await profileSettings.isVisible()) { | ||
| await profileSettings.click(); | ||
| } | ||
| } | ||
|
|
||
| test('switches the active organization and keeps it across a reload', async ({ page, context }) => { | ||
| const u = await signIn({ page, context }); | ||
| const { id, name } = organization; | ||
|
|
||
| await trigger(page).click(); | ||
| await popup(page).getByRole('button', { name: 'Personal account' }).click(); | ||
| await page.waitForFunction(() => window.Clerk?.organization === null); | ||
| await page.keyboard.press('Escape'); | ||
| await expect(popup(page)).toBeHidden(); | ||
|
|
||
| await trigger(page).click(); | ||
| await popup(page).getByRole('button', { name }).click(); | ||
| await page.waitForFunction(orgId => window.Clerk?.organization?.id === orgId, id); | ||
|
|
||
| await u.page.reload(); | ||
| await u.page.waitForClerkJsLoaded(); | ||
| await page.waitForFunction(orgId => window.Clerk?.organization?.id === orgId, id); | ||
| }); | ||
|
|
||
| test('signs out', async ({ page, context }) => { | ||
| const u = await signIn({ page, context }); | ||
|
|
||
| await trigger(page).click(); | ||
| await popup(page).getByRole('button', { name: 'Sign out', exact: true }).click(); | ||
|
|
||
| await u.po.expect.toBeSignedOut(); | ||
| await expect(trigger(page)).toHaveCount(0); | ||
| }); | ||
|
|
||
| test('sends add account to the sign-in page', async ({ page, context }) => { | ||
| await signIn({ page, context }); | ||
|
|
||
| await trigger(page).click(); | ||
| await popup(page).getByRole('button', { name: 'Add account' }).click(); | ||
|
|
||
| await page.waitForURL(url => url.pathname.startsWith('/sign-in')); | ||
| }); | ||
|
|
||
| test('follows a custom menu link', async ({ page, context }) => { | ||
| await signIn({ page, context }, '/custom'); | ||
|
|
||
| await trigger(page).click(); | ||
| await popup(page).getByRole('link', { name: 'Custom link' }).click(); | ||
| await expect(page.getByText('custom-link-target')).toBeVisible(); | ||
| }); | ||
|
|
||
| test('opens the Mosaic UserProfile in a modal', async ({ page, context }) => { | ||
| await page.setViewportSize({ width: 1280, height: 800 }); | ||
| await signIn({ page, context }); | ||
|
|
||
| await trigger(page).click(); | ||
| await openProfileSettings(page); | ||
|
|
||
| await expect(page.getByRole('tab', { name: 'Account', exact: true })).toHaveAttribute('aria-selected', 'true'); | ||
| await expect(page.locator('.cl-userProfile-root')).toHaveCount(0); | ||
| await expect(popup(page)).toBeHidden(); | ||
| }); | ||
|
|
||
| test('renders a custom page inside the UserProfile modal', async ({ page, context }) => { | ||
| await page.setViewportSize({ width: 1280, height: 800 }); | ||
| await signIn({ page, context }, '/custom'); | ||
|
|
||
| await trigger(page).click(); | ||
| await openProfileSettings(page); | ||
|
|
||
| await page.getByRole('tab', { name: 'Custom page', exact: true }).click(); | ||
| await expect(page.getByText('custom-page-content')).toBeVisible(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.