Skip to content

Custom Pages for <UserProfile /> and <OrganizationProfile /> components#1822

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
anagstef merged 16 commits into from
Oct 24, 2023
Merged

Custom Pages for <UserProfile /> and <OrganizationProfile /> components #1822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
c731a72
feat(clerk-js,clerk-react,types): Introduce Custom Pages in UserProfile
Aug 24, 2023
b5d5e94
fix(clerk-js): Fix top-level `localizationKeys` evaluation
Oct 2, 2023
ee3d735
fix(clerk-react): Fix issue with useCustomPages when making changes o…
Oct 2, 2023
02c870c
chore(clerk-js): Update bundlewatch.config.json
Oct 3, 2023
0bd423c
fix(clerk-react): Fix issue when changing the custom pages length dyn…
Oct 3, 2023
94d18d2
feat(clerk-react,clerk-js): Add support for custom pages in Organizat…
Oct 5, 2023
66c0af4
fix(clerk-react,clerk-js): Resolve comments for custom pages
Oct 5, 2023
436eef3
test(clerk-js): Add tests for OrganizationProfile custom pages
Oct 5, 2023
9dd53b7
fix(clerk-js): Add navbar menu for mobile on custom pages
Oct 6, 2023
ef379a8
fix(clerk-react): Omit `customPages` property from React package comp…
Oct 9, 2023
6b4e6a8
refactor(clerk-js): Refactor the UserProfileRoutes and OrganizationPr…
Oct 12, 2023
579ab9a
refactor(clerk-react,types): Apply minor refactors suggested by PR co…
Oct 12, 2023
4331688
refactor(clerk-react,types): Resolve PR comments
Oct 13, 2023
82ed0bc
chore(clerk-js): Lint OrganizationProfileRoutes
Oct 13, 2023
21fbeda
fix(clerk-js): Fix custom icons props
Oct 16, 2023
3d8b86a
fix(nextjs): Fix typings issue
Oct 24, 2023
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
39 changes: 39 additions & 0 deletions .changeset/proud-ways-lie.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

Introduce customization in `UserProfile` and `OrganizationProfile`

The `<UserProfile />` component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<UserProfile.Page>` component, and external links can be added using the `<UserProfile.Link>` component. The default routes, such as `Account` and `Security`, can be reordered.

Example React API usage:

```tsx
<UserProfile>
<UserProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
<MyCustomPageContent />
</UserProfile.Page>
<UserProfile.Link label="External" url="/home" labelIcon={<Icon />} />
<UserProfile.Page label="account" />
<UserProfile.Page label="security" />
</UserProfile>
```
Custom pages and links should be provided as children using the `<UserButton.UserProfilePage>` and `<UserButton.UserProfileLink>` components when using the `UserButton` component.

The `<OrganizationProfile />` component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<OrganizationProfile.Page>` component, and external links can be added using the `<OrganizationProfile.Link>` component. The default routes, such as `Members` and `Settings`, can be reordered.

Example React API usage:

