Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .changeset/bright-cats-lay.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/clerk-js': minor
---

Introduce `<TaskSelectOrganization />` component.

It allows you to eject the organization selection task flow from the default `SignIn` and `SignUp` components and render it on custom URL paths using `taskUrls`.

Usage example:
```tsx
<ClerkProvider taskUrls={{ 'select-organization': '/onboarding/select-organization' }}>
<App />
</ClerkProvider>
```

```tsx
function OnboardingSelectOrganization() {
return <TaskSelectOrganization redirectUrlComplete="/dashboard/onboarding-complete" />
}
```
5 changes: 5 additions & 0 deletions .changeset/vast-places-tap.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Add TypeScript types for `<TaskSelectOrganization />` component.
30 changes: 30 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ import type {
SignUpProps,
SignUpRedirectOptions,
SignUpResource,
TaskSelectOrganizationProps,
UnsubscribeCallback,
UserButtonProps,
UserProfileProps,
Expand DownExpand Up@@ -1164,6 +1165,35 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

public mountTaskSelectOrganization = (node: HTMLDivElement, props?: TaskSelectOrganizationProps) => {
this.assertComponentsReady(this.#componentControls);

if (disabledOrganizationsFeature(this, this.environment)) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('TaskSelectOrganization'), {
code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
});
}
return;
}

void this.#componentControls.ensureMounted({ preloadHint: 'TaskSelectOrganization' }).then(controls =>
controls.mountComponent({
name: 'TaskSelectOrganization',
appearanceKey: 'taskSelectOrganization',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted('TaskSelectOrganization', props));
};

public unmountTaskSelectOrganization = (node: HTMLDivElement) => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

/**
* `setActive` can be used to set the active session and/or organization.
*/
Expand Down
24 changes: 13 additions & 11 deletions packages/clerk-js/src/core/sessionTasks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,23 +27,25 @@ export function navigateToTask(
routeKey: keyof typeof INTERNAL_SESSION_TASK_ROUTE_BY_KEY,
{ componentNavigationContext, globalNavigate, options, environment }: NavigateToTaskOptions,
) {
const taskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;
const customTaskUrl = options?.taskUrls?.[routeKey];
const internalTaskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;

if (componentNavigationContext) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + taskRoute);
if (componentNavigationContext && !customTaskUrl) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + internalTaskRoute);
}

const signInUrl = options['signInUrl'] || environment.displayConfig.signInUrl;
const signUpUrl = options['signUpUrl'] || environment.displayConfig.signUpUrl;
const isReferrerSignUpUrl = window.location.href.startsWith(signUpUrl);

const sessionTaskUrl = buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: taskRoute,
},
{ stringify: true },
return globalNavigate(
customTaskUrl ??
buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: internalTaskRoute,
},
{ stringify: true },
),
);

return globalNavigate(options.taskUrls?.[routeKey] ?? sessionTaskUrl);
}
9 changes: 8 additions & 1 deletion packages/clerk-js/src/core/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@ const formatWarning = (msg: string) => {
};

