Skip to content

fix(clerk-js,ui): Preload component chunks in parallel during mount #7901

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
jacekradko merged 6 commits into from
Feb 24, 2026
+41 −25
Merged

fix(clerk-js,ui): Preload component chunks in parallel during mount #7901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cdc7d44
fix(clerk-js,ui): Preload component chunks in parallel during mount
jacekradko Feb 21, 2026
c5bd5b2
fix(test): Mock @formkit/auto-animate/react in vitest setup
jacekradko Feb 21, 2026
eb26b43
Merge branch 'main' into jacek/user-4747-ui-delay-opening-user-menu-a…
jacekradko Feb 22, 2026
8b968ba
Merge branch 'main' into jacek/user-4747-ui-delay-opening-user-menu-a…
jacekradko Feb 23, 2026
77ded72
Merge branch 'main' into jacek/user-4747-ui-delay-opening-user-menu-a…
jacekradko Feb 23, 2026
ac04f66
fix(clerk-js,ui): Add preloadHint to open* methods and catch preload …
jacekradko Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/orange-chefs-fail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': patch
'@clerk/ui': patch
---

Preload component chunks in parallel with the common chunk during mount, reducing first-render latency on slow connections.
52 changes: 30 additions & 22 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,7 +691,9 @@ export class Clerk implements ClerkInterface {
}
this.assertComponentsReady(this.#clerkUI);
const component = 'SignIn';
void this.#clerkUI.then(ui => ui.ensureMounted()).then(controls => controls.openModal('signIn', props || {}));
void this.#clerkUI
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls => controls.openModal('signIn', props || {}));

const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
this.telemetry?.record(eventPrebuiltComponentOpened(component, props, additionalData));
Expand Down Expand Up @@ -865,7 +867,9 @@ export class Clerk implements ClerkInterface {
return;
}
this.assertComponentsReady(this.#clerkUI);
void this.#clerkUI.then(ui => ui.ensureMounted()).then(controls => controls.openModal('signUp', props || {}));
void this.#clerkUI
.then(ui => ui.ensureMounted({ preloadHint: 'SignUp' }))
.then(controls => controls.openModal('signUp', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened('SignUp', props));
};
Expand All @@ -884,7 +888,9 @@ export class Clerk implements ClerkInterface {
return;
}
this.assertComponentsReady(this.#clerkUI);
void this.#clerkUI.then(ui => ui.ensureMounted()).then(controls => controls.openModal('userProfile', props || {}));
void this.#clerkUI
.then(ui => ui.ensureMounted({ preloadHint: 'UserProfile' }))
.then(controls => controls.openModal('userProfile', props || {}));

const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
Expand Down Expand Up @@ -920,7 +926,7 @@ export class Clerk implements ClerkInterface {

this.assertComponentsReady(this.#clerkUI);
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: 'OrganizationProfile' }))
.then(controls => controls.openModal('organizationProfile', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened('OrganizationProfile', props));
Expand All @@ -947,7 +953,7 @@ export class Clerk implements ClerkInterface {

this.assertComponentsReady(this.#clerkUI);
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: 'CreateOrganization' }))
.then(controls => controls.openModal('createOrganization', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened('CreateOrganization', props));
Expand All @@ -959,7 +965,9 @@ export class Clerk implements ClerkInterface {

public openWaitlist = (props?: WaitlistProps): void => {
this.assertComponentsReady(this.#clerkUI);
void this.#clerkUI.then(ui => ui.ensureMounted()).then(controls => controls.openModal('waitlist', props || {}));
void this.#clerkUI
.then(ui => ui.ensureMounted({ preloadHint: 'Waitlist' }))
.then(controls => controls.openModal('waitlist', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened('Waitlist', props));
};
Expand All @@ -972,7 +980,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'SignIn';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
Comment thread
jacekradko marked this conversation as resolved.
.then(controls =>
controls.mountComponent({
name: component,
Expand All @@ -994,7 +1002,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'UserAvatar';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand All @@ -1015,7 +1023,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'SignUp';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand Down Expand Up @@ -1044,7 +1052,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'UserProfile';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand Down Expand Up @@ -1090,7 +1098,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'OrganizationProfile';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand Down Expand Up @@ -1125,7 +1133,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'CreateOrganization';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand Down Expand Up @@ -1160,7 +1168,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'OrganizationSwitcher';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand Down Expand Up @@ -1205,7 +1213,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'OrganizationList';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand All @@ -1231,7 +1239,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'UserButton';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand All @@ -1257,7 +1265,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'Waitlist';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand Down Expand Up @@ -1286,7 +1294,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'PricingTable';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand All @@ -1307,7 +1315,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'OAuthConsent';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand Down Expand Up @@ -1362,7 +1370,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'APIKeys';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand Down Expand Up @@ -1405,7 +1413,7 @@ export class Clerk implements ClerkInterface {
this.assertComponentsReady(this.#clerkUI);
const component = 'TaskChooseOrganization';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand All @@ -1427,7 +1435,7 @@ export class Clerk implements ClerkInterface {

const component = 'TaskResetPassword';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand All @@ -1449,7 +1457,7 @@ export class Clerk implements ClerkInterface {

const component = 'TaskSetupMFA';
void this.#clerkUI
.then(ui => ui.ensureMounted())
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
Expand Down
8 changes: 5 additions & 3 deletions packages/ui/src/Components.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,15 +221,17 @@ export const mountComponentRenderer = (
return {
ensureMounted: (opts?: { preloadHint: ClerkComponentName }) => {
const { preloadHint } = opts || {};
// Always preload, even if ensureMounted was already called.
// preloadComponent is idempotent (returns cached promise on subsequent calls).
if (preloadHint) {
void preloadComponent(preloadHint).catch(() => {});
}
// This mechanism ensures that mountComponentControls will only be called once
// and any calls to .mount before mountComponentControls resolves will fire in order.
// Otherwise, we risk having components rendered multiple times, or having
// .unmountComponent incorrectly called before the component is rendered
if (!componentsControlsResolver) {
const deferredPromise = createDeferredPromise();
if (preloadHint) {
void preloadComponent(preloadHint);
}
componentsControlsResolver = import('./lazyModules/common').then(({ createRoot }) => {
createRoot(clerkRoot).render(
<Components
Expand Down
Loading