```tsx
<OrganizationProfile>
<OrganizationProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
<MyCustomPageContent />
</OrganizationProfile.Page>
<OrganizationProfile.Link label="External" url="/home" labelIcon={<Icon />} />
<OrganizationProfile.Page label="members" />
<OrganizationProfile.Page label="settings" />
</OrganizationProfile>
```
Custom pages and links should be provided as children using the `<OrganizationSwitcher.OrganizationProfilePage>` and `<OrganizationSwitcher.OrganizationProfileLink>` components when using the `OrganizationSwitcher` component.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
"files": [
{ "path": "./dist/clerk.browser.js", "maxSize": "62kB" },
{ "path": "./dist/clerk.headless.js", "maxSize": "43kB" },
{ "path": "./dist/ui-common*.js", "maxSize": "75KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "76KB" },
{ "path": "./dist/vendors*.js", "maxSize": "70KB" },
{ "path": "./dist/createorganization*.js", "maxSize": "5KB" },
{ "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down
28 changes: 28 additions & 0 deletions packages/clerk-js/src/ui/common/CustomPageContentContainer.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { Col, descriptors } from '../customizables';
import { CardAlert, NavbarMenuButtonRow, useCardState, withCardStateProvider } from '../elements';
import type { CustomPageContent } from '../utils';
import { ExternalElementMounter } from '../utils';

export const CustomPageContentContainer = withCardStateProvider(
({ mount, unmount }: Omit<CustomPageContent, 'url'>) => {
const card = useCardState();
return (
<Col
elementDescriptor={descriptors.page}
gap={8}
>
<CardAlert>{card.error}</CardAlert>
<NavbarMenuButtonRow />
<Col
elementDescriptor={descriptors.profilePage}
gap={8}
>
<ExternalElementMounter
mount={mount}
unmount={unmount}
/>
</Col>
</Col>
);
},
);
34 changes: 5 additions & 29 deletions packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileNavbar.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
import React from 'react';

import { useCoreOrganization } from '../../contexts';
import type { NavbarRoute } from '../../elements';
import { useCoreOrganization, useOrganizationProfileContext } from '../../contexts';
import { Breadcrumbs, NavBar, NavbarContextProvider, OrganizationPreview } from '../../elements';
import { CogFilled, User } from '../../icons';
import { localizationKeys } from '../../localization';
import type { PropsOfComponent } from '../../styledSystem';

const organizationProfileRoutes: NavbarRoute[] = [
{
name: localizationKeys('organizationProfile.start.headerTitle__members'),
id: 'members',
icon: User,
path: '/',
},
{
name: localizationKeys('organizationProfile.start.headerTitle__settings'),
id: 'settings',
icon: CogFilled,
path: 'organization-settings',
},
];

export const OrganizationProfileNavbar = (
props: React.PropsWithChildren<Pick<PropsOfComponent<typeof NavBar>, 'contentRef'>>,
) => {
const { organization } = useCoreOrganization();
const { pages } = useOrganizationProfileContext();

if (!organization) {
return null;
Expand All@@ -41,27 +24,20 @@ export const OrganizationProfileNavbar = (
sx={t => ({ margin: `0 0 ${t.space.$4} ${t.space.$2}` })}
/>
}
routes={organizationProfileRoutes}
routes={pages.routes}
contentRef={props.contentRef}
/>
{props.children}
</NavbarContextProvider>
);
};

const pageToRootNavbarRouteMap = {
'invite-members': organizationProfileRoutes.find(r => r.id === 'members'),
domain: organizationProfileRoutes.find(r => r.id === 'settings'),
profile: organizationProfileRoutes.find(r => r.id === 'settings'),
leave: organizationProfileRoutes.find(r => r.id === 'settings'),
delete: organizationProfileRoutes.find(r => r.id === 'settings'),
};

export const OrganizationProfileBreadcrumbs = (props: Pick<PropsOfComponent<typeof Breadcrumbs>, 'title'>) => {
const { pages } = useOrganizationProfileContext();
return (
<Breadcrumbs
{...props}
pageToRootNavbarRoute={pageToRootNavbarRouteMap}
pageToRootNavbarRoute={pages.pageToRootNavbarRouteMap}
/>
);
};
178 changes: 103 additions & 75 deletions packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
import { Gate } from '../../common/Gate';
import { Gate } from '../../common';
import { CustomPageContentContainer } from '../../common/CustomPageContentContainer';
import { ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID } from '../../constants';
import { useOrganizationProfileContext } from '../../contexts';
import { ProfileCardContent } from '../../elements';
import { Route, Switch } from '../../router';
import type { PropsOfComponent } from '../../styledSystem';
Expand All@@ -13,100 +16,125 @@ import { VerifiedDomainPage } from './VerifiedDomainPage';
import { VerifyDomainPage } from './VerifyDomainPage';

export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof ProfileCardContent>) => {
const { pages } = useOrganizationProfileContext();
const isMembersPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS;
const isSettingsPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.SETTINGS;

const customPageRoutesWithContents = pages.contents?.map((customPage, index) => {
const shouldFirstCustomItemBeOnRoot = !isSettingsPageRoot && !isMembersPageRoot && index === 0;
return (
<Route
index={shouldFirstCustomItemBeOnRoot}
path={shouldFirstCustomItemBeOnRoot ? undefined : customPage.url}
key={`custom-page-${customPage.url}`}
>
<CustomPageContentContainer
mount={customPage.mount}
unmount={customPage.unmount}
/>
</Route>
);
});

return (
<ProfileCardContent contentRef={props.contentRef}>
<Route path='organization-settings'>
<Switch>
<Route
path='profile'
flowStart
>
<Gate
permission={'org:sys_profile:manage'}
redirectTo='../'
>
<ProfileSettingsPage />
</Gate>
</Route>
<Route
path='domain'
flowStart
>
<Switch>
{customPageRoutesWithContents}
<Route>
<Route path={isSettingsPageRoot ? undefined : 'organization-settings'}>
<Switch>
<Route path=':id/verify'>
<Route
path='profile'
flowStart
>
<Gate
permission={'org:sys_domains:manage'}
redirectTo='../../'
permission={'org:sys_profile:manage'}
redirectTo='../'
>
<VerifyDomainPage />
<ProfileSettingsPage />
</Gate>
</Route>
<Route path=':id/remove'>
<Gate
permission={'org:sys_domains:delete'}
redirectTo='../../'
>
<RemoveDomainPage />
</Gate>
<Route
path='domain'
flowStart
>
<Switch>
<Route path=':id/verify'>
<Gate
permission={'org:sys_domains:manage'}
redirectTo='../../'
>
<VerifyDomainPage />
</Gate>
</Route>
<Route path=':id/remove'>
<Gate
permission={'org:sys_domains:delete'}
redirectTo='../../'
>
<RemoveDomainPage />
</Gate>
</Route>
<Route path=':id'>
<Gate
permission={'org:sys_domains:manage'}
redirectTo='../../'
>
<VerifiedDomainPage />
</Gate>
</Route>
<Route index>
<Gate
permission={'org:sys_domains:manage'}
redirectTo='../'
>
<AddDomainPage />
</Gate>
</Route>
</Switch>
</Route>
<Route
path='leave'
flowStart
>
<LeaveOrganizationPage />
</Route>
<Route path=':id'>
<Route
path='delete'
flowStart
>
<Gate
permission={'org:sys_domains:manage'}
redirectTo='../../'
permission={'org:sys_profile:delete'}
redirectTo='../'
>
<VerifiedDomainPage />
<DeleteOrganizationPage />
</Gate>
</Route>
<Route index>
<OrganizationSettings />
</Route>
</Switch>
</Route>
<Route path={isMembersPageRoot ? undefined : 'organization-members'}>
<Switch>
<Route
path='invite-members'
flowStart
>
<Gate
permission={'org:sys_domains:manage'}
permission={'org:sys_memberships:manage'}
redirectTo='../'
>
<AddDomainPage />
<InviteMembersPage />
</Gate>
</Route>
<Route index>
<OrganizationMembers />
</Route>
</Switch>
</Route>
<Route
path='leave'
flowStart
>
<LeaveOrganizationPage />
</Route>
<Route
path='delete'
flowStart
>
<Gate
permission={'org:sys_profile:delete'}
redirectTo='../'
>
<DeleteOrganizationPage />
</Gate>
</Route>
<Route index>
<OrganizationSettings />
</Route>
</Switch>
</Route>
<Route>
<Switch>
<Route
path='invite-members'
flowStart
>
<Gate
permission={'org:sys_memberships:manage'}
redirectTo='../'
>
<InviteMembersPage />
</Gate>
</Route>
<Route index>
<OrganizationMembers />
</Route>
</Switch>
</Route>
</Route>
</Switch>
</ProfileCardContent>
);
};
34 changes: 34 additions & 0 deletions ...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationProfile.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { CustomPage } from '@clerk/types';
import { describe, it } from '@jest/globals';
import React from 'react';

Expand All@@ -19,4 +20,37 @@ describe('OrganizationProfile', () => {
expect(getByText('Members')).toBeDefined();
expect(getByText('Settings')).toBeDefined();
});

it('includes custom nav items', async () => {
const { wrapper, props } = await createFixtures(f => {
f.withOrganizations();
f.withUser({ email_addresses: ['test@clerk.dev'], organization_memberships: ['Org1'] });
});

const customPages: CustomPage[] = [
{
label: 'Custom1',
url: 'custom1',
mount: () => undefined,
unmount: () => undefined,
mountIcon: () => undefined,
unmountIcon: () => undefined,
},
{
label: 'ExternalLink',
url: '/link',
mountIcon: () => undefined,
unmountIcon: () => undefined,
},
];

props.setProps({ customPages });

const { getByText } = render(<OrganizationProfile />, { wrapper });
expect(getByText('Org1')).toBeDefined();
expect(getByText('Members')).toBeDefined();
expect(getByText('Settings')).toBeDefined();
expect(getByText('Custom1')).toBeDefined();
expect(getByText('ExternalLink')).toBeDefined();
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Custom Pages for `<UserProfile />` and `<OrganizationProfile />` components by anagstef · Pull Request #1822 · clerk/javascript · GitHub
Skip to content
Custom Pages for <UserProfile /> and <OrganizationProfile /> components#1822

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

anagstef
merged 16 commits into

from

Oct 24, 2023
 Merged


Custom Pages for <UserProfile /> and <OrganizationProfile /> components
#1822
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
c731a72

feat(clerk-js,clerk-react,types): Introduce Custom Pages in UserProfile

Aug 24, 2023
b5d5e94

fix(clerk-js): Fix top-level `localizationKeys` evaluation

Oct 2, 2023
ee3d735

fix(clerk-react): Fix issue with useCustomPages when making changes o…

Oct 2, 2023
02c870c

chore(clerk-js): Update bundlewatch.config.json

Oct 3, 2023
0bd423c

fix(clerk-react): Fix issue when changing the custom pages length dyn…

Oct 3, 2023
94d18d2

feat(clerk-react,clerk-js): Add support for custom pages in Organizat…

Oct 5, 2023
66c0af4

fix(clerk-react,clerk-js): Resolve comments for custom pages

Oct 5, 2023
436eef3

test(clerk-js): Add tests for OrganizationProfile custom pages

Oct 5, 2023
9dd53b7

fix(clerk-js): Add navbar menu for mobile on custom pages

Oct 6, 2023
ef379a8

fix(clerk-react): Omit `customPages` property from React package comp…

Oct 9, 2023
6b4e6a8

refactor(clerk-js): Refactor the UserProfileRoutes and OrganizationPr…

Oct 12, 2023
579ab9a

refactor(clerk-react,types): Apply minor refactors suggested by PR co…

Oct 12, 2023
4331688

refactor(clerk-react,types): Resolve PR comments

Oct 13, 2023
82ed0bc

chore(clerk-js): Lint OrganizationProfileRoutes

Oct 13, 2023
21fbeda

fix(clerk-js): Fix custom icons props

Oct 16, 2023
3d8b86a

fix(nextjs): Fix typings issue

Oct 24, 2023

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


39 changes: 39 additions & 0 deletions
.changeset/proud-ways-lie.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

Introduce customization in `UserProfile` and `OrganizationProfile`

The `<UserProfile />` component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<UserProfile.Page>` component, and external links can be added using the `<UserProfile.Link>` component. The default routes, such as `Account` and `Security`, can be reordered.

Example React API usage:

```tsx
<UserProfile>
 <UserProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </UserProfile.Page>
 <UserProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <UserProfile.Page label="account" />
 <UserProfile.Page label="security" />
</UserProfile>
```
Custom pages and links should be provided as children using the `<UserButton.UserProfilePage>` and `<UserButton.UserProfileLink>` components when using the `UserButton` component.

The `<OrganizationProfile />` component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<OrganizationProfile.Page>` component, and external links can be added using the `<OrganizationProfile.Link>` component. The default routes, such as `Members` and `Settings`, can be reordered.

Example React API usage:

```tsx
<OrganizationProfile>
 <OrganizationProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </OrganizationProfile.Page>
 <OrganizationProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <OrganizationProfile.Page label="members" />
 <OrganizationProfile.Page label="settings" />
</OrganizationProfile>
```
Custom pages and links should be provided as children using the `<OrganizationSwitcher.OrganizationProfilePage>` and `<OrganizationSwitcher.OrganizationProfileLink>` components when using the `OrganizationSwitcher` component.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
 "files": [
 { "path": "./dist/clerk.browser.js", "maxSize": "62kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "43kB" },
 { "path": "./dist/ui-common*.js", "maxSize": "75KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "76KB" },
 { "path": "./dist/vendors*.js", "maxSize": "70KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

28 changes: 28 additions & 0 deletions
packages/clerk-js/src/ui/common/CustomPageContentContainer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { Col, descriptors } from '../customizables';
import { CardAlert, NavbarMenuButtonRow, useCardState, withCardStateProvider } from '../elements';
import type { CustomPageContent } from '../utils';
import { ExternalElementMounter } from '../utils';

export const CustomPageContentContainer = withCardStateProvider(
 ({ mount, unmount }: Omit<CustomPageContent, 'url'>) => {
 const card = useCardState();
 return (
 <Col
 elementDescriptor={descriptors.page}
 gap={8}
 >
 <CardAlert>{card.error}</CardAlert>
 <NavbarMenuButtonRow />
 <Col
 elementDescriptor={descriptors.profilePage}
 gap={8}
 >
 <ExternalElementMounter
 mount={mount}
 unmount={unmount}
 />
 </Col>
 </Col>
 );
 },
);

34 changes: 5 additions & 29 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileNavbar.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
import React from 'react';

import { useCoreOrganization } from '../../contexts';
import type { NavbarRoute } from '../../elements';
import { useCoreOrganization, useOrganizationProfileContext } from '../../contexts';
import { Breadcrumbs, NavBar, NavbarContextProvider, OrganizationPreview } from '../../elements';
import { CogFilled, User } from '../../icons';
import { localizationKeys } from '../../localization';
import type { PropsOfComponent } from '../../styledSystem';

const organizationProfileRoutes: NavbarRoute[] = [
 {
 name: localizationKeys('organizationProfile.start.headerTitle__members'),
 id: 'members',
 icon: User,
 path: '/',
 },
 {
 name: localizationKeys('organizationProfile.start.headerTitle__settings'),
 id: 'settings',
 icon: CogFilled,
 path: 'organization-settings',
 },
];

export const OrganizationProfileNavbar = (
 props: React.PropsWithChildren<Pick<PropsOfComponent<typeof NavBar>, 'contentRef'>>,
) => {
 const { organization } = useCoreOrganization();
 const { pages } = useOrganizationProfileContext();

 if (!organization) {
 return null;
Expand All@@ -41,27 +24,20 @@ export const OrganizationProfileNavbar = (
 sx={t => ({ margin: `0 0 ${t.space.$4} ${t.space.$2}` })}
 />
 }
 routes={organizationProfileRoutes}
 routes={pages.routes}
 contentRef={props.contentRef}
 />
 {props.children}
 </NavbarContextProvider>
 );
};

const pageToRootNavbarRouteMap = {
 'invite-members': organizationProfileRoutes.find(r => r.id === 'members'),
 domain: organizationProfileRoutes.find(r => r.id === 'settings'),
 profile: organizationProfileRoutes.find(r => r.id === 'settings'),
 leave: organizationProfileRoutes.find(r => r.id === 'settings'),
 delete: organizationProfileRoutes.find(r => r.id === 'settings'),
};

export const OrganizationProfileBreadcrumbs = (props: Pick<PropsOfComponent<typeof Breadcrumbs>, 'title'>) => {
 const { pages } = useOrganizationProfileContext();
 return (
 <Breadcrumbs
 {...props}
 pageToRootNavbarRoute={pageToRootNavbarRouteMap}
 pageToRootNavbarRoute={pages.pageToRootNavbarRouteMap}
 />
 );
};

178 changes: 103 additions & 75 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
import { Gate } from '../../common/Gate';
import { Gate } from '../../common';
import { CustomPageContentContainer } from '../../common/CustomPageContentContainer';
import { ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID } from '../../constants';
import { useOrganizationProfileContext } from '../../contexts';
import { ProfileCardContent } from '../../elements';
import { Route, Switch } from '../../router';
import type { PropsOfComponent } from '../../styledSystem';
Expand All@@ -13,100 +16,125 @@ import { VerifiedDomainPage } from './VerifiedDomainPage';
import { VerifyDomainPage } from './VerifyDomainPage';

export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof ProfileCardContent>) => {
 const { pages } = useOrganizationProfileContext();
 const isMembersPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS;
 const isSettingsPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.SETTINGS;

 const customPageRoutesWithContents = pages.contents?.map((customPage, index) => {
 const shouldFirstCustomItemBeOnRoot = !isSettingsPageRoot && !isMembersPageRoot && index === 0;
 return (
 <Route
 index={shouldFirstCustomItemBeOnRoot}
 path={shouldFirstCustomItemBeOnRoot ? undefined : customPage.url}
 key={`custom-page-${customPage.url}`}
 >
 <CustomPageContentContainer
 mount={customPage.mount}
 unmount={customPage.unmount}
 />
 </Route>
 );
 });

 return (
 <ProfileCardContent contentRef={props.contentRef}>
 <Route path='organization-settings'>
 <Switch>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 {customPageRoutesWithContents}
 <Route>
 <Route path={isSettingsPageRoot ? undefined : 'organization-settings'}>
 <Switch>
 <Route path=':id/verify'>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <VerifyDomainPage />
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 <Route path=':id/verify'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifyDomainPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 </Route>
 <Route path=':id'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifiedDomainPage />
 </Gate>
 </Route>
 <Route index>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 </Gate>
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route path=':id'>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <VerifiedDomainPage />
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route path={isMembersPageRoot ? undefined : 'organization-members'}>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 </Route>
 </Switch>
 </ProfileCardContent>
 );
};

34 changes: 34 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationProfile.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { CustomPage } from '@clerk/types';
import { describe, it } from '@jest/globals';
import React from 'react';

Expand All@@ -19,4 +20,37 @@ describe('OrganizationProfile', () => {
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 });

 it('includes custom nav items', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({ email_addresses: ['test@clerk.dev'], organization_memberships: ['Org1'] });
 });

 const customPages: CustomPage[] = [
 {
 label: 'Custom1',
 url: 'custom1',
 mount: () => undefined,
 unmount: () => undefined,
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 {
 label: 'ExternalLink',
 url: '/link',
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 ];

 props.setProps({ customPages });

 const { getByText } = render(<OrganizationProfile />, { wrapper });
 expect(getByText('Org1')).toBeDefined();
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 expect(getByText('Custom1')).toBeDefined();
 expect(getByText('ExternalLink')).toBeDefined();
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Custom Pages for `<UserProfile />` and `<OrganizationProfile />` components by anagstef · Pull Request #1822 · clerk/javascript · GitHub
Skip to content
Custom Pages for <UserProfile /> and <OrganizationProfile /> components#1822

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

anagstef
merged 16 commits into

from

Oct 24, 2023
 Merged


Custom Pages for <UserProfile /> and <OrganizationProfile /> components
#1822
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
c731a72

feat(clerk-js,clerk-react,types): Introduce Custom Pages in UserProfile

Aug 24, 2023
b5d5e94

fix(clerk-js): Fix top-level `localizationKeys` evaluation

Oct 2, 2023
ee3d735

fix(clerk-react): Fix issue with useCustomPages when making changes o…

Oct 2, 2023
02c870c

chore(clerk-js): Update bundlewatch.config.json

Oct 3, 2023
0bd423c

fix(clerk-react): Fix issue when changing the custom pages length dyn…

Oct 3, 2023
94d18d2

feat(clerk-react,clerk-js): Add support for custom pages in Organizat…

Oct 5, 2023
66c0af4

fix(clerk-react,clerk-js): Resolve comments for custom pages

Oct 5, 2023
436eef3

test(clerk-js): Add tests for OrganizationProfile custom pages

Oct 5, 2023
9dd53b7

fix(clerk-js): Add navbar menu for mobile on custom pages

Oct 6, 2023
ef379a8

fix(clerk-react): Omit `customPages` property from React package comp…

Oct 9, 2023
6b4e6a8

refactor(clerk-js): Refactor the UserProfileRoutes and OrganizationPr…

Oct 12, 2023
579ab9a

refactor(clerk-react,types): Apply minor refactors suggested by PR co…

Oct 12, 2023
4331688

refactor(clerk-react,types): Resolve PR comments

Oct 13, 2023
82ed0bc

chore(clerk-js): Lint OrganizationProfileRoutes

Oct 13, 2023
21fbeda

fix(clerk-js): Fix custom icons props

Oct 16, 2023
3d8b86a

fix(nextjs): Fix typings issue

Oct 24, 2023

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


39 changes: 39 additions & 0 deletions
.changeset/proud-ways-lie.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

Introduce customization in `UserProfile` and `OrganizationProfile`

The `<UserProfile />` component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<UserProfile.Page>` component, and external links can be added using the `<UserProfile.Link>` component. The default routes, such as `Account` and `Security`, can be reordered.

Example React API usage:

```tsx
<UserProfile>
 <UserProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </UserProfile.Page>
 <UserProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <UserProfile.Page label="account" />
 <UserProfile.Page label="security" />
</UserProfile>
```
Custom pages and links should be provided as children using the `<UserButton.UserProfilePage>` and `<UserButton.UserProfileLink>` components when using the `UserButton` component.

The `<OrganizationProfile />` component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<OrganizationProfile.Page>` component, and external links can be added using the `<OrganizationProfile.Link>` component. The default routes, such as `Members` and `Settings`, can be reordered.

Example React API usage:

```tsx
<OrganizationProfile>
 <OrganizationProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </OrganizationProfile.Page>
 <OrganizationProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <OrganizationProfile.Page label="members" />
 <OrganizationProfile.Page label="settings" />
</OrganizationProfile>
```
Custom pages and links should be provided as children using the `<OrganizationSwitcher.OrganizationProfilePage>` and `<OrganizationSwitcher.OrganizationProfileLink>` components when using the `OrganizationSwitcher` component.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
 "files": [
 { "path": "./dist/clerk.browser.js", "maxSize": "62kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "43kB" },
 { "path": "./dist/ui-common*.js", "maxSize": "75KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "76KB" },
 { "path": "./dist/vendors*.js", "maxSize": "70KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

28 changes: 28 additions & 0 deletions
packages/clerk-js/src/ui/common/CustomPageContentContainer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { Col, descriptors } from '../customizables';
import { CardAlert, NavbarMenuButtonRow, useCardState, withCardStateProvider } from '../elements';
import type { CustomPageContent } from '../utils';
import { ExternalElementMounter } from '../utils';

export const CustomPageContentContainer = withCardStateProvider(
 ({ mount, unmount }: Omit<CustomPageContent, 'url'>) => {
 const card = useCardState();
 return (
 <Col
 elementDescriptor={descriptors.page}
 gap={8}
 >
 <CardAlert>{card.error}</CardAlert>
 <NavbarMenuButtonRow />
 <Col
 elementDescriptor={descriptors.profilePage}
 gap={8}
 >
 <ExternalElementMounter
 mount={mount}
 unmount={unmount}
 />
 </Col>
 </Col>
 );
 },
);

34 changes: 5 additions & 29 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileNavbar.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
import React from 'react';

import { useCoreOrganization } from '../../contexts';
import type { NavbarRoute } from '../../elements';
import { useCoreOrganization, useOrganizationProfileContext } from '../../contexts';
import { Breadcrumbs, NavBar, NavbarContextProvider, OrganizationPreview } from '../../elements';
import { CogFilled, User } from '../../icons';
import { localizationKeys } from '../../localization';
import type { PropsOfComponent } from '../../styledSystem';

const organizationProfileRoutes: NavbarRoute[] = [
 {
 name: localizationKeys('organizationProfile.start.headerTitle__members'),
 id: 'members',
 icon: User,
 path: '/',
 },
 {
 name: localizationKeys('organizationProfile.start.headerTitle__settings'),
 id: 'settings',
 icon: CogFilled,
 path: 'organization-settings',
 },
];

export const OrganizationProfileNavbar = (
 props: React.PropsWithChildren<Pick<PropsOfComponent<typeof NavBar>, 'contentRef'>>,
) => {
 const { organization } = useCoreOrganization();
 const { pages } = useOrganizationProfileContext();

 if (!organization) {
 return null;
Expand All@@ -41,27 +24,20 @@ export const OrganizationProfileNavbar = (
 sx={t => ({ margin: `0 0 ${t.space.$4} ${t.space.$2}` })}
 />
 }
 routes={organizationProfileRoutes}
 routes={pages.routes}
 contentRef={props.contentRef}
 />
 {props.children}
 </NavbarContextProvider>
 );
};

const pageToRootNavbarRouteMap = {
 'invite-members': organizationProfileRoutes.find(r => r.id === 'members'),
 domain: organizationProfileRoutes.find(r => r.id === 'settings'),
 profile: organizationProfileRoutes.find(r => r.id === 'settings'),
 leave: organizationProfileRoutes.find(r => r.id === 'settings'),
 delete: organizationProfileRoutes.find(r => r.id === 'settings'),
};

export const OrganizationProfileBreadcrumbs = (props: Pick<PropsOfComponent<typeof Breadcrumbs>, 'title'>) => {
 const { pages } = useOrganizationProfileContext();
 return (
 <Breadcrumbs
 {...props}
 pageToRootNavbarRoute={pageToRootNavbarRouteMap}
 pageToRootNavbarRoute={pages.pageToRootNavbarRouteMap}
 />
 );
};

178 changes: 103 additions & 75 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
import { Gate } from '../../common/Gate';
import { Gate } from '../../common';
import { CustomPageContentContainer } from '../../common/CustomPageContentContainer';
import { ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID } from '../../constants';
import { useOrganizationProfileContext } from '../../contexts';
import { ProfileCardContent } from '../../elements';
import { Route, Switch } from '../../router';
import type { PropsOfComponent } from '../../styledSystem';
Expand All@@ -13,100 +16,125 @@ import { VerifiedDomainPage } from './VerifiedDomainPage';
import { VerifyDomainPage } from './VerifyDomainPage';

export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof ProfileCardContent>) => {
 const { pages } = useOrganizationProfileContext();
 const isMembersPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS;
 const isSettingsPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.SETTINGS;

 const customPageRoutesWithContents = pages.contents?.map((customPage, index) => {
 const shouldFirstCustomItemBeOnRoot = !isSettingsPageRoot && !isMembersPageRoot && index === 0;
 return (
 <Route
 index={shouldFirstCustomItemBeOnRoot}
 path={shouldFirstCustomItemBeOnRoot ? undefined : customPage.url}
 key={`custom-page-${customPage.url}`}
 >
 <CustomPageContentContainer
 mount={customPage.mount}
 unmount={customPage.unmount}
 />
 </Route>
 );
 });

 return (
 <ProfileCardContent contentRef={props.contentRef}>
 <Route path='organization-settings'>
 <Switch>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 {customPageRoutesWithContents}
 <Route>
 <Route path={isSettingsPageRoot ? undefined : 'organization-settings'}>
 <Switch>
 <Route path=':id/verify'>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <VerifyDomainPage />
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 <Route path=':id/verify'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifyDomainPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 </Route>
 <Route path=':id'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifiedDomainPage />
 </Gate>
 </Route>
 <Route index>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 </Gate>
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route path=':id'>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <VerifiedDomainPage />
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route path={isMembersPageRoot ? undefined : 'organization-members'}>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 </Route>
 </Switch>
 </ProfileCardContent>
 );
};

34 changes: 34 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationProfile.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { CustomPage } from '@clerk/types';
import { describe, it } from '@jest/globals';
import React from 'react';

Expand All@@ -19,4 +20,37 @@ describe('OrganizationProfile', () => {
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 });

 it('includes custom nav items', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({ email_addresses: ['test@clerk.dev'], organization_memberships: ['Org1'] });
 });

 const customPages: CustomPage[] = [
 {
 label: 'Custom1',
 url: 'custom1',
 mount: () => undefined,
 unmount: () => undefined,
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 {
 label: 'ExternalLink',
 url: '/link',
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 ];

 props.setProps({ customPages });

 const { getByText } = render(<OrganizationProfile />, { wrapper });
 expect(getByText('Org1')).toBeDefined();
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 expect(getByText('Custom1')).toBeDefined();
 expect(getByText('ExternalLink')).toBeDefined();
 });
});
Loading

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

anagstef
merged 16 commits into

from

Oct 24, 2023
 Merged


Custom Pages for <UserProfile /> and <OrganizationProfile /> components
#1822
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
c731a72

feat(clerk-js,clerk-react,types): Introduce Custom Pages in UserProfile

Aug 24, 2023
b5d5e94

fix(clerk-js): Fix top-level `localizationKeys` evaluation

Oct 2, 2023
ee3d735

fix(clerk-react): Fix issue with useCustomPages when making changes o…

Oct 2, 2023
02c870c

chore(clerk-js): Update bundlewatch.config.json

Oct 3, 2023
0bd423c

fix(clerk-react): Fix issue when changing the custom pages length dyn…

Oct 3, 2023
94d18d2

feat(clerk-react,clerk-js): Add support for custom pages in Organizat…

Oct 5, 2023
66c0af4

fix(clerk-react,clerk-js): Resolve comments for custom pages

Oct 5, 2023
436eef3

test(clerk-js): Add tests for OrganizationProfile custom pages

Oct 5, 2023
9dd53b7

fix(clerk-js): Add navbar menu for mobile on custom pages

Oct 6, 2023
ef379a8

fix(clerk-react): Omit `customPages` property from React package comp…

Oct 9, 2023
6b4e6a8

refactor(clerk-js): Refactor the UserProfileRoutes and OrganizationPr…

Oct 12, 2023
579ab9a

refactor(clerk-react,types): Apply minor refactors suggested by PR co…

Oct 12, 2023
4331688

refactor(clerk-react,types): Resolve PR comments

Oct 13, 2023
82ed0bc

chore(clerk-js): Lint OrganizationProfileRoutes

Oct 13, 2023
21fbeda

fix(clerk-js): Fix custom icons props

Oct 16, 2023
3d8b86a

fix(nextjs): Fix typings issue

Oct 24, 2023

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


39 changes: 39 additions & 0 deletions
.changeset/proud-ways-lie.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

Introduce customization in `UserProfile` and `OrganizationProfile`

The `<UserProfile />` component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<UserProfile.Page>` component, and external links can be added using the `<UserProfile.Link>` component. The default routes, such as `Account` and `Security`, can be reordered.

Example React API usage:

```tsx
<UserProfile>
 <UserProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </UserProfile.Page>
 <UserProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <UserProfile.Page label="account" />
 <UserProfile.Page label="security" />
</UserProfile>
```
Custom pages and links should be provided as children using the `<UserButton.UserProfilePage>` and `<UserButton.UserProfileLink>` components when using the `UserButton` component.

The `<OrganizationProfile />` component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<OrganizationProfile.Page>` component, and external links can be added using the `<OrganizationProfile.Link>` component. The default routes, such as `Members` and `Settings`, can be reordered.

Example React API usage:

```tsx
<OrganizationProfile>
 <OrganizationProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </OrganizationProfile.Page>
 <OrganizationProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <OrganizationProfile.Page label="members" />
 <OrganizationProfile.Page label="settings" />
</OrganizationProfile>
```
Custom pages and links should be provided as children using the `<OrganizationSwitcher.OrganizationProfilePage>` and `<OrganizationSwitcher.OrganizationProfileLink>` components when using the `OrganizationSwitcher` component.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
 "files": [
 { "path": "./dist/clerk.browser.js", "maxSize": "62kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "43kB" },
 { "path": "./dist/ui-common*.js", "maxSize": "75KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "76KB" },
 { "path": "./dist/vendors*.js", "maxSize": "70KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

28 changes: 28 additions & 0 deletions
packages/clerk-js/src/ui/common/CustomPageContentContainer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { Col, descriptors } from '../customizables';
import { CardAlert, NavbarMenuButtonRow, useCardState, withCardStateProvider } from '../elements';
import type { CustomPageContent } from '../utils';
import { ExternalElementMounter } from '../utils';

export const CustomPageContentContainer = withCardStateProvider(
 ({ mount, unmount }: Omit<CustomPageContent, 'url'>) => {
 const card = useCardState();
 return (
 <Col
 elementDescriptor={descriptors.page}
 gap={8}
 >
 <CardAlert>{card.error}</CardAlert>
 <NavbarMenuButtonRow />
 <Col
 elementDescriptor={descriptors.profilePage}
 gap={8}
 >
 <ExternalElementMounter
 mount={mount}
 unmount={unmount}
 />
 </Col>
 </Col>
 );
 },
);

34 changes: 5 additions & 29 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileNavbar.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
import React from 'react';

import { useCoreOrganization } from '../../contexts';
import type { NavbarRoute } from '../../elements';
import { useCoreOrganization, useOrganizationProfileContext } from '../../contexts';
import { Breadcrumbs, NavBar, NavbarContextProvider, OrganizationPreview } from '../../elements';
import { CogFilled, User } from '../../icons';
import { localizationKeys } from '../../localization';
import type { PropsOfComponent } from '../../styledSystem';

const organizationProfileRoutes: NavbarRoute[] = [
 {
 name: localizationKeys('organizationProfile.start.headerTitle__members'),
 id: 'members',
 icon: User,
 path: '/',
 },
 {
 name: localizationKeys('organizationProfile.start.headerTitle__settings'),
 id: 'settings',
 icon: CogFilled,
 path: 'organization-settings',
 },
];

export const OrganizationProfileNavbar = (
 props: React.PropsWithChildren<Pick<PropsOfComponent<typeof NavBar>, 'contentRef'>>,
) => {
 const { organization } = useCoreOrganization();
 const { pages } = useOrganizationProfileContext();

 if (!organization) {
 return null;
Expand All@@ -41,27 +24,20 @@ export const OrganizationProfileNavbar = (
 sx={t => ({ margin: `0 0 ${t.space.$4} ${t.space.$2}` })}
 />
 }
 routes={organizationProfileRoutes}
 routes={pages.routes}
 contentRef={props.contentRef}
 />
 {props.children}
 </NavbarContextProvider>
 );
};

const pageToRootNavbarRouteMap = {
 'invite-members': organizationProfileRoutes.find(r => r.id === 'members'),
 domain: organizationProfileRoutes.find(r => r.id === 'settings'),
 profile: organizationProfileRoutes.find(r => r.id === 'settings'),
 leave: organizationProfileRoutes.find(r => r.id === 'settings'),
 delete: organizationProfileRoutes.find(r => r.id === 'settings'),
};

export const OrganizationProfileBreadcrumbs = (props: Pick<PropsOfComponent<typeof Breadcrumbs>, 'title'>) => {
 const { pages } = useOrganizationProfileContext();
 return (
 <Breadcrumbs
 {...props}
 pageToRootNavbarRoute={pageToRootNavbarRouteMap}
 pageToRootNavbarRoute={pages.pageToRootNavbarRouteMap}
 />
 );
};

178 changes: 103 additions & 75 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
import { Gate } from '../../common/Gate';
import { Gate } from '../../common';
import { CustomPageContentContainer } from '../../common/CustomPageContentContainer';
import { ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID } from '../../constants';
import { useOrganizationProfileContext } from '../../contexts';
import { ProfileCardContent } from '../../elements';
import { Route, Switch } from '../../router';
import type { PropsOfComponent } from '../../styledSystem';
Expand All@@ -13,100 +16,125 @@ import { VerifiedDomainPage } from './VerifiedDomainPage';
import { VerifyDomainPage } from './VerifyDomainPage';

export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof ProfileCardContent>) => {
 const { pages } = useOrganizationProfileContext();
 const isMembersPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS;
 const isSettingsPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.SETTINGS;

 const customPageRoutesWithContents = pages.contents?.map((customPage, index) => {
 const shouldFirstCustomItemBeOnRoot = !isSettingsPageRoot && !isMembersPageRoot && index === 0;
 return (
 <Route
 index={shouldFirstCustomItemBeOnRoot}
 path={shouldFirstCustomItemBeOnRoot ? undefined : customPage.url}
 key={`custom-page-${customPage.url}`}
 >
 <CustomPageContentContainer
 mount={customPage.mount}
 unmount={customPage.unmount}
 />
 </Route>
 );
 });

 return (
 <ProfileCardContent contentRef={props.contentRef}>
 <Route path='organization-settings'>
 <Switch>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 {customPageRoutesWithContents}
 <Route>
 <Route path={isSettingsPageRoot ? undefined : 'organization-settings'}>
 <Switch>
 <Route path=':id/verify'>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <VerifyDomainPage />
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 <Route path=':id/verify'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifyDomainPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 </Route>
 <Route path=':id'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifiedDomainPage />
 </Gate>
 </Route>
 <Route index>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 </Gate>
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route path=':id'>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <VerifiedDomainPage />
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route path={isMembersPageRoot ? undefined : 'organization-members'}>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 </Route>
 </Switch>
 </ProfileCardContent>
 );
};

34 changes: 34 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationProfile.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { CustomPage } from '@clerk/types';
import { describe, it } from '@jest/globals';
import React from 'react';

Expand All@@ -19,4 +20,37 @@ describe('OrganizationProfile', () => {
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 });

 it('includes custom nav items', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({ email_addresses: ['test@clerk.dev'], organization_memberships: ['Org1'] });
 });

 const customPages: CustomPage[] = [
 {
 label: 'Custom1',
 url: 'custom1',
 mount: () => undefined,
 unmount: () => undefined,
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 {
 label: 'ExternalLink',
 url: '/link',
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 ];

 props.setProps({ customPages });

 const { getByText } = render(<OrganizationProfile />, { wrapper });
 expect(getByText('Org1')).toBeDefined();
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 expect(getByText('Custom1')).toBeDefined();
 expect(getByText('ExternalLink')).toBeDefined();
 });
});
Loading

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

anagstef
merged 16 commits into

from

Oct 24, 2023
 Merged


Custom Pages for <UserProfile /> and <OrganizationProfile /> components
#1822
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
c731a72

feat(clerk-js,clerk-react,types): Introduce Custom Pages in UserProfile

Aug 24, 2023
b5d5e94

fix(clerk-js): Fix top-level `localizationKeys` evaluation

Oct 2, 2023
ee3d735

fix(clerk-react): Fix issue with useCustomPages when making changes o…

Oct 2, 2023
02c870c

chore(clerk-js): Update bundlewatch.config.json

Oct 3, 2023
0bd423c

fix(clerk-react): Fix issue when changing the custom pages length dyn…

Oct 3, 2023
94d18d2

feat(clerk-react,clerk-js): Add support for custom pages in Organizat…

Oct 5, 2023
66c0af4

fix(clerk-react,clerk-js): Resolve comments for custom pages

Oct 5, 2023
436eef3

test(clerk-js): Add tests for OrganizationProfile custom pages

Oct 5, 2023
9dd53b7

fix(clerk-js): Add navbar menu for mobile on custom pages

Oct 6, 2023
ef379a8

fix(clerk-react): Omit `customPages` property from React package comp…

Oct 9, 2023
6b4e6a8

refactor(clerk-js): Refactor the UserProfileRoutes and OrganizationPr…

Oct 12, 2023
579ab9a

refactor(clerk-react,types): Apply minor refactors suggested by PR co…

Oct 12, 2023
4331688

refactor(clerk-react,types): Resolve PR comments

Oct 13, 2023
82ed0bc

chore(clerk-js): Lint OrganizationProfileRoutes

Oct 13, 2023
21fbeda

fix(clerk-js): Fix custom icons props

Oct 16, 2023
3d8b86a

fix(nextjs): Fix typings issue

Oct 24, 2023

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


39 changes: 39 additions & 0 deletions
.changeset/proud-ways-lie.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

Introduce customization in `UserProfile` and `OrganizationProfile`

The `<UserProfile />` component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<UserProfile.Page>` component, and external links can be added using the `<UserProfile.Link>` component. The default routes, such as `Account` and `Security`, can be reordered.

Example React API usage:

```tsx
<UserProfile>
 <UserProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </UserProfile.Page>
 <UserProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <UserProfile.Page label="account" />
 <UserProfile.Page label="security" />
</UserProfile>
```
Custom pages and links should be provided as children using the `<UserButton.UserProfilePage>` and `<UserButton.UserProfileLink>` components when using the `UserButton` component.

The `<OrganizationProfile />` component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<OrganizationProfile.Page>` component, and external links can be added using the `<OrganizationProfile.Link>` component. The default routes, such as `Members` and `Settings`, can be reordered.

Example React API usage:

```tsx
<OrganizationProfile>
 <OrganizationProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </OrganizationProfile.Page>
 <OrganizationProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <OrganizationProfile.Page label="members" />
 <OrganizationProfile.Page label="settings" />
</OrganizationProfile>
```
Custom pages and links should be provided as children using the `<OrganizationSwitcher.OrganizationProfilePage>` and `<OrganizationSwitcher.OrganizationProfileLink>` components when using the `OrganizationSwitcher` component.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
 "files": [
 { "path": "./dist/clerk.browser.js", "maxSize": "62kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "43kB" },
 { "path": "./dist/ui-common*.js", "maxSize": "75KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "76KB" },
 { "path": "./dist/vendors*.js", "maxSize": "70KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

28 changes: 28 additions & 0 deletions
packages/clerk-js/src/ui/common/CustomPageContentContainer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { Col, descriptors } from '../customizables';
import { CardAlert, NavbarMenuButtonRow, useCardState, withCardStateProvider } from '../elements';
import type { CustomPageContent } from '../utils';
import { ExternalElementMounter } from '../utils';

export const CustomPageContentContainer = withCardStateProvider(
 ({ mount, unmount }: Omit<CustomPageContent, 'url'>) => {
 const card = useCardState();
 return (
 <Col
 elementDescriptor={descriptors.page}
 gap={8}
 >
 <CardAlert>{card.error}</CardAlert>
 <NavbarMenuButtonRow />
 <Col
 elementDescriptor={descriptors.profilePage}
 gap={8}
 >
 <ExternalElementMounter
 mount={mount}
 unmount={unmount}
 />
 </Col>
 </Col>
 );
 },
);

34 changes: 5 additions & 29 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileNavbar.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
import React from 'react';

import { useCoreOrganization } from '../../contexts';
import type { NavbarRoute } from '../../elements';
import { useCoreOrganization, useOrganizationProfileContext } from '../../contexts';
import { Breadcrumbs, NavBar, NavbarContextProvider, OrganizationPreview } from '../../elements';
import { CogFilled, User } from '../../icons';
import { localizationKeys } from '../../localization';
import type { PropsOfComponent } from '../../styledSystem';

const organizationProfileRoutes: NavbarRoute[] = [
 {
 name: localizationKeys('organizationProfile.start.headerTitle__members'),
 id: 'members',
 icon: User,
 path: '/',
 },
 {
 name: localizationKeys('organizationProfile.start.headerTitle__settings'),
 id: 'settings',
 icon: CogFilled,
 path: 'organization-settings',
 },
];

export const OrganizationProfileNavbar = (
 props: React.PropsWithChildren<Pick<PropsOfComponent<typeof NavBar>, 'contentRef'>>,
) => {
 const { organization } = useCoreOrganization();
 const { pages } = useOrganizationProfileContext();

 if (!organization) {
 return null;
Expand All@@ -41,27 +24,20 @@ export const OrganizationProfileNavbar = (
 sx={t => ({ margin: `0 0 ${t.space.$4} ${t.space.$2}` })}
 />
 }
 routes={organizationProfileRoutes}
 routes={pages.routes}
 contentRef={props.contentRef}
 />
 {props.children}
 </NavbarContextProvider>
 );
};

const pageToRootNavbarRouteMap = {
 'invite-members': organizationProfileRoutes.find(r => r.id === 'members'),
 domain: organizationProfileRoutes.find(r => r.id === 'settings'),
 profile: organizationProfileRoutes.find(r => r.id === 'settings'),
 leave: organizationProfileRoutes.find(r => r.id === 'settings'),
 delete: organizationProfileRoutes.find(r => r.id === 'settings'),
};

export const OrganizationProfileBreadcrumbs = (props: Pick<PropsOfComponent<typeof Breadcrumbs>, 'title'>) => {
 const { pages } = useOrganizationProfileContext();
 return (
 <Breadcrumbs
 {...props}
 pageToRootNavbarRoute={pageToRootNavbarRouteMap}
 pageToRootNavbarRoute={pages.pageToRootNavbarRouteMap}
 />
 );
};

178 changes: 103 additions & 75 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
import { Gate } from '../../common/Gate';
import { Gate } from '../../common';
import { CustomPageContentContainer } from '../../common/CustomPageContentContainer';
import { ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID } from '../../constants';
import { useOrganizationProfileContext } from '../../contexts';
import { ProfileCardContent } from '../../elements';
import { Route, Switch } from '../../router';
import type { PropsOfComponent } from '../../styledSystem';
Expand All@@ -13,100 +16,125 @@ import { VerifiedDomainPage } from './VerifiedDomainPage';
import { VerifyDomainPage } from './VerifyDomainPage';

export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof ProfileCardContent>) => {
 const { pages } = useOrganizationProfileContext();
 const isMembersPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS;
 const isSettingsPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.SETTINGS;

 const customPageRoutesWithContents = pages.contents?.map((customPage, index) => {
 const shouldFirstCustomItemBeOnRoot = !isSettingsPageRoot && !isMembersPageRoot && index === 0;
 return (
 <Route
 index={shouldFirstCustomItemBeOnRoot}
 path={shouldFirstCustomItemBeOnRoot ? undefined : customPage.url}
 key={`custom-page-${customPage.url}`}
 >
 <CustomPageContentContainer
 mount={customPage.mount}
 unmount={customPage.unmount}
 />
 </Route>
 );
 });

 return (
 <ProfileCardContent contentRef={props.contentRef}>
 <Route path='organization-settings'>
 <Switch>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 {customPageRoutesWithContents}
 <Route>
 <Route path={isSettingsPageRoot ? undefined : 'organization-settings'}>
 <Switch>
 <Route path=':id/verify'>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <VerifyDomainPage />
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 <Route path=':id/verify'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifyDomainPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 </Route>
 <Route path=':id'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifiedDomainPage />
 </Gate>
 </Route>
 <Route index>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 </Gate>
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route path=':id'>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <VerifiedDomainPage />
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route path={isMembersPageRoot ? undefined : 'organization-members'}>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 </Route>
 </Switch>
 </ProfileCardContent>
 );
};

34 changes: 34 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationProfile.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { CustomPage } from '@clerk/types';
import { describe, it } from '@jest/globals';
import React from 'react';

Expand All@@ -19,4 +20,37 @@ describe('OrganizationProfile', () => {
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 });

 it('includes custom nav items', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({ email_addresses: ['test@clerk.dev'], organization_memberships: ['Org1'] });
 });

 const customPages: CustomPage[] = [
 {
 label: 'Custom1',
 url: 'custom1',
 mount: () => undefined,
 unmount: () => undefined,
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 {
 label: 'ExternalLink',
 url: '/link',
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 ];

 props.setProps({ customPages });

 const { getByText } = render(<OrganizationProfile />, { wrapper });
 expect(getByText('Org1')).toBeDefined();
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 expect(getByText('Custom1')).toBeDefined();
 expect(getByText('ExternalLink')).toBeDefined();
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Custom Pages for `<UserProfile />` and `<OrganizationProfile />` components by anagstef · Pull Request #1822 · clerk/javascript · GitHub
Skip to content
Custom Pages for <UserProfile /> and <OrganizationProfile /> components#1822

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

anagstef
merged 16 commits into

from

Oct 24, 2023
 Merged


Custom Pages for <UserProfile /> and <OrganizationProfile /> components
#1822
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
c731a72

feat(clerk-js,clerk-react,types): Introduce Custom Pages in UserProfile

Aug 24, 2023
b5d5e94

fix(clerk-js): Fix top-level `localizationKeys` evaluation

Oct 2, 2023
ee3d735

fix(clerk-react): Fix issue with useCustomPages when making changes o…

Oct 2, 2023
02c870c

chore(clerk-js): Update bundlewatch.config.json

Oct 3, 2023
0bd423c

fix(clerk-react): Fix issue when changing the custom pages length dyn…

Oct 3, 2023
94d18d2

feat(clerk-react,clerk-js): Add support for custom pages in Organizat…

Oct 5, 2023
66c0af4

fix(clerk-react,clerk-js): Resolve comments for custom pages

Oct 5, 2023
436eef3

test(clerk-js): Add tests for OrganizationProfile custom pages

Oct 5, 2023
9dd53b7

fix(clerk-js): Add navbar menu for mobile on custom pages

Oct 6, 2023
ef379a8

fix(clerk-react): Omit `customPages` property from React package comp…

Oct 9, 2023
6b4e6a8

refactor(clerk-js): Refactor the UserProfileRoutes and OrganizationPr…

Oct 12, 2023
579ab9a

refactor(clerk-react,types): Apply minor refactors suggested by PR co…

Oct 12, 2023
4331688

refactor(clerk-react,types): Resolve PR comments

Oct 13, 2023
82ed0bc

chore(clerk-js): Lint OrganizationProfileRoutes

Oct 13, 2023
21fbeda

fix(clerk-js): Fix custom icons props

Oct 16, 2023
3d8b86a

fix(nextjs): Fix typings issue

Oct 24, 2023

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


39 changes: 39 additions & 0 deletions
.changeset/proud-ways-lie.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

Introduce customization in `UserProfile` and `OrganizationProfile`

The `<UserProfile />` component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<UserProfile.Page>` component, and external links can be added using the `<UserProfile.Link>` component. The default routes, such as `Account` and `Security`, can be reordered.

Example React API usage:

```tsx
<UserProfile>
 <UserProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </UserProfile.Page>
 <UserProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <UserProfile.Page label="account" />
 <UserProfile.Page label="security" />
</UserProfile>
```
Custom pages and links should be provided as children using the `<UserButton.UserProfilePage>` and `<UserButton.UserProfileLink>` components when using the `UserButton` component.

The `<OrganizationProfile />` component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<OrganizationProfile.Page>` component, and external links can be added using the `<OrganizationProfile.Link>` component. The default routes, such as `Members` and `Settings`, can be reordered.

Example React API usage:

```tsx
<OrganizationProfile>
 <OrganizationProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </OrganizationProfile.Page>
 <OrganizationProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <OrganizationProfile.Page label="members" />
 <OrganizationProfile.Page label="settings" />
</OrganizationProfile>
```
Custom pages and links should be provided as children using the `<OrganizationSwitcher.OrganizationProfilePage>` and `<OrganizationSwitcher.OrganizationProfileLink>` components when using the `OrganizationSwitcher` component.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
 "files": [
 { "path": "./dist/clerk.browser.js", "maxSize": "62kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "43kB" },
 { "path": "./dist/ui-common*.js", "maxSize": "75KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "76KB" },
 { "path": "./dist/vendors*.js", "maxSize": "70KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

28 changes: 28 additions & 0 deletions
packages/clerk-js/src/ui/common/CustomPageContentContainer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { Col, descriptors } from '../customizables';
import { CardAlert, NavbarMenuButtonRow, useCardState, withCardStateProvider } from '../elements';
import type { CustomPageContent } from '../utils';
import { ExternalElementMounter } from '../utils';

export const CustomPageContentContainer = withCardStateProvider(
 ({ mount, unmount }: Omit<CustomPageContent, 'url'>) => {
 const card = useCardState();
 return (
 <Col
 elementDescriptor={descriptors.page}
 gap={8}
 >
 <CardAlert>{card.error}</CardAlert>
 <NavbarMenuButtonRow />
 <Col
 elementDescriptor={descriptors.profilePage}
 gap={8}
 >
 <ExternalElementMounter
 mount={mount}
 unmount={unmount}
 />
 </Col>
 </Col>
 );
 },
);

34 changes: 5 additions & 29 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileNavbar.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
import React from 'react';

import { useCoreOrganization } from '../../contexts';
import type { NavbarRoute } from '../../elements';
import { useCoreOrganization, useOrganizationProfileContext } from '../../contexts';
import { Breadcrumbs, NavBar, NavbarContextProvider, OrganizationPreview } from '../../elements';
import { CogFilled, User } from '../../icons';
import { localizationKeys } from '../../localization';
import type { PropsOfComponent } from '../../styledSystem';

const organizationProfileRoutes: NavbarRoute[] = [
 {
 name: localizationKeys('organizationProfile.start.headerTitle__members'),
 id: 'members',
 icon: User,
 path: '/',
 },
 {
 name: localizationKeys('organizationProfile.start.headerTitle__settings'),
 id: 'settings',
 icon: CogFilled,
 path: 'organization-settings',
 },
];

export const OrganizationProfileNavbar = (
 props: React.PropsWithChildren<Pick<PropsOfComponent<typeof NavBar>, 'contentRef'>>,
) => {
 const { organization } = useCoreOrganization();
 const { pages } = useOrganizationProfileContext();

 if (!organization) {
 return null;
Expand All@@ -41,27 +24,20 @@ export const OrganizationProfileNavbar = (
 sx={t => ({ margin: `0 0 ${t.space.$4} ${t.space.$2}` })}
 />
 }
 routes={organizationProfileRoutes}
 routes={pages.routes}
 contentRef={props.contentRef}
 />
 {props.children}
 </NavbarContextProvider>
 );
};

const pageToRootNavbarRouteMap = {
 'invite-members': organizationProfileRoutes.find(r => r.id === 'members'),
 domain: organizationProfileRoutes.find(r => r.id === 'settings'),
 profile: organizationProfileRoutes.find(r => r.id === 'settings'),
 leave: organizationProfileRoutes.find(r => r.id === 'settings'),
 delete: organizationProfileRoutes.find(r => r.id === 'settings'),
};

export const OrganizationProfileBreadcrumbs = (props: Pick<PropsOfComponent<typeof Breadcrumbs>, 'title'>) => {
 const { pages } = useOrganizationProfileContext();
 return (
 <Breadcrumbs
 {...props}
 pageToRootNavbarRoute={pageToRootNavbarRouteMap}
 pageToRootNavbarRoute={pages.pageToRootNavbarRouteMap}
 />
 );
};

178 changes: 103 additions & 75 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
import { Gate } from '../../common/Gate';
import { Gate } from '../../common';
import { CustomPageContentContainer } from '../../common/CustomPageContentContainer';
import { ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID } from '../../constants';
import { useOrganizationProfileContext } from '../../contexts';
import { ProfileCardContent } from '../../elements';
import { Route, Switch } from '../../router';
import type { PropsOfComponent } from '../../styledSystem';
Expand All@@ -13,100 +16,125 @@ import { VerifiedDomainPage } from './VerifiedDomainPage';
import { VerifyDomainPage } from './VerifyDomainPage';

export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof ProfileCardContent>) => {
 const { pages } = useOrganizationProfileContext();
 const isMembersPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS;
 const isSettingsPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.SETTINGS;

 const customPageRoutesWithContents = pages.contents?.map((customPage, index) => {
 const shouldFirstCustomItemBeOnRoot = !isSettingsPageRoot && !isMembersPageRoot && index === 0;
 return (
 <Route
 index={shouldFirstCustomItemBeOnRoot}
 path={shouldFirstCustomItemBeOnRoot ? undefined : customPage.url}
 key={`custom-page-${customPage.url}`}
 >
 <CustomPageContentContainer
 mount={customPage.mount}
 unmount={customPage.unmount}
 />
 </Route>
 );
 });

 return (
 <ProfileCardContent contentRef={props.contentRef}>
 <Route path='organization-settings'>
 <Switch>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 {customPageRoutesWithContents}
 <Route>
 <Route path={isSettingsPageRoot ? undefined : 'organization-settings'}>
 <Switch>
 <Route path=':id/verify'>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <VerifyDomainPage />
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 <Route path=':id/verify'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifyDomainPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 </Route>
 <Route path=':id'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifiedDomainPage />
 </Gate>
 </Route>
 <Route index>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 </Gate>
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route path=':id'>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <VerifiedDomainPage />
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route path={isMembersPageRoot ? undefined : 'organization-members'}>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 </Route>
 </Switch>
 </ProfileCardContent>
 );
};

34 changes: 34 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationProfile.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { CustomPage } from '@clerk/types';
import { describe, it } from '@jest/globals';
import React from 'react';

Expand All@@ -19,4 +20,37 @@ describe('OrganizationProfile', () => {
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 });

 it('includes custom nav items', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({ email_addresses: ['test@clerk.dev'], organization_memberships: ['Org1'] });
 });

 const customPages: CustomPage[] = [
 {
 label: 'Custom1',
 url: 'custom1',
 mount: () => undefined,
 unmount: () => undefined,
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 {
 label: 'ExternalLink',
 url: '/link',
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 ];

 props.setProps({ customPages });

 const { getByText } = render(<OrganizationProfile />, { wrapper });
 expect(getByText('Org1')).toBeDefined();
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 expect(getByText('Custom1')).toBeDefined();
 expect(getByText('ExternalLink')).toBeDefined();
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Custom Pages for `<UserProfile />` and `<OrganizationProfile />` components by anagstef · Pull Request #1822 · clerk/javascript · GitHub
Skip to content
Custom Pages for <UserProfile /> and <OrganizationProfile /> components#1822

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

anagstef
merged 16 commits into

from

Oct 24, 2023
 Merged


Custom Pages for <UserProfile /> and <OrganizationProfile /> components
#1822
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
c731a72

feat(clerk-js,clerk-react,types): Introduce Custom Pages in UserProfile

Aug 24, 2023
b5d5e94

fix(clerk-js): Fix top-level `localizationKeys` evaluation

Oct 2, 2023
ee3d735

fix(clerk-react): Fix issue with useCustomPages when making changes o…

Oct 2, 2023
02c870c

chore(clerk-js): Update bundlewatch.config.json

Oct 3, 2023
0bd423c

fix(clerk-react): Fix issue when changing the custom pages length dyn…

Oct 3, 2023
94d18d2

feat(clerk-react,clerk-js): Add support for custom pages in Organizat…

Oct 5, 2023
66c0af4

fix(clerk-react,clerk-js): Resolve comments for custom pages

Oct 5, 2023
436eef3

test(clerk-js): Add tests for OrganizationProfile custom pages

Oct 5, 2023
9dd53b7

fix(clerk-js): Add navbar menu for mobile on custom pages

Oct 6, 2023
ef379a8

fix(clerk-react): Omit `customPages` property from React package comp…

Oct 9, 2023
6b4e6a8

refactor(clerk-js): Refactor the UserProfileRoutes and OrganizationPr…

Oct 12, 2023
579ab9a

refactor(clerk-react,types): Apply minor refactors suggested by PR co…

Oct 12, 2023
4331688

refactor(clerk-react,types): Resolve PR comments

Oct 13, 2023
82ed0bc

chore(clerk-js): Lint OrganizationProfileRoutes

Oct 13, 2023
21fbeda

fix(clerk-js): Fix custom icons props

Oct 16, 2023
3d8b86a

fix(nextjs): Fix typings issue

Oct 24, 2023

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


39 changes: 39 additions & 0 deletions
.changeset/proud-ways-lie.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

Introduce customization in `UserProfile` and `OrganizationProfile`

The `<UserProfile />` component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<UserProfile.Page>` component, and external links can be added using the `<UserProfile.Link>` component. The default routes, such as `Account` and `Security`, can be reordered.

Example React API usage:

```tsx
<UserProfile>
 <UserProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </UserProfile.Page>
 <UserProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <UserProfile.Page label="account" />
 <UserProfile.Page label="security" />
</UserProfile>
```
Custom pages and links should be provided as children using the `<UserButton.UserProfilePage>` and `<UserButton.UserProfileLink>` components when using the `UserButton` component.

The `<OrganizationProfile />` component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<OrganizationProfile.Page>` component, and external links can be added using the `<OrganizationProfile.Link>` component. The default routes, such as `Members` and `Settings`, can be reordered.

Example React API usage:

```tsx
<OrganizationProfile>
 <OrganizationProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </OrganizationProfile.Page>
 <OrganizationProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <OrganizationProfile.Page label="members" />
 <OrganizationProfile.Page label="settings" />
</OrganizationProfile>
```
Custom pages and links should be provided as children using the `<OrganizationSwitcher.OrganizationProfilePage>` and `<OrganizationSwitcher.OrganizationProfileLink>` components when using the `OrganizationSwitcher` component.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
 "files": [
 { "path": "./dist/clerk.browser.js", "maxSize": "62kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "43kB" },
 { "path": "./dist/ui-common*.js", "maxSize": "75KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "76KB" },
 { "path": "./dist/vendors*.js", "maxSize": "70KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

28 changes: 28 additions & 0 deletions
packages/clerk-js/src/ui/common/CustomPageContentContainer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { Col, descriptors } from '../customizables';
import { CardAlert, NavbarMenuButtonRow, useCardState, withCardStateProvider } from '../elements';
import type { CustomPageContent } from '../utils';
import { ExternalElementMounter } from '../utils';

export const CustomPageContentContainer = withCardStateProvider(
 ({ mount, unmount }: Omit<CustomPageContent, 'url'>) => {
 const card = useCardState();
 return (
 <Col
 elementDescriptor={descriptors.page}
 gap={8}
 >
 <CardAlert>{card.error}</CardAlert>
 <NavbarMenuButtonRow />
 <Col
 elementDescriptor={descriptors.profilePage}
 gap={8}
 >
 <ExternalElementMounter
 mount={mount}
 unmount={unmount}
 />
 </Col>
 </Col>
 );
 },
);

34 changes: 5 additions & 29 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileNavbar.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
import React from 'react';

import { useCoreOrganization } from '../../contexts';
import type { NavbarRoute } from '../../elements';
import { useCoreOrganization, useOrganizationProfileContext } from '../../contexts';
import { Breadcrumbs, NavBar, NavbarContextProvider, OrganizationPreview } from '../../elements';
import { CogFilled, User } from '../../icons';
import { localizationKeys } from '../../localization';
import type { PropsOfComponent } from '../../styledSystem';

const organizationProfileRoutes: NavbarRoute[] = [
 {
 name: localizationKeys('organizationProfile.start.headerTitle__members'),
 id: 'members',
 icon: User,
 path: '/',
 },
 {
 name: localizationKeys('organizationProfile.start.headerTitle__settings'),
 id: 'settings',
 icon: CogFilled,
 path: 'organization-settings',
 },
];

export const OrganizationProfileNavbar = (
 props: React.PropsWithChildren<Pick<PropsOfComponent<typeof NavBar>, 'contentRef'>>,
) => {
 const { organization } = useCoreOrganization();
 const { pages } = useOrganizationProfileContext();

 if (!organization) {
 return null;
Expand All@@ -41,27 +24,20 @@ export const OrganizationProfileNavbar = (
 sx={t => ({ margin: `0 0 ${t.space.$4} ${t.space.$2}` })}
 />
 }
 routes={organizationProfileRoutes}
 routes={pages.routes}
 contentRef={props.contentRef}
 />
 {props.children}
 </NavbarContextProvider>
 );
};

const pageToRootNavbarRouteMap = {
 'invite-members': organizationProfileRoutes.find(r => r.id === 'members'),
 domain: organizationProfileRoutes.find(r => r.id === 'settings'),
 profile: organizationProfileRoutes.find(r => r.id === 'settings'),
 leave: organizationProfileRoutes.find(r => r.id === 'settings'),
 delete: organizationProfileRoutes.find(r => r.id === 'settings'),
};

export const OrganizationProfileBreadcrumbs = (props: Pick<PropsOfComponent<typeof Breadcrumbs>, 'title'>) => {
 const { pages } = useOrganizationProfileContext();
 return (
 <Breadcrumbs
 {...props}
 pageToRootNavbarRoute={pageToRootNavbarRouteMap}
 pageToRootNavbarRoute={pages.pageToRootNavbarRouteMap}
 />
 );
};

178 changes: 103 additions & 75 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
import { Gate } from '../../common/Gate';
import { Gate } from '../../common';
import { CustomPageContentContainer } from '../../common/CustomPageContentContainer';
import { ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID } from '../../constants';
import { useOrganizationProfileContext } from '../../contexts';
import { ProfileCardContent } from '../../elements';
import { Route, Switch } from '../../router';
import type { PropsOfComponent } from '../../styledSystem';
Expand All@@ -13,100 +16,125 @@ import { VerifiedDomainPage } from './VerifiedDomainPage';
import { VerifyDomainPage } from './VerifyDomainPage';

export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof ProfileCardContent>) => {
 const { pages } = useOrganizationProfileContext();
 const isMembersPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS;
 const isSettingsPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.SETTINGS;

 const customPageRoutesWithContents = pages.contents?.map((customPage, index) => {
 const shouldFirstCustomItemBeOnRoot = !isSettingsPageRoot && !isMembersPageRoot && index === 0;
 return (
 <Route
 index={shouldFirstCustomItemBeOnRoot}
 path={shouldFirstCustomItemBeOnRoot ? undefined : customPage.url}
 key={`custom-page-${customPage.url}`}
 >
 <CustomPageContentContainer
 mount={customPage.mount}
 unmount={customPage.unmount}
 />
 </Route>
 );
 });

 return (
 <ProfileCardContent contentRef={props.contentRef}>
 <Route path='organization-settings'>
 <Switch>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 {customPageRoutesWithContents}
 <Route>
 <Route path={isSettingsPageRoot ? undefined : 'organization-settings'}>
 <Switch>
 <Route path=':id/verify'>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <VerifyDomainPage />
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 <Route path=':id/verify'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifyDomainPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 </Route>
 <Route path=':id'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifiedDomainPage />
 </Gate>
 </Route>
 <Route index>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 </Gate>
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route path=':id'>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <VerifiedDomainPage />
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route path={isMembersPageRoot ? undefined : 'organization-members'}>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 </Route>
 </Switch>
 </ProfileCardContent>
 );
};

34 changes: 34 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationProfile.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { CustomPage } from '@clerk/types';
import { describe, it } from '@jest/globals';
import React from 'react';

Expand All@@ -19,4 +20,37 @@ describe('OrganizationProfile', () => {
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 });

 it('includes custom nav items', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({ email_addresses: ['test@clerk.dev'], organization_memberships: ['Org1'] });
 });

 const customPages: CustomPage[] = [
 {
 label: 'Custom1',
 url: 'custom1',
 mount: () => undefined,
 unmount: () => undefined,
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 {
 label: 'ExternalLink',
 url: '/link',
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 ];

 props.setProps({ customPages });

 const { getByText } = render(<OrganizationProfile />, { wrapper });
 expect(getByText('Org1')).toBeDefined();
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 expect(getByText('Custom1')).toBeDefined();
 expect(getByText('ExternalLink')).toBeDefined();
 });
});
Loading

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

anagstef
merged 16 commits into

from

Oct 24, 2023
 Merged


Custom Pages for <UserProfile /> and <OrganizationProfile /> components
#1822
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
c731a72

feat(clerk-js,clerk-react,types): Introduce Custom Pages in UserProfile

Aug 24, 2023
b5d5e94

fix(clerk-js): Fix top-level `localizationKeys` evaluation

Oct 2, 2023
ee3d735

fix(clerk-react): Fix issue with useCustomPages when making changes o…

Oct 2, 2023
02c870c

chore(clerk-js): Update bundlewatch.config.json

Oct 3, 2023
0bd423c

fix(clerk-react): Fix issue when changing the custom pages length dyn…

Oct 3, 2023
94d18d2

feat(clerk-react,clerk-js): Add support for custom pages in Organizat…

Oct 5, 2023
66c0af4

fix(clerk-react,clerk-js): Resolve comments for custom pages

Oct 5, 2023
436eef3

test(clerk-js): Add tests for OrganizationProfile custom pages

Oct 5, 2023
9dd53b7

fix(clerk-js): Add navbar menu for mobile on custom pages

Oct 6, 2023
ef379a8

fix(clerk-react): Omit `customPages` property from React package comp…

Oct 9, 2023
6b4e6a8

refactor(clerk-js): Refactor the UserProfileRoutes and OrganizationPr…

Oct 12, 2023
579ab9a

refactor(clerk-react,types): Apply minor refactors suggested by PR co…

Oct 12, 2023
4331688

refactor(clerk-react,types): Resolve PR comments

Oct 13, 2023
82ed0bc

chore(clerk-js): Lint OrganizationProfileRoutes

Oct 13, 2023
21fbeda

fix(clerk-js): Fix custom icons props

Oct 16, 2023
3d8b86a

fix(nextjs): Fix typings issue

Oct 24, 2023

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


39 changes: 39 additions & 0 deletions
.changeset/proud-ways-lie.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
---
'@clerk/clerk-js': minor
'@clerk/clerk-react': minor
'@clerk/types': minor
---

Introduce customization in `UserProfile` and `OrganizationProfile`

The `<UserProfile />` component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<UserProfile.Page>` component, and external links can be added using the `<UserProfile.Link>` component. The default routes, such as `Account` and `Security`, can be reordered.

Example React API usage:

```tsx
<UserProfile>
 <UserProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </UserProfile.Page>
 <UserProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <UserProfile.Page label="account" />
 <UserProfile.Page label="security" />
</UserProfile>
```
Custom pages and links should be provided as children using the `<UserButton.UserProfilePage>` and `<UserButton.UserProfileLink>` components when using the `UserButton` component.

The `<OrganizationProfile />` component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the `<OrganizationProfile.Page>` component, and external links can be added using the `<OrganizationProfile.Link>` component. The default routes, such as `Members` and `Settings`, can be reordered.

Example React API usage:

```tsx
<OrganizationProfile>
 <OrganizationProfile.Page label="Custom Page" url="custom" labelIcon={<CustomIcon />}>
 <MyCustomPageContent />
 </OrganizationProfile.Page>
 <OrganizationProfile.Link label="External" url="/home" labelIcon={<Icon />} />
 <OrganizationProfile.Page label="members" />
 <OrganizationProfile.Page label="settings" />
</OrganizationProfile>
```
Custom pages and links should be provided as children using the `<OrganizationSwitcher.OrganizationProfilePage>` and `<OrganizationSwitcher.OrganizationProfileLink>` components when using the `OrganizationSwitcher` component.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
 "files": [
 { "path": "./dist/clerk.browser.js", "maxSize": "62kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "43kB" },
 { "path": "./dist/ui-common*.js", "maxSize": "75KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "76KB" },
 { "path": "./dist/vendors*.js", "maxSize": "70KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

28 changes: 28 additions & 0 deletions
packages/clerk-js/src/ui/common/CustomPageContentContainer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { Col, descriptors } from '../customizables';
import { CardAlert, NavbarMenuButtonRow, useCardState, withCardStateProvider } from '../elements';
import type { CustomPageContent } from '../utils';
import { ExternalElementMounter } from '../utils';

export const CustomPageContentContainer = withCardStateProvider(
 ({ mount, unmount }: Omit<CustomPageContent, 'url'>) => {
 const card = useCardState();
 return (
 <Col
 elementDescriptor={descriptors.page}
 gap={8}
 >
 <CardAlert>{card.error}</CardAlert>
 <NavbarMenuButtonRow />
 <Col
 elementDescriptor={descriptors.profilePage}
 gap={8}
 >
 <ExternalElementMounter
 mount={mount}
 unmount={unmount}
 />
 </Col>
 </Col>
 );
 },
);

34 changes: 5 additions & 29 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileNavbar.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
import React from 'react';

import { useCoreOrganization } from '../../contexts';
import type { NavbarRoute } from '../../elements';
import { useCoreOrganization, useOrganizationProfileContext } from '../../contexts';
import { Breadcrumbs, NavBar, NavbarContextProvider, OrganizationPreview } from '../../elements';
import { CogFilled, User } from '../../icons';
import { localizationKeys } from '../../localization';
import type { PropsOfComponent } from '../../styledSystem';

const organizationProfileRoutes: NavbarRoute[] = [
 {
 name: localizationKeys('organizationProfile.start.headerTitle__members'),
 id: 'members',
 icon: User,
 path: '/',
 },
 {
 name: localizationKeys('organizationProfile.start.headerTitle__settings'),
 id: 'settings',
 icon: CogFilled,
 path: 'organization-settings',
 },
];

export const OrganizationProfileNavbar = (
 props: React.PropsWithChildren<Pick<PropsOfComponent<typeof NavBar>, 'contentRef'>>,
) => {
 const { organization } = useCoreOrganization();
 const { pages } = useOrganizationProfileContext();

 if (!organization) {
 return null;
Expand All@@ -41,27 +24,20 @@ export const OrganizationProfileNavbar = (
 sx={t => ({ margin: `0 0 ${t.space.$4} ${t.space.$2}` })}
 />
 }
 routes={organizationProfileRoutes}
 routes={pages.routes}
 contentRef={props.contentRef}
 />
 {props.children}
 </NavbarContextProvider>
 );
};

const pageToRootNavbarRouteMap = {
 'invite-members': organizationProfileRoutes.find(r => r.id === 'members'),
 domain: organizationProfileRoutes.find(r => r.id === 'settings'),
 profile: organizationProfileRoutes.find(r => r.id === 'settings'),
 leave: organizationProfileRoutes.find(r => r.id === 'settings'),
 delete: organizationProfileRoutes.find(r => r.id === 'settings'),
};

export const OrganizationProfileBreadcrumbs = (props: Pick<PropsOfComponent<typeof Breadcrumbs>, 'title'>) => {
 const { pages } = useOrganizationProfileContext();
 return (
 <Breadcrumbs
 {...props}
 pageToRootNavbarRoute={pageToRootNavbarRouteMap}
 pageToRootNavbarRoute={pages.pageToRootNavbarRouteMap}
 />
 );
};

178 changes: 103 additions & 75 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
import { Gate } from '../../common/Gate';
import { Gate } from '../../common';
import { CustomPageContentContainer } from '../../common/CustomPageContentContainer';
import { ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID } from '../../constants';
import { useOrganizationProfileContext } from '../../contexts';
import { ProfileCardContent } from '../../elements';
import { Route, Switch } from '../../router';
import type { PropsOfComponent } from '../../styledSystem';
Expand All@@ -13,100 +16,125 @@ import { VerifiedDomainPage } from './VerifiedDomainPage';
import { VerifyDomainPage } from './VerifyDomainPage';

export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof ProfileCardContent>) => {
 const { pages } = useOrganizationProfileContext();
 const isMembersPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.MEMBERS;
 const isSettingsPageRoot = pages.routes[0].id === ORGANIZATION_PROFILE_NAVBAR_ROUTE_ID.SETTINGS;

 const customPageRoutesWithContents = pages.contents?.map((customPage, index) => {
 const shouldFirstCustomItemBeOnRoot = !isSettingsPageRoot && !isMembersPageRoot && index === 0;
 return (
 <Route
 index={shouldFirstCustomItemBeOnRoot}
 path={shouldFirstCustomItemBeOnRoot ? undefined : customPage.url}
 key={`custom-page-${customPage.url}`}
 >
 <CustomPageContentContainer
 mount={customPage.mount}
 unmount={customPage.unmount}
 />
 </Route>
 );
 });

 return (
 <ProfileCardContent contentRef={props.contentRef}>
 <Route path='organization-settings'>
 <Switch>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 {customPageRoutesWithContents}
 <Route>
 <Route path={isSettingsPageRoot ? undefined : 'organization-settings'}>
 <Switch>
 <Route path=':id/verify'>
 <Route
 path='profile'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:manage'}
 redirectTo='../'
 >
 <VerifyDomainPage />
 <ProfileSettingsPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 <Route
 path='domain'
 flowStart
 >
 <Switch>
 <Route path=':id/verify'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifyDomainPage />
 </Gate>
 </Route>
 <Route path=':id/remove'>
 <Gate
 permission={'org:sys_domains:delete'}
 redirectTo='../../'
 >
 <RemoveDomainPage />
 </Gate>
 </Route>
 <Route path=':id'>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 >
 <VerifiedDomainPage />
 </Gate>
 </Route>
 <Route index>
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 </Gate>
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route path=':id'>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 redirectTo='../../'
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <VerifiedDomainPage />
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route path={isMembersPageRoot ? undefined : 'organization-members'}>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_domains:manage'}
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <AddDomainPage />
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 <Route
 path='leave'
 flowStart
 >
 <LeaveOrganizationPage />
 </Route>
 <Route
 path='delete'
 flowStart
 >
 <Gate
 permission={'org:sys_profile:delete'}
 redirectTo='../'
 >
 <DeleteOrganizationPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationSettings />
 </Route>
 </Switch>
 </Route>
 <Route>
 <Switch>
 <Route
 path='invite-members'
 flowStart
 >
 <Gate
 permission={'org:sys_memberships:manage'}
 redirectTo='../'
 >
 <InviteMembersPage />
 </Gate>
 </Route>
 <Route index>
 <OrganizationMembers />
 </Route>
 </Switch>
 </Route>
 </Route>
 </Switch>
 </ProfileCardContent>
 );
};

34 changes: 34 additions & 0 deletions
...ges/clerk-js/src/ui/components/OrganizationProfile/__tests__/OrganizationProfile.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { CustomPage } from '@clerk/types';
import { describe, it } from '@jest/globals';
import React from 'react';

Expand All@@ -19,4 +20,37 @@ describe('OrganizationProfile', () => {
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 });

 it('includes custom nav items', async () => {
 const { wrapper, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({ email_addresses: ['test@clerk.dev'], organization_memberships: ['Org1'] });
 });

 const customPages: CustomPage[] = [
 {
 label: 'Custom1',
 url: 'custom1',
 mount: () => undefined,
 unmount: () => undefined,
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 {
 label: 'ExternalLink',
 url: '/link',
 mountIcon: () => undefined,
 unmountIcon: () => undefined,
 },
 ];

 props.setProps({ customPages });

 const { getByText } = render(<OrganizationProfile />, { wrapper });
 expect(getByText('Org1')).toBeDefined();
 expect(getByText('Members')).toBeDefined();
 expect(getByText('Settings')).toBeDefined();
 expect(getByText('Custom1')).toBeDefined();
 expect(getByText('ExternalLink')).toBeDefined();
 });
});
Loading