const createMessageForDisabledOrganizations = (
componentName: 'OrganizationProfile' | 'OrganizationSwitcher' | 'OrganizationList' | 'CreateOrganization',
componentName:
| 'OrganizationProfile'
| 'OrganizationSwitcher'
| 'OrganizationList'
| 'CreateOrganization'
| 'TaskSelectOrganization',
) => {
return formatWarning(
`The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
Expand All@@ -23,6 +28,8 @@ const warnings = {
'The <SignUp/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the value set in `afterSignUp` URL instead.',
cannotRenderSignUpComponentWhenTaskExists:
'The <SignUp/> component cannot render when a user has a pending task, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the task instead.',
cannotRenderComponentWhenTaskDoesNotExist:
'<TaskSelectOrganization/> cannot render unless a session task is pending. Clerk is redirecting to the value set in `redirectUrlComplete` instead.',
cannotRenderSignInComponentWhenSessionExists:
'The <SignIn/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the `afterSignIn` URL instead.',
cannotRenderSignInComponentWhenTaskExists:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganization, useOrganizationList } from '@clerk/shared/react';
import { useClerk, useOrganization, useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams, OrganizationResource } from '@clerk/types';
import React, { useContext } from 'react';

Expand DownExpand Up@@ -41,6 +41,7 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
const card = useCardState();
const wizard = useWizard({ onNextStep: () => card.setError(undefined) });
const sessionTasksContext = useContext(SessionTasksContext);
const clerk = useClerk();

const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);
const { createOrganization, isLoaded, setActive, userMemberships } = useOrganizationList({
Expand DownExpand Up@@ -89,13 +90,15 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
lastCreatedOrganizationRef.current = organization;
await setActive({ organization });

void userMemberships.revalidate?.();

if (sessionTasksContext) {
await sessionTasksContext.nextTask();
await clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
return;
}

void userMemberships.revalidate?.();
Comment on lines -92 to +100

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Previously, I've rewritten the entire OrganizationList logic within TaskSelectOrganization to avoid a flicker of UI on revalidation of memberships.

As I started to export TaskSelectOrganization as a public component, I realized that it couldn't receive a custom appearance for OrganizationList.

Simpler solution is just to not revalidate the data in place when resolving a select-organization task.


if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
return completeFlow();
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganizationList, useUser } from '@clerk/shared/react';
import { useClerk, useOrganizationList, useUser } from '@clerk/shared/react';
import type { OrganizationResource } from '@clerk/types';
import { useContext } from 'react';

Expand All@@ -15,6 +15,7 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
const card = useCardState();
const { navigateAfterSelectOrganization } = useOrganizationListContext();
const { isLoaded, setActive } = useOrganizationList();
const clerk = useClerk();
const sessionTasksContext = useContext(SessionTasksContext);

if (!isLoaded) {
Expand All@@ -26,8 +27,10 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
organization,
});

if (sessionTasksContext?.nextTask) {
return sessionTasksContext?.nextTask();
if (sessionTasksContext) {
return clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
}

await navigateAfterSelectOrganization(organization);
Expand Down
34 changes: 16 additions & 18 deletions packages/clerk-js/src/ui/components/SessionTasks/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useCallback, useContext, useEffect, useRef, useState } from 'react';
import { useContext, useEffect, useRef } from 'react';

import { Card } from '@/ui/elements/Card';
import { withCardStateProvider } from '@/ui/elements/contexts';
import { LoadingCardContainer } from '@/ui/elements/LoadingCard';

import { INTERNAL_SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignInContext, SignUpContext } from '../../../ui/contexts';
import { SessionTasksContext, useSessionTasksContext } from '../../contexts/components/SessionTasks';
import {
SessionTasksContext,
TaskSelectOrganizationContext,
useSessionTasksContext,
} from '../../contexts/components/SessionTasks';
import { Route, Switch, useRouter } from '../../router';
import { ForceOrganizationSelectionTask } from './tasks/ForceOrganizationSelection';
import { TaskSelectOrganization } from './tasks/TaskSelectOrganization';

const SessionTasksStart = () => {
const clerk = useClerk();
Expand All@@ -36,10 +40,16 @@ const SessionTasksStart = () => {
};

function SessionTaskRoutes(): JSX.Element {
const ctx = useSessionTasksContext();

return (
<Switch>
<Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['select-organization']}>
<ForceOrganizationSelectionTask />
<TaskSelectOrganizationContext.Provider
value={{ componentName: 'TaskSelectOrganization', redirectUrlComplete: ctx.redirectUrlComplete }}
>
<TaskSelectOrganization />
</TaskSelectOrganizationContext.Provider>
</Route>
<Route index>
<SessionTasksStart />
Expand All@@ -56,7 +66,6 @@ export const SessionTask = withCardStateProvider(() => {
const { navigate } = useRouter();
const signInContext = useContext(SignInContext);
const signUpContext = useContext(SignUpContext);
const [isNavigatingToTask, setIsNavigatingToTask] = useState(false);
const currentTaskContainer = useRef<HTMLDivElement>(null);

const redirectUrlComplete =
Expand All@@ -67,10 +76,6 @@ export const SessionTask = withCardStateProvider(() => {
// for example by using browser back navigation. Since there are no pending tasks,
// we redirect them to their intended destination.
useEffect(() => {
if (isNavigatingToTask) {
return;
}

// Tasks can only exist on pending sessions, but we check both conditions
// here to be defensive and ensure proper redirection
const task = clerk.session?.currentTask;
Expand All@@ -80,14 +85,7 @@ export const SessionTask = withCardStateProvider(() => {
}

clerk.telemetry?.record(eventComponentMounted('SessionTask', { task: task.key }));
}, [clerk, navigate, isNavigatingToTask, redirectUrlComplete]);

const nextTask = useCallback(() => {
setIsNavigatingToTask(true);
return clerk
.__internal_navigateToTaskIfAvailable({ redirectUrlComplete })
.finally(() => setIsNavigatingToTask(false));
}, [clerk, redirectUrlComplete]);
}, [clerk, navigate, redirectUrlComplete]);

if (!clerk.session?.currentTask) {
return (
Expand All@@ -105,7 +103,7 @@ export const SessionTask = withCardStateProvider(() => {
}

return (
<SessionTasksContext.Provider value={{ nextTask, redirectUrlComplete, currentTaskContainer }}>
<SessionTasksContext.Provider value={{ redirectUrlComplete, currentTaskContainer }}>
<SessionTaskRoutes />
</SessionTasksContext.Provider>
);
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .changeset/bright-cats-lay.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/clerk-js': minor
---

Introduce `<TaskSelectOrganization />` component.

It allows you to eject the organization selection task flow from the default `SignIn` and `SignUp` components and render it on custom URL paths using `taskUrls`.

Usage example:
```tsx
<ClerkProvider taskUrls={{ 'select-organization': '/onboarding/select-organization' }}>
<App />
</ClerkProvider>
```

```tsx
function OnboardingSelectOrganization() {
return <TaskSelectOrganization redirectUrlComplete="/dashboard/onboarding-complete" />
}
```
5 changes: 5 additions & 0 deletions .changeset/vast-places-tap.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Add TypeScript types for `<TaskSelectOrganization />` component.
30 changes: 30 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ import type {
SignUpProps,
SignUpRedirectOptions,
SignUpResource,
TaskSelectOrganizationProps,
UnsubscribeCallback,
UserButtonProps,
UserProfileProps,
Expand DownExpand Up@@ -1164,6 +1165,35 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

public mountTaskSelectOrganization = (node: HTMLDivElement, props?: TaskSelectOrganizationProps) => {
this.assertComponentsReady(this.#componentControls);

if (disabledOrganizationsFeature(this, this.environment)) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('TaskSelectOrganization'), {
code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
});
}
return;
}

void this.#componentControls.ensureMounted({ preloadHint: 'TaskSelectOrganization' }).then(controls =>
controls.mountComponent({
name: 'TaskSelectOrganization',
appearanceKey: 'taskSelectOrganization',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted('TaskSelectOrganization', props));
};

public unmountTaskSelectOrganization = (node: HTMLDivElement) => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

/**
* `setActive` can be used to set the active session and/or organization.
*/
Expand Down
24 changes: 13 additions & 11 deletions packages/clerk-js/src/core/sessionTasks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,23 +27,25 @@ export function navigateToTask(
routeKey: keyof typeof INTERNAL_SESSION_TASK_ROUTE_BY_KEY,
{ componentNavigationContext, globalNavigate, options, environment }: NavigateToTaskOptions,
) {
const taskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;
const customTaskUrl = options?.taskUrls?.[routeKey];
const internalTaskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;

if (componentNavigationContext) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + taskRoute);
if (componentNavigationContext && !customTaskUrl) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + internalTaskRoute);
}

const signInUrl = options['signInUrl'] || environment.displayConfig.signInUrl;
const signUpUrl = options['signUpUrl'] || environment.displayConfig.signUpUrl;
const isReferrerSignUpUrl = window.location.href.startsWith(signUpUrl);

const sessionTaskUrl = buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: taskRoute,
},
{ stringify: true },
return globalNavigate(
customTaskUrl ??
buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: internalTaskRoute,
},
{ stringify: true },
),
);

return globalNavigate(options.taskUrls?.[routeKey] ?? sessionTaskUrl);
}
9 changes: 8 additions & 1 deletion packages/clerk-js/src/core/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@ const formatWarning = (msg: string) => {
};

const createMessageForDisabledOrganizations = (
componentName: 'OrganizationProfile' | 'OrganizationSwitcher' | 'OrganizationList' | 'CreateOrganization',
componentName:
| 'OrganizationProfile'
| 'OrganizationSwitcher'
| 'OrganizationList'
| 'CreateOrganization'
| 'TaskSelectOrganization',
) => {
return formatWarning(
`The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
Expand All@@ -23,6 +28,8 @@ const warnings = {
'The <SignUp/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the value set in `afterSignUp` URL instead.',
cannotRenderSignUpComponentWhenTaskExists:
'The <SignUp/> component cannot render when a user has a pending task, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the task instead.',
cannotRenderComponentWhenTaskDoesNotExist:
'<TaskSelectOrganization/> cannot render unless a session task is pending. Clerk is redirecting to the value set in `redirectUrlComplete` instead.',
cannotRenderSignInComponentWhenSessionExists:
'The <SignIn/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the `afterSignIn` URL instead.',
cannotRenderSignInComponentWhenTaskExists:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganization, useOrganizationList } from '@clerk/shared/react';
import { useClerk, useOrganization, useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams, OrganizationResource } from '@clerk/types';
import React, { useContext } from 'react';

Expand DownExpand Up@@ -41,6 +41,7 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
const card = useCardState();
const wizard = useWizard({ onNextStep: () => card.setError(undefined) });
const sessionTasksContext = useContext(SessionTasksContext);
const clerk = useClerk();

const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);
const { createOrganization, isLoaded, setActive, userMemberships } = useOrganizationList({
Expand DownExpand Up@@ -89,13 +90,15 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
lastCreatedOrganizationRef.current = organization;
await setActive({ organization });

void userMemberships.revalidate?.();

if (sessionTasksContext) {
await sessionTasksContext.nextTask();
await clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
return;
}

void userMemberships.revalidate?.();
Comment on lines -92 to +100

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Previously, I've rewritten the entire OrganizationList logic within TaskSelectOrganization to avoid a flicker of UI on revalidation of memberships.

As I started to export TaskSelectOrganization as a public component, I realized that it couldn't receive a custom appearance for OrganizationList.

Simpler solution is just to not revalidate the data in place when resolving a select-organization task.


if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
return completeFlow();
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganizationList, useUser } from '@clerk/shared/react';
import { useClerk, useOrganizationList, useUser } from '@clerk/shared/react';
import type { OrganizationResource } from '@clerk/types';
import { useContext } from 'react';

Expand All@@ -15,6 +15,7 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
const card = useCardState();
const { navigateAfterSelectOrganization } = useOrganizationListContext();
const { isLoaded, setActive } = useOrganizationList();
const clerk = useClerk();
const sessionTasksContext = useContext(SessionTasksContext);

if (!isLoaded) {
Expand All@@ -26,8 +27,10 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
organization,
});

if (sessionTasksContext?.nextTask) {
return sessionTasksContext?.nextTask();
if (sessionTasksContext) {
return clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
}

await navigateAfterSelectOrganization(organization);
Expand Down
34 changes: 16 additions & 18 deletions packages/clerk-js/src/ui/components/SessionTasks/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useCallback, useContext, useEffect, useRef, useState } from 'react';
import { useContext, useEffect, useRef } from 'react';

import { Card } from '@/ui/elements/Card';
import { withCardStateProvider } from '@/ui/elements/contexts';
import { LoadingCardContainer } from '@/ui/elements/LoadingCard';

import { INTERNAL_SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignInContext, SignUpContext } from '../../../ui/contexts';
import { SessionTasksContext, useSessionTasksContext } from '../../contexts/components/SessionTasks';
import {
SessionTasksContext,
TaskSelectOrganizationContext,
useSessionTasksContext,
} from '../../contexts/components/SessionTasks';
import { Route, Switch, useRouter } from '../../router';
import { ForceOrganizationSelectionTask } from './tasks/ForceOrganizationSelection';
import { TaskSelectOrganization } from './tasks/TaskSelectOrganization';

const SessionTasksStart = () => {
const clerk = useClerk();
Expand All@@ -36,10 +40,16 @@ const SessionTasksStart = () => {
};

function SessionTaskRoutes(): JSX.Element {
const ctx = useSessionTasksContext();

return (
<Switch>
<Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['select-organization']}>
<ForceOrganizationSelectionTask />
<TaskSelectOrganizationContext.Provider
value={{ componentName: 'TaskSelectOrganization', redirectUrlComplete: ctx.redirectUrlComplete }}
>
<TaskSelectOrganization />
</TaskSelectOrganizationContext.Provider>
</Route>
<Route index>
<SessionTasksStart />
Expand All@@ -56,7 +66,6 @@ export const SessionTask = withCardStateProvider(() => {
const { navigate } = useRouter();
const signInContext = useContext(SignInContext);
const signUpContext = useContext(SignUpContext);
const [isNavigatingToTask, setIsNavigatingToTask] = useState(false);
const currentTaskContainer = useRef<HTMLDivElement>(null);

const redirectUrlComplete =
Expand All@@ -67,10 +76,6 @@ export const SessionTask = withCardStateProvider(() => {
// for example by using browser back navigation. Since there are no pending tasks,
// we redirect them to their intended destination.
useEffect(() => {
if (isNavigatingToTask) {
return;
}

// Tasks can only exist on pending sessions, but we check both conditions
// here to be defensive and ensure proper redirection
const task = clerk.session?.currentTask;
Expand All@@ -80,14 +85,7 @@ export const SessionTask = withCardStateProvider(() => {
}

clerk.telemetry?.record(eventComponentMounted('SessionTask', { task: task.key }));
}, [clerk, navigate, isNavigatingToTask, redirectUrlComplete]);

const nextTask = useCallback(() => {
setIsNavigatingToTask(true);
return clerk
.__internal_navigateToTaskIfAvailable({ redirectUrlComplete })
.finally(() => setIsNavigatingToTask(false));
}, [clerk, redirectUrlComplete]);
}, [clerk, navigate, redirectUrlComplete]);

if (!clerk.session?.currentTask) {
return (
Expand All@@ -105,7 +103,7 @@ export const SessionTask = withCardStateProvider(() => {
}

return (
<SessionTasksContext.Provider value={{ nextTask, redirectUrlComplete, currentTaskContainer }}>
<SessionTasksContext.Provider value={{ redirectUrlComplete, currentTaskContainer }}>
<SessionTaskRoutes />
</SessionTasksContext.Provider>
);
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .changeset/bright-cats-lay.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/clerk-js': minor
---

Introduce `<TaskSelectOrganization />` component.

It allows you to eject the organization selection task flow from the default `SignIn` and `SignUp` components and render it on custom URL paths using `taskUrls`.

Usage example:
```tsx
<ClerkProvider taskUrls={{ 'select-organization': '/onboarding/select-organization' }}>
<App />
</ClerkProvider>
```

```tsx
function OnboardingSelectOrganization() {
return <TaskSelectOrganization redirectUrlComplete="/dashboard/onboarding-complete" />
}
```
5 changes: 5 additions & 0 deletions .changeset/vast-places-tap.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Add TypeScript types for `<TaskSelectOrganization />` component.
30 changes: 30 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ import type {
SignUpProps,
SignUpRedirectOptions,
SignUpResource,
TaskSelectOrganizationProps,
UnsubscribeCallback,
UserButtonProps,
UserProfileProps,
Expand DownExpand Up@@ -1164,6 +1165,35 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

public mountTaskSelectOrganization = (node: HTMLDivElement, props?: TaskSelectOrganizationProps) => {
this.assertComponentsReady(this.#componentControls);

if (disabledOrganizationsFeature(this, this.environment)) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('TaskSelectOrganization'), {
code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
});
}
return;
}

void this.#componentControls.ensureMounted({ preloadHint: 'TaskSelectOrganization' }).then(controls =>
controls.mountComponent({
name: 'TaskSelectOrganization',
appearanceKey: 'taskSelectOrganization',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted('TaskSelectOrganization', props));
};

public unmountTaskSelectOrganization = (node: HTMLDivElement) => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

/**
* `setActive` can be used to set the active session and/or organization.
*/
Expand Down
24 changes: 13 additions & 11 deletions packages/clerk-js/src/core/sessionTasks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,23 +27,25 @@ export function navigateToTask(
routeKey: keyof typeof INTERNAL_SESSION_TASK_ROUTE_BY_KEY,
{ componentNavigationContext, globalNavigate, options, environment }: NavigateToTaskOptions,
) {
const taskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;
const customTaskUrl = options?.taskUrls?.[routeKey];
const internalTaskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;

if (componentNavigationContext) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + taskRoute);
if (componentNavigationContext && !customTaskUrl) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + internalTaskRoute);
}

const signInUrl = options['signInUrl'] || environment.displayConfig.signInUrl;
const signUpUrl = options['signUpUrl'] || environment.displayConfig.signUpUrl;
const isReferrerSignUpUrl = window.location.href.startsWith(signUpUrl);

const sessionTaskUrl = buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: taskRoute,
},
{ stringify: true },
return globalNavigate(
customTaskUrl ??
buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: internalTaskRoute,
},
{ stringify: true },
),
);

return globalNavigate(options.taskUrls?.[routeKey] ?? sessionTaskUrl);
}
9 changes: 8 additions & 1 deletion packages/clerk-js/src/core/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@ const formatWarning = (msg: string) => {
};

const createMessageForDisabledOrganizations = (
componentName: 'OrganizationProfile' | 'OrganizationSwitcher' | 'OrganizationList' | 'CreateOrganization',
componentName:
| 'OrganizationProfile'
| 'OrganizationSwitcher'
| 'OrganizationList'
| 'CreateOrganization'
| 'TaskSelectOrganization',
) => {
return formatWarning(
`The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
Expand All@@ -23,6 +28,8 @@ const warnings = {
'The <SignUp/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the value set in `afterSignUp` URL instead.',
cannotRenderSignUpComponentWhenTaskExists:
'The <SignUp/> component cannot render when a user has a pending task, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the task instead.',
cannotRenderComponentWhenTaskDoesNotExist:
'<TaskSelectOrganization/> cannot render unless a session task is pending. Clerk is redirecting to the value set in `redirectUrlComplete` instead.',
cannotRenderSignInComponentWhenSessionExists:
'The <SignIn/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the `afterSignIn` URL instead.',
cannotRenderSignInComponentWhenTaskExists:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganization, useOrganizationList } from '@clerk/shared/react';
import { useClerk, useOrganization, useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams, OrganizationResource } from '@clerk/types';
import React, { useContext } from 'react';

Expand DownExpand Up@@ -41,6 +41,7 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
const card = useCardState();
const wizard = useWizard({ onNextStep: () => card.setError(undefined) });
const sessionTasksContext = useContext(SessionTasksContext);
const clerk = useClerk();

const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);
const { createOrganization, isLoaded, setActive, userMemberships } = useOrganizationList({
Expand DownExpand Up@@ -89,13 +90,15 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
lastCreatedOrganizationRef.current = organization;
await setActive({ organization });

void userMemberships.revalidate?.();

if (sessionTasksContext) {
await sessionTasksContext.nextTask();
await clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
return;
}

void userMemberships.revalidate?.();
Comment on lines -92 to +100

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Previously, I've rewritten the entire OrganizationList logic within TaskSelectOrganization to avoid a flicker of UI on revalidation of memberships.

As I started to export TaskSelectOrganization as a public component, I realized that it couldn't receive a custom appearance for OrganizationList.

Simpler solution is just to not revalidate the data in place when resolving a select-organization task.


if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
return completeFlow();
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganizationList, useUser } from '@clerk/shared/react';
import { useClerk, useOrganizationList, useUser } from '@clerk/shared/react';
import type { OrganizationResource } from '@clerk/types';
import { useContext } from 'react';

Expand All@@ -15,6 +15,7 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
const card = useCardState();
const { navigateAfterSelectOrganization } = useOrganizationListContext();
const { isLoaded, setActive } = useOrganizationList();
const clerk = useClerk();
const sessionTasksContext = useContext(SessionTasksContext);

if (!isLoaded) {
Expand All@@ -26,8 +27,10 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
organization,
});

if (sessionTasksContext?.nextTask) {
return sessionTasksContext?.nextTask();
if (sessionTasksContext) {
return clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
}

await navigateAfterSelectOrganization(organization);
Expand Down
34 changes: 16 additions & 18 deletions packages/clerk-js/src/ui/components/SessionTasks/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useCallback, useContext, useEffect, useRef, useState } from 'react';
import { useContext, useEffect, useRef } from 'react';

import { Card } from '@/ui/elements/Card';
import { withCardStateProvider } from '@/ui/elements/contexts';
import { LoadingCardContainer } from '@/ui/elements/LoadingCard';

import { INTERNAL_SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignInContext, SignUpContext } from '../../../ui/contexts';
import { SessionTasksContext, useSessionTasksContext } from '../../contexts/components/SessionTasks';
import {
SessionTasksContext,
TaskSelectOrganizationContext,
useSessionTasksContext,
} from '../../contexts/components/SessionTasks';
import { Route, Switch, useRouter } from '../../router';
import { ForceOrganizationSelectionTask } from './tasks/ForceOrganizationSelection';
import { TaskSelectOrganization } from './tasks/TaskSelectOrganization';

const SessionTasksStart = () => {
const clerk = useClerk();
Expand All@@ -36,10 +40,16 @@ const SessionTasksStart = () => {
};

function SessionTaskRoutes(): JSX.Element {
const ctx = useSessionTasksContext();

return (
<Switch>
<Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['select-organization']}>
<ForceOrganizationSelectionTask />
<TaskSelectOrganizationContext.Provider
value={{ componentName: 'TaskSelectOrganization', redirectUrlComplete: ctx.redirectUrlComplete }}
>
<TaskSelectOrganization />
</TaskSelectOrganizationContext.Provider>
</Route>
<Route index>
<SessionTasksStart />
Expand All@@ -56,7 +66,6 @@ export const SessionTask = withCardStateProvider(() => {
const { navigate } = useRouter();
const signInContext = useContext(SignInContext);
const signUpContext = useContext(SignUpContext);
const [isNavigatingToTask, setIsNavigatingToTask] = useState(false);
const currentTaskContainer = useRef<HTMLDivElement>(null);

const redirectUrlComplete =
Expand All@@ -67,10 +76,6 @@ export const SessionTask = withCardStateProvider(() => {
// for example by using browser back navigation. Since there are no pending tasks,
// we redirect them to their intended destination.
useEffect(() => {
if (isNavigatingToTask) {
return;
}

// Tasks can only exist on pending sessions, but we check both conditions
// here to be defensive and ensure proper redirection
const task = clerk.session?.currentTask;
Expand All@@ -80,14 +85,7 @@ export const SessionTask = withCardStateProvider(() => {
}

clerk.telemetry?.record(eventComponentMounted('SessionTask', { task: task.key }));
}, [clerk, navigate, isNavigatingToTask, redirectUrlComplete]);

const nextTask = useCallback(() => {
setIsNavigatingToTask(true);
return clerk
.__internal_navigateToTaskIfAvailable({ redirectUrlComplete })
.finally(() => setIsNavigatingToTask(false));
}, [clerk, redirectUrlComplete]);
}, [clerk, navigate, redirectUrlComplete]);

if (!clerk.session?.currentTask) {
return (
Expand All@@ -105,7 +103,7 @@ export const SessionTask = withCardStateProvider(() => {
}

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .changeset/bright-cats-lay.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/clerk-js': minor
---

Introduce `<TaskSelectOrganization />` component.

It allows you to eject the organization selection task flow from the default `SignIn` and `SignUp` components and render it on custom URL paths using `taskUrls`.

Usage example:
```tsx
<ClerkProvider taskUrls={{ 'select-organization': '/onboarding/select-organization' }}>
<App />
</ClerkProvider>
```

```tsx
function OnboardingSelectOrganization() {
return <TaskSelectOrganization redirectUrlComplete="/dashboard/onboarding-complete" />
}
```
5 changes: 5 additions & 0 deletions .changeset/vast-places-tap.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Add TypeScript types for `<TaskSelectOrganization />` component.
30 changes: 30 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ import type {
SignUpProps,
SignUpRedirectOptions,
SignUpResource,
TaskSelectOrganizationProps,
UnsubscribeCallback,
UserButtonProps,
UserProfileProps,
Expand DownExpand Up@@ -1164,6 +1165,35 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

public mountTaskSelectOrganization = (node: HTMLDivElement, props?: TaskSelectOrganizationProps) => {
this.assertComponentsReady(this.#componentControls);

if (disabledOrganizationsFeature(this, this.environment)) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('TaskSelectOrganization'), {
code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
});
}
return;
}

void this.#componentControls.ensureMounted({ preloadHint: 'TaskSelectOrganization' }).then(controls =>
controls.mountComponent({
name: 'TaskSelectOrganization',
appearanceKey: 'taskSelectOrganization',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted('TaskSelectOrganization', props));
};

public unmountTaskSelectOrganization = (node: HTMLDivElement) => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

/**
* `setActive` can be used to set the active session and/or organization.
*/
Expand Down
24 changes: 13 additions & 11 deletions packages/clerk-js/src/core/sessionTasks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,23 +27,25 @@ export function navigateToTask(
routeKey: keyof typeof INTERNAL_SESSION_TASK_ROUTE_BY_KEY,
{ componentNavigationContext, globalNavigate, options, environment }: NavigateToTaskOptions,
) {
const taskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;
const customTaskUrl = options?.taskUrls?.[routeKey];
const internalTaskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;

if (componentNavigationContext) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + taskRoute);
if (componentNavigationContext && !customTaskUrl) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + internalTaskRoute);
}

const signInUrl = options['signInUrl'] || environment.displayConfig.signInUrl;
const signUpUrl = options['signUpUrl'] || environment.displayConfig.signUpUrl;
const isReferrerSignUpUrl = window.location.href.startsWith(signUpUrl);

const sessionTaskUrl = buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: taskRoute,
},
{ stringify: true },
return globalNavigate(
customTaskUrl ??
buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: internalTaskRoute,
},
{ stringify: true },
),
);

return globalNavigate(options.taskUrls?.[routeKey] ?? sessionTaskUrl);
}
9 changes: 8 additions & 1 deletion packages/clerk-js/src/core/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@ const formatWarning = (msg: string) => {
};

const createMessageForDisabledOrganizations = (
componentName: 'OrganizationProfile' | 'OrganizationSwitcher' | 'OrganizationList' | 'CreateOrganization',
componentName:
| 'OrganizationProfile'
| 'OrganizationSwitcher'
| 'OrganizationList'
| 'CreateOrganization'
| 'TaskSelectOrganization',
) => {
return formatWarning(
`The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
Expand All@@ -23,6 +28,8 @@ const warnings = {
'The <SignUp/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the value set in `afterSignUp` URL instead.',
cannotRenderSignUpComponentWhenTaskExists:
'The <SignUp/> component cannot render when a user has a pending task, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the task instead.',
cannotRenderComponentWhenTaskDoesNotExist:
'<TaskSelectOrganization/> cannot render unless a session task is pending. Clerk is redirecting to the value set in `redirectUrlComplete` instead.',
cannotRenderSignInComponentWhenSessionExists:
'The <SignIn/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the `afterSignIn` URL instead.',
cannotRenderSignInComponentWhenTaskExists:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganization, useOrganizationList } from '@clerk/shared/react';
import { useClerk, useOrganization, useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams, OrganizationResource } from '@clerk/types';
import React, { useContext } from 'react';

Expand DownExpand Up@@ -41,6 +41,7 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
const card = useCardState();
const wizard = useWizard({ onNextStep: () => card.setError(undefined) });
const sessionTasksContext = useContext(SessionTasksContext);
const clerk = useClerk();

const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);
const { createOrganization, isLoaded, setActive, userMemberships } = useOrganizationList({
Expand DownExpand Up@@ -89,13 +90,15 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
lastCreatedOrganizationRef.current = organization;
await setActive({ organization });

void userMemberships.revalidate?.();

if (sessionTasksContext) {
await sessionTasksContext.nextTask();
await clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
return;
}

void userMemberships.revalidate?.();
Comment on lines -92 to +100

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Previously, I've rewritten the entire OrganizationList logic within TaskSelectOrganization to avoid a flicker of UI on revalidation of memberships.

As I started to export TaskSelectOrganization as a public component, I realized that it couldn't receive a custom appearance for OrganizationList.

Simpler solution is just to not revalidate the data in place when resolving a select-organization task.


if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
return completeFlow();
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganizationList, useUser } from '@clerk/shared/react';
import { useClerk, useOrganizationList, useUser } from '@clerk/shared/react';
import type { OrganizationResource } from '@clerk/types';
import { useContext } from 'react';

Expand All@@ -15,6 +15,7 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
const card = useCardState();
const { navigateAfterSelectOrganization } = useOrganizationListContext();
const { isLoaded, setActive } = useOrganizationList();
const clerk = useClerk();
const sessionTasksContext = useContext(SessionTasksContext);

if (!isLoaded) {
Expand All@@ -26,8 +27,10 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
organization,
});

if (sessionTasksContext?.nextTask) {
return sessionTasksContext?.nextTask();
if (sessionTasksContext) {
return clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
}

await navigateAfterSelectOrganization(organization);
Expand Down
34 changes: 16 additions & 18 deletions packages/clerk-js/src/ui/components/SessionTasks/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useCallback, useContext, useEffect, useRef, useState } from 'react';
import { useContext, useEffect, useRef } from 'react';

import { Card } from '@/ui/elements/Card';
import { withCardStateProvider } from '@/ui/elements/contexts';
import { LoadingCardContainer } from '@/ui/elements/LoadingCard';

import { INTERNAL_SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignInContext, SignUpContext } from '../../../ui/contexts';
import { SessionTasksContext, useSessionTasksContext } from '../../contexts/components/SessionTasks';
import {
SessionTasksContext,
TaskSelectOrganizationContext,
useSessionTasksContext,
} from '../../contexts/components/SessionTasks';
import { Route, Switch, useRouter } from '../../router';
import { ForceOrganizationSelectionTask } from './tasks/ForceOrganizationSelection';
import { TaskSelectOrganization } from './tasks/TaskSelectOrganization';

const SessionTasksStart = () => {
const clerk = useClerk();
Expand All@@ -36,10 +40,16 @@ const SessionTasksStart = () => {
};

function SessionTaskRoutes(): JSX.Element {
const ctx = useSessionTasksContext();

return (
<Switch>
<Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['select-organization']}>
<ForceOrganizationSelectionTask />
<TaskSelectOrganizationContext.Provider
value={{ componentName: 'TaskSelectOrganization', redirectUrlComplete: ctx.redirectUrlComplete }}
>
<TaskSelectOrganization />
</TaskSelectOrganizationContext.Provider>
</Route>
<Route index>
<SessionTasksStart />
Expand All@@ -56,7 +66,6 @@ export const SessionTask = withCardStateProvider(() => {
const { navigate } = useRouter();
const signInContext = useContext(SignInContext);
const signUpContext = useContext(SignUpContext);
const [isNavigatingToTask, setIsNavigatingToTask] = useState(false);
const currentTaskContainer = useRef<HTMLDivElement>(null);

const redirectUrlComplete =
Expand All@@ -67,10 +76,6 @@ export const SessionTask = withCardStateProvider(() => {
// for example by using browser back navigation. Since there are no pending tasks,
// we redirect them to their intended destination.
useEffect(() => {
if (isNavigatingToTask) {
return;
}

// Tasks can only exist on pending sessions, but we check both conditions
// here to be defensive and ensure proper redirection
const task = clerk.session?.currentTask;
Expand All@@ -80,14 +85,7 @@ export const SessionTask = withCardStateProvider(() => {
}

clerk.telemetry?.record(eventComponentMounted('SessionTask', { task: task.key }));
}, [clerk, navigate, isNavigatingToTask, redirectUrlComplete]);

const nextTask = useCallback(() => {
setIsNavigatingToTask(true);
return clerk
.__internal_navigateToTaskIfAvailable({ redirectUrlComplete })
.finally(() => setIsNavigatingToTask(false));
}, [clerk, redirectUrlComplete]);
}, [clerk, navigate, redirectUrlComplete]);

if (!clerk.session?.currentTask) {
return (
Expand All@@ -105,7 +103,7 @@ export const SessionTask = withCardStateProvider(() => {
}

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .changeset/bright-cats-lay.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/clerk-js': minor
---

Introduce `<TaskSelectOrganization />` component.

It allows you to eject the organization selection task flow from the default `SignIn` and `SignUp` components and render it on custom URL paths using `taskUrls`.

Usage example:
```tsx
<ClerkProvider taskUrls={{ 'select-organization': '/onboarding/select-organization' }}>
<App />
</ClerkProvider>
```

```tsx
function OnboardingSelectOrganization() {
return <TaskSelectOrganization redirectUrlComplete="/dashboard/onboarding-complete" />
}
```
5 changes: 5 additions & 0 deletions .changeset/vast-places-tap.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Add TypeScript types for `<TaskSelectOrganization />` component.
30 changes: 30 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ import type {
SignUpProps,
SignUpRedirectOptions,
SignUpResource,
TaskSelectOrganizationProps,
UnsubscribeCallback,
UserButtonProps,
UserProfileProps,
Expand DownExpand Up@@ -1164,6 +1165,35 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

public mountTaskSelectOrganization = (node: HTMLDivElement, props?: TaskSelectOrganizationProps) => {
this.assertComponentsReady(this.#componentControls);

if (disabledOrganizationsFeature(this, this.environment)) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('TaskSelectOrganization'), {
code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
});
}
return;
}

void this.#componentControls.ensureMounted({ preloadHint: 'TaskSelectOrganization' }).then(controls =>
controls.mountComponent({
name: 'TaskSelectOrganization',
appearanceKey: 'taskSelectOrganization',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted('TaskSelectOrganization', props));
};

public unmountTaskSelectOrganization = (node: HTMLDivElement) => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

/**
* `setActive` can be used to set the active session and/or organization.
*/
Expand Down
24 changes: 13 additions & 11 deletions packages/clerk-js/src/core/sessionTasks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,23 +27,25 @@ export function navigateToTask(
routeKey: keyof typeof INTERNAL_SESSION_TASK_ROUTE_BY_KEY,
{ componentNavigationContext, globalNavigate, options, environment }: NavigateToTaskOptions,
) {
const taskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;
const customTaskUrl = options?.taskUrls?.[routeKey];
const internalTaskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;

if (componentNavigationContext) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + taskRoute);
if (componentNavigationContext && !customTaskUrl) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + internalTaskRoute);
}

const signInUrl = options['signInUrl'] || environment.displayConfig.signInUrl;
const signUpUrl = options['signUpUrl'] || environment.displayConfig.signUpUrl;
const isReferrerSignUpUrl = window.location.href.startsWith(signUpUrl);

const sessionTaskUrl = buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: taskRoute,
},
{ stringify: true },
return globalNavigate(
customTaskUrl ??
buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: internalTaskRoute,
},
{ stringify: true },
),
);

return globalNavigate(options.taskUrls?.[routeKey] ?? sessionTaskUrl);
}
9 changes: 8 additions & 1 deletion packages/clerk-js/src/core/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@ const formatWarning = (msg: string) => {
};

const createMessageForDisabledOrganizations = (
componentName: 'OrganizationProfile' | 'OrganizationSwitcher' | 'OrganizationList' | 'CreateOrganization',
componentName:
| 'OrganizationProfile'
| 'OrganizationSwitcher'
| 'OrganizationList'
| 'CreateOrganization'
| 'TaskSelectOrganization',
) => {
return formatWarning(
`The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
Expand All@@ -23,6 +28,8 @@ const warnings = {
'The <SignUp/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the value set in `afterSignUp` URL instead.',
cannotRenderSignUpComponentWhenTaskExists:
'The <SignUp/> component cannot render when a user has a pending task, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the task instead.',
cannotRenderComponentWhenTaskDoesNotExist:
'<TaskSelectOrganization/> cannot render unless a session task is pending. Clerk is redirecting to the value set in `redirectUrlComplete` instead.',
cannotRenderSignInComponentWhenSessionExists:
'The <SignIn/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the `afterSignIn` URL instead.',
cannotRenderSignInComponentWhenTaskExists:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganization, useOrganizationList } from '@clerk/shared/react';
import { useClerk, useOrganization, useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams, OrganizationResource } from '@clerk/types';
import React, { useContext } from 'react';

Expand DownExpand Up@@ -41,6 +41,7 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
const card = useCardState();
const wizard = useWizard({ onNextStep: () => card.setError(undefined) });
const sessionTasksContext = useContext(SessionTasksContext);
const clerk = useClerk();

const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);
const { createOrganization, isLoaded, setActive, userMemberships } = useOrganizationList({
Expand DownExpand Up@@ -89,13 +90,15 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
lastCreatedOrganizationRef.current = organization;
await setActive({ organization });

void userMemberships.revalidate?.();

if (sessionTasksContext) {
await sessionTasksContext.nextTask();
await clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
return;
}

void userMemberships.revalidate?.();
Comment on lines -92 to +100

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Previously, I've rewritten the entire OrganizationList logic within TaskSelectOrganization to avoid a flicker of UI on revalidation of memberships.

As I started to export TaskSelectOrganization as a public component, I realized that it couldn't receive a custom appearance for OrganizationList.

Simpler solution is just to not revalidate the data in place when resolving a select-organization task.


if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
return completeFlow();
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganizationList, useUser } from '@clerk/shared/react';
import { useClerk, useOrganizationList, useUser } from '@clerk/shared/react';
import type { OrganizationResource } from '@clerk/types';
import { useContext } from 'react';

Expand All@@ -15,6 +15,7 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
const card = useCardState();
const { navigateAfterSelectOrganization } = useOrganizationListContext();
const { isLoaded, setActive } = useOrganizationList();
const clerk = useClerk();
const sessionTasksContext = useContext(SessionTasksContext);

if (!isLoaded) {
Expand All@@ -26,8 +27,10 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
organization,
});

if (sessionTasksContext?.nextTask) {
return sessionTasksContext?.nextTask();
if (sessionTasksContext) {
return clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
}

await navigateAfterSelectOrganization(organization);
Expand Down
34 changes: 16 additions & 18 deletions packages/clerk-js/src/ui/components/SessionTasks/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useCallback, useContext, useEffect, useRef, useState } from 'react';
import { useContext, useEffect, useRef } from 'react';

import { Card } from '@/ui/elements/Card';
import { withCardStateProvider } from '@/ui/elements/contexts';
import { LoadingCardContainer } from '@/ui/elements/LoadingCard';

import { INTERNAL_SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignInContext, SignUpContext } from '../../../ui/contexts';
import { SessionTasksContext, useSessionTasksContext } from '../../contexts/components/SessionTasks';
import {
SessionTasksContext,
TaskSelectOrganizationContext,
useSessionTasksContext,
} from '../../contexts/components/SessionTasks';
import { Route, Switch, useRouter } from '../../router';
import { ForceOrganizationSelectionTask } from './tasks/ForceOrganizationSelection';
import { TaskSelectOrganization } from './tasks/TaskSelectOrganization';

const SessionTasksStart = () => {
const clerk = useClerk();
Expand All@@ -36,10 +40,16 @@ const SessionTasksStart = () => {
};

function SessionTaskRoutes(): JSX.Element {
const ctx = useSessionTasksContext();

return (
<Switch>
<Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['select-organization']}>
<ForceOrganizationSelectionTask />
<TaskSelectOrganizationContext.Provider
value={{ componentName: 'TaskSelectOrganization', redirectUrlComplete: ctx.redirectUrlComplete }}
>
<TaskSelectOrganization />
</TaskSelectOrganizationContext.Provider>
</Route>
<Route index>
<SessionTasksStart />
Expand All@@ -56,7 +66,6 @@ export const SessionTask = withCardStateProvider(() => {
const { navigate } = useRouter();
const signInContext = useContext(SignInContext);
const signUpContext = useContext(SignUpContext);
const [isNavigatingToTask, setIsNavigatingToTask] = useState(false);
const currentTaskContainer = useRef<HTMLDivElement>(null);

const redirectUrlComplete =
Expand All@@ -67,10 +76,6 @@ export const SessionTask = withCardStateProvider(() => {
// for example by using browser back navigation. Since there are no pending tasks,
// we redirect them to their intended destination.
useEffect(() => {
if (isNavigatingToTask) {
return;
}

// Tasks can only exist on pending sessions, but we check both conditions
// here to be defensive and ensure proper redirection
const task = clerk.session?.currentTask;
Expand All@@ -80,14 +85,7 @@ export const SessionTask = withCardStateProvider(() => {
}

clerk.telemetry?.record(eventComponentMounted('SessionTask', { task: task.key }));
}, [clerk, navigate, isNavigatingToTask, redirectUrlComplete]);

const nextTask = useCallback(() => {
setIsNavigatingToTask(true);
return clerk
.__internal_navigateToTaskIfAvailable({ redirectUrlComplete })
.finally(() => setIsNavigatingToTask(false));
}, [clerk, redirectUrlComplete]);
}, [clerk, navigate, redirectUrlComplete]);

if (!clerk.session?.currentTask) {
return (
Expand All@@ -105,7 +103,7 @@ export const SessionTask = withCardStateProvider(() => {
}

return (
<SessionTasksContext.Provider value={{ nextTask, redirectUrlComplete, currentTaskContainer }}>
<SessionTasksContext.Provider value={{ redirectUrlComplete, currentTaskContainer }}>
<SessionTaskRoutes />
</SessionTasksContext.Provider>
);
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .changeset/bright-cats-lay.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/clerk-js': minor
---

Introduce `<TaskSelectOrganization />` component.

It allows you to eject the organization selection task flow from the default `SignIn` and `SignUp` components and render it on custom URL paths using `taskUrls`.

Usage example:
```tsx
<ClerkProvider taskUrls={{ 'select-organization': '/onboarding/select-organization' }}>
<App />
</ClerkProvider>
```

```tsx
function OnboardingSelectOrganization() {
return <TaskSelectOrganization redirectUrlComplete="/dashboard/onboarding-complete" />
}
```
5 changes: 5 additions & 0 deletions .changeset/vast-places-tap.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Add TypeScript types for `<TaskSelectOrganization />` component.
30 changes: 30 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ import type {
SignUpProps,
SignUpRedirectOptions,
SignUpResource,
TaskSelectOrganizationProps,
UnsubscribeCallback,
UserButtonProps,
UserProfileProps,
Expand DownExpand Up@@ -1164,6 +1165,35 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

public mountTaskSelectOrganization = (node: HTMLDivElement, props?: TaskSelectOrganizationProps) => {
this.assertComponentsReady(this.#componentControls);

if (disabledOrganizationsFeature(this, this.environment)) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('TaskSelectOrganization'), {
code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
});
}
return;
}

void this.#componentControls.ensureMounted({ preloadHint: 'TaskSelectOrganization' }).then(controls =>
controls.mountComponent({
name: 'TaskSelectOrganization',
appearanceKey: 'taskSelectOrganization',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted('TaskSelectOrganization', props));
};

public unmountTaskSelectOrganization = (node: HTMLDivElement) => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

/**
* `setActive` can be used to set the active session and/or organization.
*/
Expand Down
24 changes: 13 additions & 11 deletions packages/clerk-js/src/core/sessionTasks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,23 +27,25 @@ export function navigateToTask(
routeKey: keyof typeof INTERNAL_SESSION_TASK_ROUTE_BY_KEY,
{ componentNavigationContext, globalNavigate, options, environment }: NavigateToTaskOptions,
) {
const taskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;
const customTaskUrl = options?.taskUrls?.[routeKey];
const internalTaskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;

if (componentNavigationContext) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + taskRoute);
if (componentNavigationContext && !customTaskUrl) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + internalTaskRoute);
}

const signInUrl = options['signInUrl'] || environment.displayConfig.signInUrl;
const signUpUrl = options['signUpUrl'] || environment.displayConfig.signUpUrl;
const isReferrerSignUpUrl = window.location.href.startsWith(signUpUrl);

const sessionTaskUrl = buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: taskRoute,
},
{ stringify: true },
return globalNavigate(
customTaskUrl ??
buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: internalTaskRoute,
},
{ stringify: true },
),
);

return globalNavigate(options.taskUrls?.[routeKey] ?? sessionTaskUrl);
}
9 changes: 8 additions & 1 deletion packages/clerk-js/src/core/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@ const formatWarning = (msg: string) => {
};

const createMessageForDisabledOrganizations = (
componentName: 'OrganizationProfile' | 'OrganizationSwitcher' | 'OrganizationList' | 'CreateOrganization',
componentName:
| 'OrganizationProfile'
| 'OrganizationSwitcher'
| 'OrganizationList'
| 'CreateOrganization'
| 'TaskSelectOrganization',
) => {
return formatWarning(
`The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
Expand All@@ -23,6 +28,8 @@ const warnings = {
'The <SignUp/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the value set in `afterSignUp` URL instead.',
cannotRenderSignUpComponentWhenTaskExists:
'The <SignUp/> component cannot render when a user has a pending task, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the task instead.',
cannotRenderComponentWhenTaskDoesNotExist:
'<TaskSelectOrganization/> cannot render unless a session task is pending. Clerk is redirecting to the value set in `redirectUrlComplete` instead.',
cannotRenderSignInComponentWhenSessionExists:
'The <SignIn/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the `afterSignIn` URL instead.',
cannotRenderSignInComponentWhenTaskExists:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganization, useOrganizationList } from '@clerk/shared/react';
import { useClerk, useOrganization, useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams, OrganizationResource } from '@clerk/types';
import React, { useContext } from 'react';

Expand DownExpand Up@@ -41,6 +41,7 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
const card = useCardState();
const wizard = useWizard({ onNextStep: () => card.setError(undefined) });
const sessionTasksContext = useContext(SessionTasksContext);
const clerk = useClerk();

const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);
const { createOrganization, isLoaded, setActive, userMemberships } = useOrganizationList({
Expand DownExpand Up@@ -89,13 +90,15 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
lastCreatedOrganizationRef.current = organization;
await setActive({ organization });

void userMemberships.revalidate?.();

if (sessionTasksContext) {
await sessionTasksContext.nextTask();
await clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
return;
}

void userMemberships.revalidate?.();
Comment on lines -92 to +100

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Previously, I've rewritten the entire OrganizationList logic within TaskSelectOrganization to avoid a flicker of UI on revalidation of memberships.

As I started to export TaskSelectOrganization as a public component, I realized that it couldn't receive a custom appearance for OrganizationList.

Simpler solution is just to not revalidate the data in place when resolving a select-organization task.


if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
return completeFlow();
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganizationList, useUser } from '@clerk/shared/react';
import { useClerk, useOrganizationList, useUser } from '@clerk/shared/react';
import type { OrganizationResource } from '@clerk/types';
import { useContext } from 'react';

Expand All@@ -15,6 +15,7 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
const card = useCardState();
const { navigateAfterSelectOrganization } = useOrganizationListContext();
const { isLoaded, setActive } = useOrganizationList();
const clerk = useClerk();
const sessionTasksContext = useContext(SessionTasksContext);

if (!isLoaded) {
Expand All@@ -26,8 +27,10 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
organization,
});

if (sessionTasksContext?.nextTask) {
return sessionTasksContext?.nextTask();
if (sessionTasksContext) {
return clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
}

await navigateAfterSelectOrganization(organization);
Expand Down
34 changes: 16 additions & 18 deletions packages/clerk-js/src/ui/components/SessionTasks/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useCallback, useContext, useEffect, useRef, useState } from 'react';
import { useContext, useEffect, useRef } from 'react';

import { Card } from '@/ui/elements/Card';
import { withCardStateProvider } from '@/ui/elements/contexts';
import { LoadingCardContainer } from '@/ui/elements/LoadingCard';

import { INTERNAL_SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignInContext, SignUpContext } from '../../../ui/contexts';
import { SessionTasksContext, useSessionTasksContext } from '../../contexts/components/SessionTasks';
import {
SessionTasksContext,
TaskSelectOrganizationContext,
useSessionTasksContext,
} from '../../contexts/components/SessionTasks';
import { Route, Switch, useRouter } from '../../router';
import { ForceOrganizationSelectionTask } from './tasks/ForceOrganizationSelection';
import { TaskSelectOrganization } from './tasks/TaskSelectOrganization';

const SessionTasksStart = () => {
const clerk = useClerk();
Expand All@@ -36,10 +40,16 @@ const SessionTasksStart = () => {
};

function SessionTaskRoutes(): JSX.Element {
const ctx = useSessionTasksContext();

return (
<Switch>
<Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['select-organization']}>
<ForceOrganizationSelectionTask />
<TaskSelectOrganizationContext.Provider
value={{ componentName: 'TaskSelectOrganization', redirectUrlComplete: ctx.redirectUrlComplete }}
>
<TaskSelectOrganization />
</TaskSelectOrganizationContext.Provider>
</Route>
<Route index>
<SessionTasksStart />
Expand All@@ -56,7 +66,6 @@ export const SessionTask = withCardStateProvider(() => {
const { navigate } = useRouter();
const signInContext = useContext(SignInContext);
const signUpContext = useContext(SignUpContext);
const [isNavigatingToTask, setIsNavigatingToTask] = useState(false);
const currentTaskContainer = useRef<HTMLDivElement>(null);

const redirectUrlComplete =
Expand All@@ -67,10 +76,6 @@ export const SessionTask = withCardStateProvider(() => {
// for example by using browser back navigation. Since there are no pending tasks,
// we redirect them to their intended destination.
useEffect(() => {
if (isNavigatingToTask) {
return;
}

// Tasks can only exist on pending sessions, but we check both conditions
// here to be defensive and ensure proper redirection
const task = clerk.session?.currentTask;
Expand All@@ -80,14 +85,7 @@ export const SessionTask = withCardStateProvider(() => {
}

clerk.telemetry?.record(eventComponentMounted('SessionTask', { task: task.key }));
}, [clerk, navigate, isNavigatingToTask, redirectUrlComplete]);

const nextTask = useCallback(() => {
setIsNavigatingToTask(true);
return clerk
.__internal_navigateToTaskIfAvailable({ redirectUrlComplete })
.finally(() => setIsNavigatingToTask(false));
}, [clerk, redirectUrlComplete]);
}, [clerk, navigate, redirectUrlComplete]);

if (!clerk.session?.currentTask) {
return (
Expand All@@ -105,7 +103,7 @@ export const SessionTask = withCardStateProvider(() => {
}

return (
<SessionTasksContext.Provider value={{ nextTask, redirectUrlComplete, currentTaskContainer }}>
<SessionTasksContext.Provider value={{ redirectUrlComplete, currentTaskContainer }}>
<SessionTaskRoutes />
</SessionTasksContext.Provider>
);
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .changeset/bright-cats-lay.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/clerk-js': minor
---

Introduce `<TaskSelectOrganization />` component.

It allows you to eject the organization selection task flow from the default `SignIn` and `SignUp` components and render it on custom URL paths using `taskUrls`.

Usage example:
```tsx
<ClerkProvider taskUrls={{ 'select-organization': '/onboarding/select-organization' }}>
<App />
</ClerkProvider>
```

```tsx
function OnboardingSelectOrganization() {
return <TaskSelectOrganization redirectUrlComplete="/dashboard/onboarding-complete" />
}
```
5 changes: 5 additions & 0 deletions .changeset/vast-places-tap.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Add TypeScript types for `<TaskSelectOrganization />` component.
30 changes: 30 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ import type {
SignUpProps,
SignUpRedirectOptions,
SignUpResource,
TaskSelectOrganizationProps,
UnsubscribeCallback,
UserButtonProps,
UserProfileProps,
Expand DownExpand Up@@ -1164,6 +1165,35 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

public mountTaskSelectOrganization = (node: HTMLDivElement, props?: TaskSelectOrganizationProps) => {
this.assertComponentsReady(this.#componentControls);

if (disabledOrganizationsFeature(this, this.environment)) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('TaskSelectOrganization'), {
code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
});
}
return;
}

void this.#componentControls.ensureMounted({ preloadHint: 'TaskSelectOrganization' }).then(controls =>
controls.mountComponent({
name: 'TaskSelectOrganization',
appearanceKey: 'taskSelectOrganization',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted('TaskSelectOrganization', props));
};

public unmountTaskSelectOrganization = (node: HTMLDivElement) => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

/**
* `setActive` can be used to set the active session and/or organization.
*/
Expand Down
24 changes: 13 additions & 11 deletions packages/clerk-js/src/core/sessionTasks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,23 +27,25 @@ export function navigateToTask(
routeKey: keyof typeof INTERNAL_SESSION_TASK_ROUTE_BY_KEY,
{ componentNavigationContext, globalNavigate, options, environment }: NavigateToTaskOptions,
) {
const taskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;
const customTaskUrl = options?.taskUrls?.[routeKey];
const internalTaskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;

if (componentNavigationContext) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + taskRoute);
if (componentNavigationContext && !customTaskUrl) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + internalTaskRoute);
}

const signInUrl = options['signInUrl'] || environment.displayConfig.signInUrl;
const signUpUrl = options['signUpUrl'] || environment.displayConfig.signUpUrl;
const isReferrerSignUpUrl = window.location.href.startsWith(signUpUrl);

const sessionTaskUrl = buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: taskRoute,
},
{ stringify: true },
return globalNavigate(
customTaskUrl ??
buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: internalTaskRoute,
},
{ stringify: true },
),
);

return globalNavigate(options.taskUrls?.[routeKey] ?? sessionTaskUrl);
}
9 changes: 8 additions & 1 deletion packages/clerk-js/src/core/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@ const formatWarning = (msg: string) => {
};

const createMessageForDisabledOrganizations = (
componentName: 'OrganizationProfile' | 'OrganizationSwitcher' | 'OrganizationList' | 'CreateOrganization',
componentName:
| 'OrganizationProfile'
| 'OrganizationSwitcher'
| 'OrganizationList'
| 'CreateOrganization'
| 'TaskSelectOrganization',
) => {
return formatWarning(
`The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
Expand All@@ -23,6 +28,8 @@ const warnings = {
'The <SignUp/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the value set in `afterSignUp` URL instead.',
cannotRenderSignUpComponentWhenTaskExists:
'The <SignUp/> component cannot render when a user has a pending task, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the task instead.',
cannotRenderComponentWhenTaskDoesNotExist:
'<TaskSelectOrganization/> cannot render unless a session task is pending. Clerk is redirecting to the value set in `redirectUrlComplete` instead.',
cannotRenderSignInComponentWhenSessionExists:
'The <SignIn/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the `afterSignIn` URL instead.',
cannotRenderSignInComponentWhenTaskExists:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganization, useOrganizationList } from '@clerk/shared/react';
import { useClerk, useOrganization, useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams, OrganizationResource } from '@clerk/types';
import React, { useContext } from 'react';

Expand DownExpand Up@@ -41,6 +41,7 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
const card = useCardState();
const wizard = useWizard({ onNextStep: () => card.setError(undefined) });
const sessionTasksContext = useContext(SessionTasksContext);
const clerk = useClerk();

const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);
const { createOrganization, isLoaded, setActive, userMemberships } = useOrganizationList({
Expand DownExpand Up@@ -89,13 +90,15 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
lastCreatedOrganizationRef.current = organization;
await setActive({ organization });

void userMemberships.revalidate?.();

if (sessionTasksContext) {
await sessionTasksContext.nextTask();
await clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
return;
}

void userMemberships.revalidate?.();
Comment on lines -92 to +100

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Previously, I've rewritten the entire OrganizationList logic within TaskSelectOrganization to avoid a flicker of UI on revalidation of memberships.

As I started to export TaskSelectOrganization as a public component, I realized that it couldn't receive a custom appearance for OrganizationList.

Simpler solution is just to not revalidate the data in place when resolving a select-organization task.


if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
return completeFlow();
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganizationList, useUser } from '@clerk/shared/react';
import { useClerk, useOrganizationList, useUser } from '@clerk/shared/react';
import type { OrganizationResource } from '@clerk/types';
import { useContext } from 'react';

Expand All@@ -15,6 +15,7 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
const card = useCardState();
const { navigateAfterSelectOrganization } = useOrganizationListContext();
const { isLoaded, setActive } = useOrganizationList();
const clerk = useClerk();
const sessionTasksContext = useContext(SessionTasksContext);

if (!isLoaded) {
Expand All@@ -26,8 +27,10 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
organization,
});

if (sessionTasksContext?.nextTask) {
return sessionTasksContext?.nextTask();
if (sessionTasksContext) {
return clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
}

await navigateAfterSelectOrganization(organization);
Expand Down
34 changes: 16 additions & 18 deletions packages/clerk-js/src/ui/components/SessionTasks/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useCallback, useContext, useEffect, useRef, useState } from 'react';
import { useContext, useEffect, useRef } from 'react';

import { Card } from '@/ui/elements/Card';
import { withCardStateProvider } from '@/ui/elements/contexts';
import { LoadingCardContainer } from '@/ui/elements/LoadingCard';

import { INTERNAL_SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignInContext, SignUpContext } from '../../../ui/contexts';
import { SessionTasksContext, useSessionTasksContext } from '../../contexts/components/SessionTasks';
import {
SessionTasksContext,
TaskSelectOrganizationContext,
useSessionTasksContext,
} from '../../contexts/components/SessionTasks';
import { Route, Switch, useRouter } from '../../router';
import { ForceOrganizationSelectionTask } from './tasks/ForceOrganizationSelection';
import { TaskSelectOrganization } from './tasks/TaskSelectOrganization';

const SessionTasksStart = () => {
const clerk = useClerk();
Expand All@@ -36,10 +40,16 @@ const SessionTasksStart = () => {
};

function SessionTaskRoutes(): JSX.Element {
const ctx = useSessionTasksContext();

return (
<Switch>
<Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['select-organization']}>
<ForceOrganizationSelectionTask />
<TaskSelectOrganizationContext.Provider
value={{ componentName: 'TaskSelectOrganization', redirectUrlComplete: ctx.redirectUrlComplete }}
>
<TaskSelectOrganization />
</TaskSelectOrganizationContext.Provider>
</Route>
<Route index>
<SessionTasksStart />
Expand All@@ -56,7 +66,6 @@ export const SessionTask = withCardStateProvider(() => {
const { navigate } = useRouter();
const signInContext = useContext(SignInContext);
const signUpContext = useContext(SignUpContext);
const [isNavigatingToTask, setIsNavigatingToTask] = useState(false);
const currentTaskContainer = useRef<HTMLDivElement>(null);

const redirectUrlComplete =
Expand All@@ -67,10 +76,6 @@ export const SessionTask = withCardStateProvider(() => {
// for example by using browser back navigation. Since there are no pending tasks,
// we redirect them to their intended destination.
useEffect(() => {
if (isNavigatingToTask) {
return;
}

// Tasks can only exist on pending sessions, but we check both conditions
// here to be defensive and ensure proper redirection
const task = clerk.session?.currentTask;
Expand All@@ -80,14 +85,7 @@ export const SessionTask = withCardStateProvider(() => {
}

clerk.telemetry?.record(eventComponentMounted('SessionTask', { task: task.key }));
}, [clerk, navigate, isNavigatingToTask, redirectUrlComplete]);

const nextTask = useCallback(() => {
setIsNavigatingToTask(true);
return clerk
.__internal_navigateToTaskIfAvailable({ redirectUrlComplete })
.finally(() => setIsNavigatingToTask(false));
}, [clerk, redirectUrlComplete]);
}, [clerk, navigate, redirectUrlComplete]);

if (!clerk.session?.currentTask) {
return (
Expand All@@ -105,7 +103,7 @@ export const SessionTask = withCardStateProvider(() => {
}

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .changeset/bright-cats-lay.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/clerk-js': minor
---

Introduce `<TaskSelectOrganization />` component.

It allows you to eject the organization selection task flow from the default `SignIn` and `SignUp` components and render it on custom URL paths using `taskUrls`.

Usage example:
```tsx
<ClerkProvider taskUrls={{ 'select-organization': '/onboarding/select-organization' }}>
<App />
</ClerkProvider>
```

```tsx
function OnboardingSelectOrganization() {
return <TaskSelectOrganization redirectUrlComplete="/dashboard/onboarding-complete" />
}
```
5 changes: 5 additions & 0 deletions .changeset/vast-places-tap.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Add TypeScript types for `<TaskSelectOrganization />` component.
30 changes: 30 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ import type {
SignUpProps,
SignUpRedirectOptions,
SignUpResource,
TaskSelectOrganizationProps,
UnsubscribeCallback,
UserButtonProps,
UserProfileProps,
Expand DownExpand Up@@ -1164,6 +1165,35 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

public mountTaskSelectOrganization = (node: HTMLDivElement, props?: TaskSelectOrganizationProps) => {
this.assertComponentsReady(this.#componentControls);

if (disabledOrganizationsFeature(this, this.environment)) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('TaskSelectOrganization'), {
code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
});
}
return;
}

void this.#componentControls.ensureMounted({ preloadHint: 'TaskSelectOrganization' }).then(controls =>
controls.mountComponent({
name: 'TaskSelectOrganization',
appearanceKey: 'taskSelectOrganization',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted('TaskSelectOrganization', props));
};

public unmountTaskSelectOrganization = (node: HTMLDivElement) => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.unmountComponent({ node }));
};

/**
* `setActive` can be used to set the active session and/or organization.
*/
Expand Down
24 changes: 13 additions & 11 deletions packages/clerk-js/src/core/sessionTasks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,23 +27,25 @@ export function navigateToTask(
routeKey: keyof typeof INTERNAL_SESSION_TASK_ROUTE_BY_KEY,
{ componentNavigationContext, globalNavigate, options, environment }: NavigateToTaskOptions,
) {
const taskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;
const customTaskUrl = options?.taskUrls?.[routeKey];
const internalTaskRoute = `/tasks/${INTERNAL_SESSION_TASK_ROUTE_BY_KEY[routeKey]}`;

if (componentNavigationContext) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + taskRoute);
if (componentNavigationContext && !customTaskUrl) {
return componentNavigationContext.navigate(componentNavigationContext.indexPath + internalTaskRoute);
}

const signInUrl = options['signInUrl'] || environment.displayConfig.signInUrl;
const signUpUrl = options['signUpUrl'] || environment.displayConfig.signUpUrl;
const isReferrerSignUpUrl = window.location.href.startsWith(signUpUrl);

const sessionTaskUrl = buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: taskRoute,
},
{ stringify: true },
return globalNavigate(
customTaskUrl ??
buildURL(
{
base: isReferrerSignUpUrl ? signUpUrl : signInUrl,
hashPath: internalTaskRoute,
},
{ stringify: true },
),
);

return globalNavigate(options.taskUrls?.[routeKey] ?? sessionTaskUrl);
}
9 changes: 8 additions & 1 deletion packages/clerk-js/src/core/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@ const formatWarning = (msg: string) => {
};

const createMessageForDisabledOrganizations = (
componentName: 'OrganizationProfile' | 'OrganizationSwitcher' | 'OrganizationList' | 'CreateOrganization',
componentName:
| 'OrganizationProfile'
| 'OrganizationSwitcher'
| 'OrganizationList'
| 'CreateOrganization'
| 'TaskSelectOrganization',
) => {
return formatWarning(
`The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
Expand All@@ -23,6 +28,8 @@ const warnings = {
'The <SignUp/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the value set in `afterSignUp` URL instead.',
cannotRenderSignUpComponentWhenTaskExists:
'The <SignUp/> component cannot render when a user has a pending task, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the task instead.',
cannotRenderComponentWhenTaskDoesNotExist:
'<TaskSelectOrganization/> cannot render unless a session task is pending. Clerk is redirecting to the value set in `redirectUrlComplete` instead.',
cannotRenderSignInComponentWhenSessionExists:
'The <SignIn/> component cannot render when a user is already signed in, unless the application allows multiple sessions. Since a user is signed in and this application only allows a single session, Clerk is redirecting to the `afterSignIn` URL instead.',
cannotRenderSignInComponentWhenTaskExists:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganization, useOrganizationList } from '@clerk/shared/react';
import { useClerk, useOrganization, useOrganizationList } from '@clerk/shared/react';
import type { CreateOrganizationParams, OrganizationResource } from '@clerk/types';
import React, { useContext } from 'react';

Expand DownExpand Up@@ -41,6 +41,7 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
const card = useCardState();
const wizard = useWizard({ onNextStep: () => card.setError(undefined) });
const sessionTasksContext = useContext(SessionTasksContext);
const clerk = useClerk();

const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);
const { createOrganization, isLoaded, setActive, userMemberships } = useOrganizationList({
Expand DownExpand Up@@ -89,13 +90,15 @@ export const CreateOrganizationForm = withCardStateProvider((props: CreateOrgani
lastCreatedOrganizationRef.current = organization;
await setActive({ organization });

void userMemberships.revalidate?.();

if (sessionTasksContext) {
await sessionTasksContext.nextTask();
await clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
return;
}

void userMemberships.revalidate?.();
Comment on lines -92 to +100

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Previously, I've rewritten the entire OrganizationList logic within TaskSelectOrganization to avoid a flicker of UI on revalidation of memberships.

As I started to export TaskSelectOrganization as a public component, I realized that it couldn't receive a custom appearance for OrganizationList.

Simpler solution is just to not revalidate the data in place when resolving a select-organization task.


if (props.skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
return completeFlow();
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useOrganizationList, useUser } from '@clerk/shared/react';
import { useClerk, useOrganizationList, useUser } from '@clerk/shared/react';
import type { OrganizationResource } from '@clerk/types';
import { useContext } from 'react';

Expand All@@ -15,6 +15,7 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
const card = useCardState();
const { navigateAfterSelectOrganization } = useOrganizationListContext();
const { isLoaded, setActive } = useOrganizationList();
const clerk = useClerk();
const sessionTasksContext = useContext(SessionTasksContext);

if (!isLoaded) {
Expand All@@ -26,8 +27,10 @@ export const MembershipPreview = withCardStateProvider((props: { organization: O
organization,
});

if (sessionTasksContext?.nextTask) {
return sessionTasksContext?.nextTask();
if (sessionTasksContext) {
return clerk.__internal_navigateToTaskIfAvailable({
redirectUrlComplete: sessionTasksContext.redirectUrlComplete,
});
}

await navigateAfterSelectOrganization(organization);
Expand Down
34 changes: 16 additions & 18 deletions packages/clerk-js/src/ui/components/SessionTasks/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useCallback, useContext, useEffect, useRef, useState } from 'react';
import { useContext, useEffect, useRef } from 'react';

import { Card } from '@/ui/elements/Card';
import { withCardStateProvider } from '@/ui/elements/contexts';
import { LoadingCardContainer } from '@/ui/elements/LoadingCard';

import { INTERNAL_SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignInContext, SignUpContext } from '../../../ui/contexts';
import { SessionTasksContext, useSessionTasksContext } from '../../contexts/components/SessionTasks';
import {
SessionTasksContext,
TaskSelectOrganizationContext,
useSessionTasksContext,
} from '../../contexts/components/SessionTasks';
import { Route, Switch, useRouter } from '../../router';
import { ForceOrganizationSelectionTask } from './tasks/ForceOrganizationSelection';
import { TaskSelectOrganization } from './tasks/TaskSelectOrganization';

const SessionTasksStart = () => {
const clerk = useClerk();
Expand All@@ -36,10 +40,16 @@ const SessionTasksStart = () => {
};

function SessionTaskRoutes(): JSX.Element {
const ctx = useSessionTasksContext();

return (
<Switch>
<Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['select-organization']}>
<ForceOrganizationSelectionTask />
<TaskSelectOrganizationContext.Provider
value={{ componentName: 'TaskSelectOrganization', redirectUrlComplete: ctx.redirectUrlComplete }}
>
<TaskSelectOrganization />
</TaskSelectOrganizationContext.Provider>
</Route>
<Route index>
<SessionTasksStart />
Expand All@@ -56,7 +66,6 @@ export const SessionTask = withCardStateProvider(() => {
const { navigate } = useRouter();
const signInContext = useContext(SignInContext);
const signUpContext = useContext(SignUpContext);
const [isNavigatingToTask, setIsNavigatingToTask] = useState(false);
const currentTaskContainer = useRef<HTMLDivElement>(null);

const redirectUrlComplete =
Expand All@@ -67,10 +76,6 @@ export const SessionTask = withCardStateProvider(() => {
// for example by using browser back navigation. Since there are no pending tasks,
// we redirect them to their intended destination.
useEffect(() => {
if (isNavigatingToTask) {
return;
}

// Tasks can only exist on pending sessions, but we check both conditions
// here to be defensive and ensure proper redirection
const task = clerk.session?.currentTask;
Expand All@@ -80,14 +85,7 @@ export const SessionTask = withCardStateProvider(() => {
}

clerk.telemetry?.record(eventComponentMounted('SessionTask', { task: task.key }));
}, [clerk, navigate, isNavigatingToTask, redirectUrlComplete]);

const nextTask = useCallback(() => {
setIsNavigatingToTask(true);
return clerk
.__internal_navigateToTaskIfAvailable({ redirectUrlComplete })
.finally(() => setIsNavigatingToTask(false));
}, [clerk, redirectUrlComplete]);
}, [clerk, navigate, redirectUrlComplete]);

if (!clerk.session?.currentTask) {
return (
Expand All@@ -105,7 +103,7 @@ export const SessionTask = withCardStateProvider(() => {
}

return (
<SessionTasksContext.Provider value={{ nextTask, redirectUrlComplete, currentTaskContainer }}>
<SessionTasksContext.Provider value={{ redirectUrlComplete, currentTaskContainer }}>
<SessionTaskRoutes />
</SessionTasksContext.Provider>
);
Expand Down
Loading
Loading