feat(clerk-js,types,clerk-react): Add internal open/close checkout methods#5481

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
alexcarpenter merged 14 commits into from
Apr 3, 2025
Merged

feat(clerk-js,types,clerk-react): Add internal open/close checkout methods #5481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
dfe84ea
init
alexcarpenter Mar 28, 2025
44d8879
WIP
alexcarpenter Mar 28, 2025
c22a321
wip
alexcarpenter Mar 28, 2025
8acac44
wip
alexcarpenter Mar 28, 2025
bb4212b
wip
alexcarpenter Mar 28, 2025
41fd1a0
wip
alexcarpenter Mar 28, 2025
e9e59d7
fix
alexcarpenter Mar 28, 2025
5c28068
fix
alexcarpenter Mar 28, 2025
0151de0
add changeset
alexcarpenter Mar 28, 2025
2b31f6e
handle close
alexcarpenter Mar 28, 2025
1e2e028
Update bundlewatch.config.json
alexcarpenter Mar 28, 2025
f779ac7
pass props
alexcarpenter Mar 28, 2025
1608130
Update bundlewatch.config.json
alexcarpenter Mar 28, 2025
d29bf85
Merge branch 'main' into alexcarpenter/com-257-add-clerkopencheckout-…
alexcarpenter Apr 3, 2025
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
7 changes: 7 additions & 0 deletions .changeset/fancy-lies-sell.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
'@clerk/types': patch
---

Introduce `clerk.__internal_openCheckout()` and `clerk.__internal_closeCheckout()` methods and remove `<Checkout />` from within the `<PricingTable />` component.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
{ "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "55KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "96KB" },
{ "path": "./dist/vendors*.js", "maxSize": "30KB" },
{ "path": "./dist/vendors*.js", "maxSize": "35KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
{ "path": "./dist/createorganization*.js", "maxSize": "5KB" },
{ "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
__experimental_CheckoutProps,
__experimental_CommerceNamespace,
__experimental_PricingTableProps,
__internal_ComponentNavigationContext,
Expand DownExpand Up@@ -520,6 +521,18 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.closeModal('signIn'));
};

public __internal_openCheckout = (props?: __experimental_CheckoutProps): void => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls
.ensureMounted({ preloadHint: 'Checkout' })
.then(controls => controls.openDrawer('checkout', props || {}));
};

public __internal_closeCheckout = (): void => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.closeDrawer('checkout'));
};

public __internal_openReverification = (props?: __internal_UserVerificationModalProps): void => {
this.assertComponentsReady(this.#componentControls);
if (noUserExists(this)) {
Expand Down
63 changes: 63 additions & 0 deletions packages/clerk-js/src/ui/Components.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useSafeLayoutEffect } from '@clerk/shared/react';
import { createDeferredPromise } from '@clerk/shared/utils';
import type {
__experimental_CheckoutProps,
__internal_UserVerificationProps,
Appearance,
Clerk,
Expand All@@ -24,6 +25,7 @@ import { useClerkModalStateParams } from './hooks/useClerkModalStateParams';
import type { ClerkComponentName } from './lazyModules/components';
import {
BlankCaptchaModal,
Checkout,
CreateOrganizationModal,
ImpersonationFab,
KeylessPrompt,
Expand All@@ -37,6 +39,7 @@ import {
} from './lazyModules/components';
import {
LazyComponentRenderer,
LazyDrawerRenderer,
LazyImpersonationFabProvider,
LazyModalRenderer,
LazyOneTapRenderer,
Expand DownExpand Up@@ -99,6 +102,16 @@ export type ComponentControls = {
notify?: boolean;
},
) => void;
openDrawer: <T extends 'checkout'>(
drawer: T,
props: T extends 'checkout' ? __experimental_CheckoutProps : never,
) => void;
closeDrawer: (
drawer: 'checkout',
options?: {
notify?: boolean;
},
) => void;
prefetch: (component: 'organizationSwitcher') => void;
// Special case, as the impersonation fab mounts automatically
mountImpersonationFab: () => void;
Expand DownExpand Up@@ -131,6 +144,10 @@ interface ComponentsState {
blankCaptchaModal: null;
organizationSwitcherPrefetch: boolean;
waitlistModal: null | WaitlistProps;
checkoutDrawer: {
open: false;
props: null | __experimental_CheckoutProps;
};
nodes: Map<HTMLDivElement, HtmlNodeOptions>;
impersonationFab: boolean;
}
Expand DownExpand Up@@ -212,6 +229,10 @@ const Components = (props: ComponentsProps) => {
organizationSwitcherPrefetch: false,
waitlistModal: null,
blankCaptchaModal: null,
checkoutDrawer: {
open: false,
props: null,
},
nodes: new Map(),
impersonationFab: false,
});
Expand All@@ -226,6 +247,7 @@ const Components = (props: ComponentsProps) => {
createOrganizationModal,
waitlistModal,
blankCaptchaModal,
checkoutDrawer,
nodes,
} = state;

Expand DownExpand Up@@ -322,6 +344,26 @@ const Components = (props: ComponentsProps) => {
setState(s => ({ ...s, impersonationFab: true }));
};

componentsControls.openDrawer = (name, props) => {
setState(s => ({
...s,
[`${name}Drawer`]: {
open: true,
props,
},
}));
};

componentsControls.closeDrawer = name => {
setState(s => ({
...s,
[`${name}Drawer`]: {
...s[`${name}Drawer`],
open: false,
},
}));
};
Comment on lines +347 to +365

@alexcarpenteralexcarpenterMar 28, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Introducing new drawer specific methods as we want to have an exit animation for the drawers, and removing all the props causes issues with portaling into the profile components.

@brkalowbrkalowApr 3, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It would be great to consolidate the modal/drawer handling at some point in the future. I would expect them to function the same, just be a different flavor of UI. Maybe there's a good reason to keep them separate though? 🤔

@alexcarpenteralexcarpenterApr 3, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

If we want modals to have an exit animation, we'd need to follow this updated drawer pattern, currently all modals are removed immediately but wiping out the props.


componentsControls.prefetch = component => {
setState(s => ({ ...s, [`${component}Prefetch`]: true }));
};
Expand DownExpand Up@@ -481,6 +523,26 @@ const Components = (props: ComponentsProps) => {
</LazyModalRenderer>
);

const mountedCheckoutDrawer = checkoutDrawer.props && (
<LazyDrawerRenderer
globalAppearance={state.appearance}
appearanceKey={'checkout' as any}
componentAppearance={{}}
flowName={'checkout'}
open={checkoutDrawer.open}
onOpenChange={() => componentsControls.closeDrawer('checkout')}
componentName={'Checkout'}
portalId={checkoutDrawer.props.portalId}
>
<Checkout
planId={checkoutDrawer.props.planId}
planPeriod={checkoutDrawer.props.planPeriod}
orgId={checkoutDrawer.props.orgId}
onSubscriptionComplete={checkoutDrawer.props.onSubscriptionComplete}
/>
</LazyDrawerRenderer>
);

return (
<Suspense fallback={''}>
<LazyProviders
Expand DownExpand Up@@ -511,6 +573,7 @@ const Components = (props: ComponentsProps) => {
{createOrganizationModal && mountedCreateOrganizationModal}
{waitlistModal && mountedWaitlistModal}
{blankCaptchaModal && mountedBlankCaptchaModal}
{mountedCheckoutDrawer}

{state.impersonationFab && (
<LazyImpersonationFabProvider globalAppearance={state.appearance}>
Expand Down
40 changes: 11 additions & 29 deletions packages/clerk-js/src/ui/components/Checkout/Checkout.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
import type { __experimental_CheckoutProps } from '@clerk/types';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { useCheckoutContext, withCoreUserGuard } from '../../contexts';
import { __experimental_CheckoutContext } from '../../contexts';
import { Flow } from '../../customizables';
import { Drawer } from '../../elements';
import { Route, Switch } from '../../router';
import { CheckoutPage } from './CheckoutPage';

export const __experimental_Checkout = (props: __experimental_CheckoutProps) => {
return (
<Flow.Root flow='checkout'>
<Flow.Part>
<Switch>
<Route>
<AuthenticatedRoutes {...props} />
</Route>
</Switch>
<__experimental_CheckoutContext.Provider
value={{
componentName: 'Checkout',
}}
>
<Drawer.Content>
<Drawer.Header title='Checkout' />
<CheckoutPage {...props} />
</Drawer.Content>
</__experimental_CheckoutContext.Provider>
</Flow.Part>
</Flow.Root>
);
};

const AuthenticatedRoutes = withCoreUserGuard((props: __experimental_CheckoutProps) => {
const { mode = 'mounted', isOpen = false, setIsOpen = () => {} } = useCheckoutContext();

return (
<Drawer.Root
open={isOpen}
onOpenChange={setIsOpen}
strategy={mode === 'mounted' ? 'fixed' : 'absolute'}
portalProps={{
id: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
}}
>
<Drawer.Overlay />
<Drawer.Content>
<Drawer.Header title='Checkout' />
<CheckoutPage {...props} />
</Drawer.Content>
</Drawer.Root>
);
});
5 changes: 2 additions & 3 deletions packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

import { useCheckoutContext } from '../../contexts';
import { Box, Button, descriptors, Heading, Icon, localizationKeys, Span, Text } from '../../customizables';
import { Drawer, LineItems } from '../../elements';
import { Drawer, LineItems, useDrawerContext } from '../../elements';
import { Check } from '../../icons';

const capitalize = (name: string) => name[0].toUpperCase() + name.slice(1);

export const CheckoutComplete = ({ checkout }: { checkout: __experimental_CommerceCheckoutResource }) => {
const { setIsOpen } = useCheckoutContext();
const { setIsOpen } = useDrawerContext();

const handleClose = () => {
if (setIsOpen) {
Expand Down
34 changes: 8 additions & 26 deletions packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,9 @@ import type {
import { useState } from 'react';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { __experimental_CheckoutContext, usePricingTableContext } from '../../contexts';
import { usePricingTableContext } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { usePlans } from '../../hooks';
import { __experimental_Checkout } from '../Checkout';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
import { SubscriptionDetailDrawer } from './SubscriptionDetailDrawer';
Expand All@@ -25,10 +24,8 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
const { plans, subscriptions, revalidate } = usePlans({ subscriberType });

const [planPeriod, setPlanPeriod] = useState<__experimental_CommerceSubscriptionPlanPeriod>('month');
const [checkoutPlan, setCheckoutPlan] = useState<__experimental_CommercePlanResource>();
const [detailSubscription, setDetailSubscription] = useState<__experimental_CommerceSubscriptionResource>();

const [showCheckout, setShowCheckout] = useState(false);
const [showSubscriptionDetailDrawer, setShowSubscriptionDetailDrawer] = useState(false);

const selectPlan = (plan: __experimental_CommercePlanResource) => {
Expand All@@ -40,8 +37,13 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
setDetailSubscription(activeSubscription);
setShowSubscriptionDetailDrawer(true);
} else {
setCheckoutPlan(plan);
setShowCheckout(true);
clerk.__internal_openCheckout({
planId: plan.id,
planPeriod,
orgId: subscriberType === 'org' ? organization?.id : undefined,
onSubscriptionComplete: onSubscriptionChange,
portalId: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,

@brkalowbrkalowApr 3, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

does mode indicate the context PricingTable is rendered in? I feel like I would expect mode to dictate how PricingTable behaves itself, but not necessarily how it behaves depending on where it's rendered.

As a semi-related nit, I might rename mode to context.

@alexcarpenteralexcarpenterApr 3, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Mode is set on the PricingTable and I think was originally adding following the other components, but there is no modal mode for PricingTable, so yeah, it is confusing, as its only a mounted component. Will refactor naming approach in a follow up PR.

Comment on lines +40 to +45

@brkalowbrkalowApr 3, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is much cleaner!

});
}
};

Expand DownExpand Up@@ -74,26 +76,6 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
appearanceKey='checkout'
appearance={props.checkoutProps?.appearance}
>
<__experimental_CheckoutContext.Provider
value={{
componentName: 'Checkout',
mode,
isOpen: showCheckout,
setIsOpen: setShowCheckout,
}}
>
{/*TODO: Used by InvisibleRootBox, can we simplify? */}
<div>
{checkoutPlan && (
<__experimental_Checkout
planPeriod={planPeriod}
planId={checkoutPlan.id}
orgId={subscriberType === 'org' ? organization?.id : undefined}
onSubscriptionComplete={onSubscriptionChange}
/>
)}
</div>
</__experimental_CheckoutContext.Provider>
<SubscriptionDetailDrawer
isOpen={showSubscriptionDetailDrawer}
setIsOpen={setShowSubscriptionDetailDrawer}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(clerk-js,types,clerk-react): Add internal open/close checkout methods#5481

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

alexcarpenter
merged 14 commits into

from

Apr 3, 2025
 Merged


feat(clerk-js,types,clerk-react): Add internal open/close checkout methods
#5481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
dfe84ea

init


alexcarpenter Mar 28, 2025
44d8879

WIP


alexcarpenter Mar 28, 2025
c22a321

wip


alexcarpenter Mar 28, 2025
8acac44

wip


alexcarpenter Mar 28, 2025
bb4212b

wip


alexcarpenter Mar 28, 2025
41fd1a0

wip


alexcarpenter Mar 28, 2025
e9e59d7

fix


alexcarpenter Mar 28, 2025
5c28068

fix


alexcarpenter Mar 28, 2025
0151de0

add changeset


alexcarpenter Mar 28, 2025
2b31f6e

handle close


alexcarpenter Mar 28, 2025
1e2e028

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
f779ac7

pass props


alexcarpenter Mar 28, 2025
1608130

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
d29bf85

Merge branch 'main' into alexcarpenter/com-257-add-clerkopencheckout-…


alexcarpenter Apr 3, 2025

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


7 changes: 7 additions & 0 deletions
.changeset/fancy-lies-sell.md

View file


Open in desktop

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

Introduce `clerk.__internal_openCheckout()` and `clerk.__internal_closeCheckout()` methods and remove `<Checkout />` from within the `<PricingTable />` component.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "55KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "96KB" },
 { "path": "./dist/vendors*.js", "maxSize": "30KB" },
 { "path": "./dist/vendors*.js", "maxSize": "35KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __experimental_CommerceNamespace,
 __experimental_PricingTableProps,
 __internal_ComponentNavigationContext,
Expand DownExpand Up@@ -520,6 +521,18 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls.ensureMounted().then(controls => controls.closeModal('signIn'));
 };

 public __internal_openCheckout = (props?: __experimental_CheckoutProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Checkout' })
 .then(controls => controls.openDrawer('checkout', props || {}));
 };

 public __internal_closeCheckout = (): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted().then(controls => controls.closeDrawer('checkout'));
 };

 public __internal_openReverification = (props?: __internal_UserVerificationModalProps): void => {
 this.assertComponentsReady(this.#componentControls);
 if (noUserExists(this)) {
Expand Down

63 changes: 63 additions & 0 deletions
packages/clerk-js/src/ui/Components.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useSafeLayoutEffect } from '@clerk/shared/react';
import { createDeferredPromise } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __internal_UserVerificationProps,
 Appearance,
 Clerk,
Expand All@@ -24,6 +25,7 @@ import { useClerkModalStateParams } from './hooks/useClerkModalStateParams';
import type { ClerkComponentName } from './lazyModules/components';
import {
 BlankCaptchaModal,
 Checkout,
 CreateOrganizationModal,
 ImpersonationFab,
 KeylessPrompt,
Expand All@@ -37,6 +39,7 @@ import {
} from './lazyModules/components';
import {
 LazyComponentRenderer,
 LazyDrawerRenderer,
 LazyImpersonationFabProvider,
 LazyModalRenderer,
 LazyOneTapRenderer,
Expand DownExpand Up@@ -99,6 +102,16 @@ export type ComponentControls = {
 notify?: boolean;
 },
 ) => void;
 openDrawer: <T extends 'checkout'>(
 drawer: T,
 props: T extends 'checkout' ? __experimental_CheckoutProps : never,
 ) => void;
 closeDrawer: (
 drawer: 'checkout',
 options?: {
 notify?: boolean;
 },
 ) => void;
 prefetch: (component: 'organizationSwitcher') => void;
 // Special case, as the impersonation fab mounts automatically
 mountImpersonationFab: () => void;
Expand DownExpand Up@@ -131,6 +144,10 @@ interface ComponentsState {
 blankCaptchaModal: null;
 organizationSwitcherPrefetch: boolean;
 waitlistModal: null | WaitlistProps;
 checkoutDrawer: {
 open: false;
 props: null | __experimental_CheckoutProps;
 };
 nodes: Map<HTMLDivElement, HtmlNodeOptions>;
 impersonationFab: boolean;
}
Expand DownExpand Up@@ -212,6 +229,10 @@ const Components = (props: ComponentsProps) => {
 organizationSwitcherPrefetch: false,
 waitlistModal: null,
 blankCaptchaModal: null,
 checkoutDrawer: {
 open: false,
 props: null,
 },
 nodes: new Map(),
 impersonationFab: false,
 });
Expand All@@ -226,6 +247,7 @@ const Components = (props: ComponentsProps) => {
 createOrganizationModal,
 waitlistModal,
 blankCaptchaModal,
 checkoutDrawer,
 nodes,
 } = state;

Expand DownExpand Up@@ -322,6 +344,26 @@ const Components = (props: ComponentsProps) => {
 setState(s => ({ ...s, impersonationFab: true }));
 };

 componentsControls.openDrawer = (name, props) => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 open: true,
 props,
 },
 }));
 };

 componentsControls.closeDrawer = name => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 ...s[`${name}Drawer`],
 open: false,
 },
 }));
 };

Comment on lines

+347
 to 
+365

@alexcarpenteralexcarpenterMar 28, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Introducing new drawer specific methods as we want to have an exit animation for the drawers, and removing all the props causes issues with portaling into the profile components.
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

It would be great to consolidate the modal/drawer handling at some point in the future. I would expect them to function the same, just be a different flavor of UI. Maybe there's a good reason to keep them separate though? 🤔
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

If we want modals to have an exit animation, we'd need to follow this updated drawer pattern, currently all modals are removed immediately but wiping out the props.

 componentsControls.prefetch = component => {
 setState(s => ({ ...s, [`${component}Prefetch`]: true }));
 };
Expand DownExpand Up@@ -481,6 +523,26 @@ const Components = (props: ComponentsProps) => {
 </LazyModalRenderer>
 );

 const mountedCheckoutDrawer = checkoutDrawer.props && (
 <LazyDrawerRenderer
 globalAppearance={state.appearance}
 appearanceKey={'checkout' as any}
 componentAppearance={{}}
 flowName={'checkout'}
 open={checkoutDrawer.open}
 onOpenChange={() => componentsControls.closeDrawer('checkout')}
 componentName={'Checkout'}
 portalId={checkoutDrawer.props.portalId}
 >
 <Checkout
 planId={checkoutDrawer.props.planId}
 planPeriod={checkoutDrawer.props.planPeriod}
 orgId={checkoutDrawer.props.orgId}
 onSubscriptionComplete={checkoutDrawer.props.onSubscriptionComplete}
 />
 </LazyDrawerRenderer>
 );

 return (
 <Suspense fallback={''}>
 <LazyProviders
Expand DownExpand Up@@ -511,6 +573,7 @@ const Components = (props: ComponentsProps) => {
 {createOrganizationModal && mountedCreateOrganizationModal}
 {waitlistModal && mountedWaitlistModal}
 {blankCaptchaModal && mountedBlankCaptchaModal}
 {mountedCheckoutDrawer}

 {state.impersonationFab && (
 <LazyImpersonationFabProvider globalAppearance={state.appearance}>
Expand Down

40 changes: 11 additions & 29 deletions
packages/clerk-js/src/ui/components/Checkout/Checkout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
import type { __experimental_CheckoutProps } from '@clerk/types';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { useCheckoutContext, withCoreUserGuard } from '../../contexts';
import { __experimental_CheckoutContext } from '../../contexts';
import { Flow } from '../../customizables';
import { Drawer } from '../../elements';
import { Route, Switch } from '../../router';
import { CheckoutPage } from './CheckoutPage';

export const __experimental_Checkout = (props: __experimental_CheckoutProps) => {
 return (
 <Flow.Root flow='checkout'>
 <Flow.Part>
 <Switch>
 <Route>
 <AuthenticatedRoutes {...props} />
 </Route>
 </Switch>
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 }}
 >
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </__experimental_CheckoutContext.Provider>
 </Flow.Part>
 </Flow.Root>
 );
};

const AuthenticatedRoutes = withCoreUserGuard((props: __experimental_CheckoutProps) => {
 const { mode = 'mounted', isOpen = false, setIsOpen = () => {} } = useCheckoutContext();

 return (
 <Drawer.Root
 open={isOpen}
 onOpenChange={setIsOpen}
 strategy={mode === 'mounted' ? 'fixed' : 'absolute'}
 portalProps={{
 id: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
 }}
 >
 <Drawer.Overlay />
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </Drawer.Root>
 );
});

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

import { useCheckoutContext } from '../../contexts';
import { Box, Button, descriptors, Heading, Icon, localizationKeys, Span, Text } from '../../customizables';
import { Drawer, LineItems } from '../../elements';
import { Drawer, LineItems, useDrawerContext } from '../../elements';
import { Check } from '../../icons';

const capitalize = (name: string) => name[0].toUpperCase() + name.slice(1);

export const CheckoutComplete = ({ checkout }: { checkout: __experimental_CommerceCheckoutResource }) => {
 const { setIsOpen } = useCheckoutContext();
 const { setIsOpen } = useDrawerContext();

 const handleClose = () => {
 if (setIsOpen) {
Expand Down

34 changes: 8 additions & 26 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,9 @@ import type {
import { useState } from 'react';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { __experimental_CheckoutContext, usePricingTableContext } from '../../contexts';
import { usePricingTableContext } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { usePlans } from '../../hooks';
import { __experimental_Checkout } from '../Checkout';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
import { SubscriptionDetailDrawer } from './SubscriptionDetailDrawer';
Expand All@@ -25,10 +24,8 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 const { plans, subscriptions, revalidate } = usePlans({ subscriberType });

 const [planPeriod, setPlanPeriod] = useState<__experimental_CommerceSubscriptionPlanPeriod>('month');
 const [checkoutPlan, setCheckoutPlan] = useState<__experimental_CommercePlanResource>();
 const [detailSubscription, setDetailSubscription] = useState<__experimental_CommerceSubscriptionResource>();

 const [showCheckout, setShowCheckout] = useState(false);
 const [showSubscriptionDetailDrawer, setShowSubscriptionDetailDrawer] = useState(false);

 const selectPlan = (plan: __experimental_CommercePlanResource) => {
Expand All@@ -40,8 +37,13 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 setDetailSubscription(activeSubscription);
 setShowSubscriptionDetailDrawer(true);
 } else {
 setCheckoutPlan(plan);
 setShowCheckout(true);
 clerk.__internal_openCheckout({
 planId: plan.id,
 planPeriod,
 orgId: subscriberType === 'org' ? organization?.id : undefined,
 onSubscriptionComplete: onSubscriptionChange,
 portalId: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

does mode indicate the context PricingTable is rendered in? I feel like I would expect mode to dictate how PricingTable behaves itself, but not necessarily how it behaves depending on where it's rendered.
As a semi-related nit, I might rename mode to context.
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Mode is set on the PricingTable and I think was originally adding following the other components, but there is no modal mode for PricingTable, so yeah, it is confusing, as its only a mounted component. Will refactor naming approach in a follow up PR.

Comment on lines

+40
 to 
+45

@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This is much cleaner!
 });
 }
 };

Expand DownExpand Up@@ -74,26 +76,6 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 appearanceKey='checkout'
 appearance={props.checkoutProps?.appearance}
 >
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 mode,
 isOpen: showCheckout,
 setIsOpen: setShowCheckout,
 }}
 >
 {/*TODO: Used by InvisibleRootBox, can we simplify? */}
 <div>
 {checkoutPlan && (
 <__experimental_Checkout
 planPeriod={planPeriod}
 planId={checkoutPlan.id}
 orgId={subscriberType === 'org' ? organization?.id : undefined}
 onSubscriptionComplete={onSubscriptionChange}
 />
 )}
 </div>
 </__experimental_CheckoutContext.Provider>
 <SubscriptionDetailDrawer
 isOpen={showSubscriptionDetailDrawer}
 setIsOpen={setShowSubscriptionDetailDrawer}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js,types,clerk-react): Add internal open/close checkout methods#5481

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

alexcarpenter
merged 14 commits into

from

Apr 3, 2025
 Merged


feat(clerk-js,types,clerk-react): Add internal open/close checkout methods
#5481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
dfe84ea

init


alexcarpenter Mar 28, 2025
44d8879

WIP


alexcarpenter Mar 28, 2025
c22a321

wip


alexcarpenter Mar 28, 2025
8acac44

wip


alexcarpenter Mar 28, 2025
bb4212b

wip


alexcarpenter Mar 28, 2025
41fd1a0

wip


alexcarpenter Mar 28, 2025
e9e59d7

fix


alexcarpenter Mar 28, 2025
5c28068

fix


alexcarpenter Mar 28, 2025
0151de0

add changeset


alexcarpenter Mar 28, 2025
2b31f6e

handle close


alexcarpenter Mar 28, 2025
1e2e028

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
f779ac7

pass props


alexcarpenter Mar 28, 2025
1608130

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
d29bf85

Merge branch 'main' into alexcarpenter/com-257-add-clerkopencheckout-…


alexcarpenter Apr 3, 2025

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


7 changes: 7 additions & 0 deletions
.changeset/fancy-lies-sell.md

View file


Open in desktop

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

Introduce `clerk.__internal_openCheckout()` and `clerk.__internal_closeCheckout()` methods and remove `<Checkout />` from within the `<PricingTable />` component.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "55KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "96KB" },
 { "path": "./dist/vendors*.js", "maxSize": "30KB" },
 { "path": "./dist/vendors*.js", "maxSize": "35KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __experimental_CommerceNamespace,
 __experimental_PricingTableProps,
 __internal_ComponentNavigationContext,
Expand DownExpand Up@@ -520,6 +521,18 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls.ensureMounted().then(controls => controls.closeModal('signIn'));
 };

 public __internal_openCheckout = (props?: __experimental_CheckoutProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Checkout' })
 .then(controls => controls.openDrawer('checkout', props || {}));
 };

 public __internal_closeCheckout = (): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted().then(controls => controls.closeDrawer('checkout'));
 };

 public __internal_openReverification = (props?: __internal_UserVerificationModalProps): void => {
 this.assertComponentsReady(this.#componentControls);
 if (noUserExists(this)) {
Expand Down

63 changes: 63 additions & 0 deletions
packages/clerk-js/src/ui/Components.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useSafeLayoutEffect } from '@clerk/shared/react';
import { createDeferredPromise } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __internal_UserVerificationProps,
 Appearance,
 Clerk,
Expand All@@ -24,6 +25,7 @@ import { useClerkModalStateParams } from './hooks/useClerkModalStateParams';
import type { ClerkComponentName } from './lazyModules/components';
import {
 BlankCaptchaModal,
 Checkout,
 CreateOrganizationModal,
 ImpersonationFab,
 KeylessPrompt,
Expand All@@ -37,6 +39,7 @@ import {
} from './lazyModules/components';
import {
 LazyComponentRenderer,
 LazyDrawerRenderer,
 LazyImpersonationFabProvider,
 LazyModalRenderer,
 LazyOneTapRenderer,
Expand DownExpand Up@@ -99,6 +102,16 @@ export type ComponentControls = {
 notify?: boolean;
 },
 ) => void;
 openDrawer: <T extends 'checkout'>(
 drawer: T,
 props: T extends 'checkout' ? __experimental_CheckoutProps : never,
 ) => void;
 closeDrawer: (
 drawer: 'checkout',
 options?: {
 notify?: boolean;
 },
 ) => void;
 prefetch: (component: 'organizationSwitcher') => void;
 // Special case, as the impersonation fab mounts automatically
 mountImpersonationFab: () => void;
Expand DownExpand Up@@ -131,6 +144,10 @@ interface ComponentsState {
 blankCaptchaModal: null;
 organizationSwitcherPrefetch: boolean;
 waitlistModal: null | WaitlistProps;
 checkoutDrawer: {
 open: false;
 props: null | __experimental_CheckoutProps;
 };
 nodes: Map<HTMLDivElement, HtmlNodeOptions>;
 impersonationFab: boolean;
}
Expand DownExpand Up@@ -212,6 +229,10 @@ const Components = (props: ComponentsProps) => {
 organizationSwitcherPrefetch: false,
 waitlistModal: null,
 blankCaptchaModal: null,
 checkoutDrawer: {
 open: false,
 props: null,
 },
 nodes: new Map(),
 impersonationFab: false,
 });
Expand All@@ -226,6 +247,7 @@ const Components = (props: ComponentsProps) => {
 createOrganizationModal,
 waitlistModal,
 blankCaptchaModal,
 checkoutDrawer,
 nodes,
 } = state;

Expand DownExpand Up@@ -322,6 +344,26 @@ const Components = (props: ComponentsProps) => {
 setState(s => ({ ...s, impersonationFab: true }));
 };

 componentsControls.openDrawer = (name, props) => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 open: true,
 props,
 },
 }));
 };

 componentsControls.closeDrawer = name => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 ...s[`${name}Drawer`],
 open: false,
 },
 }));
 };

Comment on lines

+347
 to 
+365

@alexcarpenteralexcarpenterMar 28, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Introducing new drawer specific methods as we want to have an exit animation for the drawers, and removing all the props causes issues with portaling into the profile components.
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

It would be great to consolidate the modal/drawer handling at some point in the future. I would expect them to function the same, just be a different flavor of UI. Maybe there's a good reason to keep them separate though? 🤔
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

If we want modals to have an exit animation, we'd need to follow this updated drawer pattern, currently all modals are removed immediately but wiping out the props.

 componentsControls.prefetch = component => {
 setState(s => ({ ...s, [`${component}Prefetch`]: true }));
 };
Expand DownExpand Up@@ -481,6 +523,26 @@ const Components = (props: ComponentsProps) => {
 </LazyModalRenderer>
 );

 const mountedCheckoutDrawer = checkoutDrawer.props && (
 <LazyDrawerRenderer
 globalAppearance={state.appearance}
 appearanceKey={'checkout' as any}
 componentAppearance={{}}
 flowName={'checkout'}
 open={checkoutDrawer.open}
 onOpenChange={() => componentsControls.closeDrawer('checkout')}
 componentName={'Checkout'}
 portalId={checkoutDrawer.props.portalId}
 >
 <Checkout
 planId={checkoutDrawer.props.planId}
 planPeriod={checkoutDrawer.props.planPeriod}
 orgId={checkoutDrawer.props.orgId}
 onSubscriptionComplete={checkoutDrawer.props.onSubscriptionComplete}
 />
 </LazyDrawerRenderer>
 );

 return (
 <Suspense fallback={''}>
 <LazyProviders
Expand DownExpand Up@@ -511,6 +573,7 @@ const Components = (props: ComponentsProps) => {
 {createOrganizationModal && mountedCreateOrganizationModal}
 {waitlistModal && mountedWaitlistModal}
 {blankCaptchaModal && mountedBlankCaptchaModal}
 {mountedCheckoutDrawer}

 {state.impersonationFab && (
 <LazyImpersonationFabProvider globalAppearance={state.appearance}>
Expand Down

40 changes: 11 additions & 29 deletions
packages/clerk-js/src/ui/components/Checkout/Checkout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
import type { __experimental_CheckoutProps } from '@clerk/types';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { useCheckoutContext, withCoreUserGuard } from '../../contexts';
import { __experimental_CheckoutContext } from '../../contexts';
import { Flow } from '../../customizables';
import { Drawer } from '../../elements';
import { Route, Switch } from '../../router';
import { CheckoutPage } from './CheckoutPage';

export const __experimental_Checkout = (props: __experimental_CheckoutProps) => {
 return (
 <Flow.Root flow='checkout'>
 <Flow.Part>
 <Switch>
 <Route>
 <AuthenticatedRoutes {...props} />
 </Route>
 </Switch>
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 }}
 >
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </__experimental_CheckoutContext.Provider>
 </Flow.Part>
 </Flow.Root>
 );
};

const AuthenticatedRoutes = withCoreUserGuard((props: __experimental_CheckoutProps) => {
 const { mode = 'mounted', isOpen = false, setIsOpen = () => {} } = useCheckoutContext();

 return (
 <Drawer.Root
 open={isOpen}
 onOpenChange={setIsOpen}
 strategy={mode === 'mounted' ? 'fixed' : 'absolute'}
 portalProps={{
 id: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
 }}
 >
 <Drawer.Overlay />
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </Drawer.Root>
 );
});

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

import { useCheckoutContext } from '../../contexts';
import { Box, Button, descriptors, Heading, Icon, localizationKeys, Span, Text } from '../../customizables';
import { Drawer, LineItems } from '../../elements';
import { Drawer, LineItems, useDrawerContext } from '../../elements';
import { Check } from '../../icons';

const capitalize = (name: string) => name[0].toUpperCase() + name.slice(1);

export const CheckoutComplete = ({ checkout }: { checkout: __experimental_CommerceCheckoutResource }) => {
 const { setIsOpen } = useCheckoutContext();
 const { setIsOpen } = useDrawerContext();

 const handleClose = () => {
 if (setIsOpen) {
Expand Down

34 changes: 8 additions & 26 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,9 @@ import type {
import { useState } from 'react';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { __experimental_CheckoutContext, usePricingTableContext } from '../../contexts';
import { usePricingTableContext } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { usePlans } from '../../hooks';
import { __experimental_Checkout } from '../Checkout';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
import { SubscriptionDetailDrawer } from './SubscriptionDetailDrawer';
Expand All@@ -25,10 +24,8 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 const { plans, subscriptions, revalidate } = usePlans({ subscriberType });

 const [planPeriod, setPlanPeriod] = useState<__experimental_CommerceSubscriptionPlanPeriod>('month');
 const [checkoutPlan, setCheckoutPlan] = useState<__experimental_CommercePlanResource>();
 const [detailSubscription, setDetailSubscription] = useState<__experimental_CommerceSubscriptionResource>();

 const [showCheckout, setShowCheckout] = useState(false);
 const [showSubscriptionDetailDrawer, setShowSubscriptionDetailDrawer] = useState(false);

 const selectPlan = (plan: __experimental_CommercePlanResource) => {
Expand All@@ -40,8 +37,13 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 setDetailSubscription(activeSubscription);
 setShowSubscriptionDetailDrawer(true);
 } else {
 setCheckoutPlan(plan);
 setShowCheckout(true);
 clerk.__internal_openCheckout({
 planId: plan.id,
 planPeriod,
 orgId: subscriberType === 'org' ? organization?.id : undefined,
 onSubscriptionComplete: onSubscriptionChange,
 portalId: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

does mode indicate the context PricingTable is rendered in? I feel like I would expect mode to dictate how PricingTable behaves itself, but not necessarily how it behaves depending on where it's rendered.
As a semi-related nit, I might rename mode to context.
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Mode is set on the PricingTable and I think was originally adding following the other components, but there is no modal mode for PricingTable, so yeah, it is confusing, as its only a mounted component. Will refactor naming approach in a follow up PR.

Comment on lines

+40
 to 
+45

@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This is much cleaner!
 });
 }
 };

Expand DownExpand Up@@ -74,26 +76,6 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 appearanceKey='checkout'
 appearance={props.checkoutProps?.appearance}
 >
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 mode,
 isOpen: showCheckout,
 setIsOpen: setShowCheckout,
 }}
 >
 {/*TODO: Used by InvisibleRootBox, can we simplify? */}
 <div>
 {checkoutPlan && (
 <__experimental_Checkout
 planPeriod={planPeriod}
 planId={checkoutPlan.id}
 orgId={subscriberType === 'org' ? organization?.id : undefined}
 onSubscriptionComplete={onSubscriptionChange}
 />
 )}
 </div>
 </__experimental_CheckoutContext.Provider>
 <SubscriptionDetailDrawer
 isOpen={showSubscriptionDetailDrawer}
 setIsOpen={setShowSubscriptionDetailDrawer}
Expand Down
Loading

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

Skip to content
feat(clerk-js,types,clerk-react): Add internal open/close checkout methods#5481

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

alexcarpenter
merged 14 commits into

from

Apr 3, 2025
 Merged


feat(clerk-js,types,clerk-react): Add internal open/close checkout methods
#5481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
dfe84ea

init


alexcarpenter Mar 28, 2025
44d8879

WIP


alexcarpenter Mar 28, 2025
c22a321

wip


alexcarpenter Mar 28, 2025
8acac44

wip


alexcarpenter Mar 28, 2025
bb4212b

wip


alexcarpenter Mar 28, 2025
41fd1a0

wip


alexcarpenter Mar 28, 2025
e9e59d7

fix


alexcarpenter Mar 28, 2025
5c28068

fix


alexcarpenter Mar 28, 2025
0151de0

add changeset


alexcarpenter Mar 28, 2025
2b31f6e

handle close


alexcarpenter Mar 28, 2025
1e2e028

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
f779ac7

pass props


alexcarpenter Mar 28, 2025
1608130

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
d29bf85

Merge branch 'main' into alexcarpenter/com-257-add-clerkopencheckout-…


alexcarpenter Apr 3, 2025

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


7 changes: 7 additions & 0 deletions
.changeset/fancy-lies-sell.md

View file


Open in desktop

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

Introduce `clerk.__internal_openCheckout()` and `clerk.__internal_closeCheckout()` methods and remove `<Checkout />` from within the `<PricingTable />` component.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "55KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "96KB" },
 { "path": "./dist/vendors*.js", "maxSize": "30KB" },
 { "path": "./dist/vendors*.js", "maxSize": "35KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __experimental_CommerceNamespace,
 __experimental_PricingTableProps,
 __internal_ComponentNavigationContext,
Expand DownExpand Up@@ -520,6 +521,18 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls.ensureMounted().then(controls => controls.closeModal('signIn'));
 };

 public __internal_openCheckout = (props?: __experimental_CheckoutProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Checkout' })
 .then(controls => controls.openDrawer('checkout', props || {}));
 };

 public __internal_closeCheckout = (): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted().then(controls => controls.closeDrawer('checkout'));
 };

 public __internal_openReverification = (props?: __internal_UserVerificationModalProps): void => {
 this.assertComponentsReady(this.#componentControls);
 if (noUserExists(this)) {
Expand Down

63 changes: 63 additions & 0 deletions
packages/clerk-js/src/ui/Components.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useSafeLayoutEffect } from '@clerk/shared/react';
import { createDeferredPromise } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __internal_UserVerificationProps,
 Appearance,
 Clerk,
Expand All@@ -24,6 +25,7 @@ import { useClerkModalStateParams } from './hooks/useClerkModalStateParams';
import type { ClerkComponentName } from './lazyModules/components';
import {
 BlankCaptchaModal,
 Checkout,
 CreateOrganizationModal,
 ImpersonationFab,
 KeylessPrompt,
Expand All@@ -37,6 +39,7 @@ import {
} from './lazyModules/components';
import {
 LazyComponentRenderer,
 LazyDrawerRenderer,
 LazyImpersonationFabProvider,
 LazyModalRenderer,
 LazyOneTapRenderer,
Expand DownExpand Up@@ -99,6 +102,16 @@ export type ComponentControls = {
 notify?: boolean;
 },
 ) => void;
 openDrawer: <T extends 'checkout'>(
 drawer: T,
 props: T extends 'checkout' ? __experimental_CheckoutProps : never,
 ) => void;
 closeDrawer: (
 drawer: 'checkout',
 options?: {
 notify?: boolean;
 },
 ) => void;
 prefetch: (component: 'organizationSwitcher') => void;
 // Special case, as the impersonation fab mounts automatically
 mountImpersonationFab: () => void;
Expand DownExpand Up@@ -131,6 +144,10 @@ interface ComponentsState {
 blankCaptchaModal: null;
 organizationSwitcherPrefetch: boolean;
 waitlistModal: null | WaitlistProps;
 checkoutDrawer: {
 open: false;
 props: null | __experimental_CheckoutProps;
 };
 nodes: Map<HTMLDivElement, HtmlNodeOptions>;
 impersonationFab: boolean;
}
Expand DownExpand Up@@ -212,6 +229,10 @@ const Components = (props: ComponentsProps) => {
 organizationSwitcherPrefetch: false,
 waitlistModal: null,
 blankCaptchaModal: null,
 checkoutDrawer: {
 open: false,
 props: null,
 },
 nodes: new Map(),
 impersonationFab: false,
 });
Expand All@@ -226,6 +247,7 @@ const Components = (props: ComponentsProps) => {
 createOrganizationModal,
 waitlistModal,
 blankCaptchaModal,
 checkoutDrawer,
 nodes,
 } = state;

Expand DownExpand Up@@ -322,6 +344,26 @@ const Components = (props: ComponentsProps) => {
 setState(s => ({ ...s, impersonationFab: true }));
 };

 componentsControls.openDrawer = (name, props) => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 open: true,
 props,
 },
 }));
 };

 componentsControls.closeDrawer = name => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 ...s[`${name}Drawer`],
 open: false,
 },
 }));
 };

Comment on lines

+347
 to 
+365

@alexcarpenteralexcarpenterMar 28, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Introducing new drawer specific methods as we want to have an exit animation for the drawers, and removing all the props causes issues with portaling into the profile components.
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

It would be great to consolidate the modal/drawer handling at some point in the future. I would expect them to function the same, just be a different flavor of UI. Maybe there's a good reason to keep them separate though? 🤔
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

If we want modals to have an exit animation, we'd need to follow this updated drawer pattern, currently all modals are removed immediately but wiping out the props.

 componentsControls.prefetch = component => {
 setState(s => ({ ...s, [`${component}Prefetch`]: true }));
 };
Expand DownExpand Up@@ -481,6 +523,26 @@ const Components = (props: ComponentsProps) => {
 </LazyModalRenderer>
 );

 const mountedCheckoutDrawer = checkoutDrawer.props && (
 <LazyDrawerRenderer
 globalAppearance={state.appearance}
 appearanceKey={'checkout' as any}
 componentAppearance={{}}
 flowName={'checkout'}
 open={checkoutDrawer.open}
 onOpenChange={() => componentsControls.closeDrawer('checkout')}
 componentName={'Checkout'}
 portalId={checkoutDrawer.props.portalId}
 >
 <Checkout
 planId={checkoutDrawer.props.planId}
 planPeriod={checkoutDrawer.props.planPeriod}
 orgId={checkoutDrawer.props.orgId}
 onSubscriptionComplete={checkoutDrawer.props.onSubscriptionComplete}
 />
 </LazyDrawerRenderer>
 );

 return (
 <Suspense fallback={''}>
 <LazyProviders
Expand DownExpand Up@@ -511,6 +573,7 @@ const Components = (props: ComponentsProps) => {
 {createOrganizationModal && mountedCreateOrganizationModal}
 {waitlistModal && mountedWaitlistModal}
 {blankCaptchaModal && mountedBlankCaptchaModal}
 {mountedCheckoutDrawer}

 {state.impersonationFab && (
 <LazyImpersonationFabProvider globalAppearance={state.appearance}>
Expand Down

40 changes: 11 additions & 29 deletions
packages/clerk-js/src/ui/components/Checkout/Checkout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
import type { __experimental_CheckoutProps } from '@clerk/types';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { useCheckoutContext, withCoreUserGuard } from '../../contexts';
import { __experimental_CheckoutContext } from '../../contexts';
import { Flow } from '../../customizables';
import { Drawer } from '../../elements';
import { Route, Switch } from '../../router';
import { CheckoutPage } from './CheckoutPage';

export const __experimental_Checkout = (props: __experimental_CheckoutProps) => {
 return (
 <Flow.Root flow='checkout'>
 <Flow.Part>
 <Switch>
 <Route>
 <AuthenticatedRoutes {...props} />
 </Route>
 </Switch>
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 }}
 >
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </__experimental_CheckoutContext.Provider>
 </Flow.Part>
 </Flow.Root>
 );
};

const AuthenticatedRoutes = withCoreUserGuard((props: __experimental_CheckoutProps) => {
 const { mode = 'mounted', isOpen = false, setIsOpen = () => {} } = useCheckoutContext();

 return (
 <Drawer.Root
 open={isOpen}
 onOpenChange={setIsOpen}
 strategy={mode === 'mounted' ? 'fixed' : 'absolute'}
 portalProps={{
 id: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
 }}
 >
 <Drawer.Overlay />
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </Drawer.Root>
 );
});

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

import { useCheckoutContext } from '../../contexts';
import { Box, Button, descriptors, Heading, Icon, localizationKeys, Span, Text } from '../../customizables';
import { Drawer, LineItems } from '../../elements';
import { Drawer, LineItems, useDrawerContext } from '../../elements';
import { Check } from '../../icons';

const capitalize = (name: string) => name[0].toUpperCase() + name.slice(1);

export const CheckoutComplete = ({ checkout }: { checkout: __experimental_CommerceCheckoutResource }) => {
 const { setIsOpen } = useCheckoutContext();
 const { setIsOpen } = useDrawerContext();

 const handleClose = () => {
 if (setIsOpen) {
Expand Down

34 changes: 8 additions & 26 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,9 @@ import type {
import { useState } from 'react';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { __experimental_CheckoutContext, usePricingTableContext } from '../../contexts';
import { usePricingTableContext } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { usePlans } from '../../hooks';
import { __experimental_Checkout } from '../Checkout';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
import { SubscriptionDetailDrawer } from './SubscriptionDetailDrawer';
Expand All@@ -25,10 +24,8 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 const { plans, subscriptions, revalidate } = usePlans({ subscriberType });

 const [planPeriod, setPlanPeriod] = useState<__experimental_CommerceSubscriptionPlanPeriod>('month');
 const [checkoutPlan, setCheckoutPlan] = useState<__experimental_CommercePlanResource>();
 const [detailSubscription, setDetailSubscription] = useState<__experimental_CommerceSubscriptionResource>();

 const [showCheckout, setShowCheckout] = useState(false);
 const [showSubscriptionDetailDrawer, setShowSubscriptionDetailDrawer] = useState(false);

 const selectPlan = (plan: __experimental_CommercePlanResource) => {
Expand All@@ -40,8 +37,13 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 setDetailSubscription(activeSubscription);
 setShowSubscriptionDetailDrawer(true);
 } else {
 setCheckoutPlan(plan);
 setShowCheckout(true);
 clerk.__internal_openCheckout({
 planId: plan.id,
 planPeriod,
 orgId: subscriberType === 'org' ? organization?.id : undefined,
 onSubscriptionComplete: onSubscriptionChange,
 portalId: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

does mode indicate the context PricingTable is rendered in? I feel like I would expect mode to dictate how PricingTable behaves itself, but not necessarily how it behaves depending on where it's rendered.
As a semi-related nit, I might rename mode to context.
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Mode is set on the PricingTable and I think was originally adding following the other components, but there is no modal mode for PricingTable, so yeah, it is confusing, as its only a mounted component. Will refactor naming approach in a follow up PR.

Comment on lines

+40
 to 
+45

@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This is much cleaner!
 });
 }
 };

Expand DownExpand Up@@ -74,26 +76,6 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 appearanceKey='checkout'
 appearance={props.checkoutProps?.appearance}
 >
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 mode,
 isOpen: showCheckout,
 setIsOpen: setShowCheckout,
 }}
 >
 {/*TODO: Used by InvisibleRootBox, can we simplify? */}
 <div>
 {checkoutPlan && (
 <__experimental_Checkout
 planPeriod={planPeriod}
 planId={checkoutPlan.id}
 orgId={subscriberType === 'org' ? organization?.id : undefined}
 onSubscriptionComplete={onSubscriptionChange}
 />
 )}
 </div>
 </__experimental_CheckoutContext.Provider>
 <SubscriptionDetailDrawer
 isOpen={showSubscriptionDetailDrawer}
 setIsOpen={setShowSubscriptionDetailDrawer}
Expand Down
Loading

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

Skip to content
feat(clerk-js,types,clerk-react): Add internal open/close checkout methods#5481

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

alexcarpenter
merged 14 commits into

from

Apr 3, 2025
 Merged


feat(clerk-js,types,clerk-react): Add internal open/close checkout methods
#5481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
dfe84ea

init


alexcarpenter Mar 28, 2025
44d8879

WIP


alexcarpenter Mar 28, 2025
c22a321

wip


alexcarpenter Mar 28, 2025
8acac44

wip


alexcarpenter Mar 28, 2025
bb4212b

wip


alexcarpenter Mar 28, 2025
41fd1a0

wip


alexcarpenter Mar 28, 2025
e9e59d7

fix


alexcarpenter Mar 28, 2025
5c28068

fix


alexcarpenter Mar 28, 2025
0151de0

add changeset


alexcarpenter Mar 28, 2025
2b31f6e

handle close


alexcarpenter Mar 28, 2025
1e2e028

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
f779ac7

pass props


alexcarpenter Mar 28, 2025
1608130

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
d29bf85

Merge branch 'main' into alexcarpenter/com-257-add-clerkopencheckout-…


alexcarpenter Apr 3, 2025

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


7 changes: 7 additions & 0 deletions
.changeset/fancy-lies-sell.md

View file


Open in desktop

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

Introduce `clerk.__internal_openCheckout()` and `clerk.__internal_closeCheckout()` methods and remove `<Checkout />` from within the `<PricingTable />` component.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "55KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "96KB" },
 { "path": "./dist/vendors*.js", "maxSize": "30KB" },
 { "path": "./dist/vendors*.js", "maxSize": "35KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __experimental_CommerceNamespace,
 __experimental_PricingTableProps,
 __internal_ComponentNavigationContext,
Expand DownExpand Up@@ -520,6 +521,18 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls.ensureMounted().then(controls => controls.closeModal('signIn'));
 };

 public __internal_openCheckout = (props?: __experimental_CheckoutProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Checkout' })
 .then(controls => controls.openDrawer('checkout', props || {}));
 };

 public __internal_closeCheckout = (): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted().then(controls => controls.closeDrawer('checkout'));
 };

 public __internal_openReverification = (props?: __internal_UserVerificationModalProps): void => {
 this.assertComponentsReady(this.#componentControls);
 if (noUserExists(this)) {
Expand Down

63 changes: 63 additions & 0 deletions
packages/clerk-js/src/ui/Components.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useSafeLayoutEffect } from '@clerk/shared/react';
import { createDeferredPromise } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __internal_UserVerificationProps,
 Appearance,
 Clerk,
Expand All@@ -24,6 +25,7 @@ import { useClerkModalStateParams } from './hooks/useClerkModalStateParams';
import type { ClerkComponentName } from './lazyModules/components';
import {
 BlankCaptchaModal,
 Checkout,
 CreateOrganizationModal,
 ImpersonationFab,
 KeylessPrompt,
Expand All@@ -37,6 +39,7 @@ import {
} from './lazyModules/components';
import {
 LazyComponentRenderer,
 LazyDrawerRenderer,
 LazyImpersonationFabProvider,
 LazyModalRenderer,
 LazyOneTapRenderer,
Expand DownExpand Up@@ -99,6 +102,16 @@ export type ComponentControls = {
 notify?: boolean;
 },
 ) => void;
 openDrawer: <T extends 'checkout'>(
 drawer: T,
 props: T extends 'checkout' ? __experimental_CheckoutProps : never,
 ) => void;
 closeDrawer: (
 drawer: 'checkout',
 options?: {
 notify?: boolean;
 },
 ) => void;
 prefetch: (component: 'organizationSwitcher') => void;
 // Special case, as the impersonation fab mounts automatically
 mountImpersonationFab: () => void;
Expand DownExpand Up@@ -131,6 +144,10 @@ interface ComponentsState {
 blankCaptchaModal: null;
 organizationSwitcherPrefetch: boolean;
 waitlistModal: null | WaitlistProps;
 checkoutDrawer: {
 open: false;
 props: null | __experimental_CheckoutProps;
 };
 nodes: Map<HTMLDivElement, HtmlNodeOptions>;
 impersonationFab: boolean;
}
Expand DownExpand Up@@ -212,6 +229,10 @@ const Components = (props: ComponentsProps) => {
 organizationSwitcherPrefetch: false,
 waitlistModal: null,
 blankCaptchaModal: null,
 checkoutDrawer: {
 open: false,
 props: null,
 },
 nodes: new Map(),
 impersonationFab: false,
 });
Expand All@@ -226,6 +247,7 @@ const Components = (props: ComponentsProps) => {
 createOrganizationModal,
 waitlistModal,
 blankCaptchaModal,
 checkoutDrawer,
 nodes,
 } = state;

Expand DownExpand Up@@ -322,6 +344,26 @@ const Components = (props: ComponentsProps) => {
 setState(s => ({ ...s, impersonationFab: true }));
 };

 componentsControls.openDrawer = (name, props) => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 open: true,
 props,
 },
 }));
 };

 componentsControls.closeDrawer = name => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 ...s[`${name}Drawer`],
 open: false,
 },
 }));
 };

Comment on lines

+347
 to 
+365

@alexcarpenteralexcarpenterMar 28, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Introducing new drawer specific methods as we want to have an exit animation for the drawers, and removing all the props causes issues with portaling into the profile components.
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

It would be great to consolidate the modal/drawer handling at some point in the future. I would expect them to function the same, just be a different flavor of UI. Maybe there's a good reason to keep them separate though? 🤔
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

If we want modals to have an exit animation, we'd need to follow this updated drawer pattern, currently all modals are removed immediately but wiping out the props.

 componentsControls.prefetch = component => {
 setState(s => ({ ...s, [`${component}Prefetch`]: true }));
 };
Expand DownExpand Up@@ -481,6 +523,26 @@ const Components = (props: ComponentsProps) => {
 </LazyModalRenderer>
 );

 const mountedCheckoutDrawer = checkoutDrawer.props && (
 <LazyDrawerRenderer
 globalAppearance={state.appearance}
 appearanceKey={'checkout' as any}
 componentAppearance={{}}
 flowName={'checkout'}
 open={checkoutDrawer.open}
 onOpenChange={() => componentsControls.closeDrawer('checkout')}
 componentName={'Checkout'}
 portalId={checkoutDrawer.props.portalId}
 >
 <Checkout
 planId={checkoutDrawer.props.planId}
 planPeriod={checkoutDrawer.props.planPeriod}
 orgId={checkoutDrawer.props.orgId}
 onSubscriptionComplete={checkoutDrawer.props.onSubscriptionComplete}
 />
 </LazyDrawerRenderer>
 );

 return (
 <Suspense fallback={''}>
 <LazyProviders
Expand DownExpand Up@@ -511,6 +573,7 @@ const Components = (props: ComponentsProps) => {
 {createOrganizationModal && mountedCreateOrganizationModal}
 {waitlistModal && mountedWaitlistModal}
 {blankCaptchaModal && mountedBlankCaptchaModal}
 {mountedCheckoutDrawer}

 {state.impersonationFab && (
 <LazyImpersonationFabProvider globalAppearance={state.appearance}>
Expand Down

40 changes: 11 additions & 29 deletions
packages/clerk-js/src/ui/components/Checkout/Checkout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
import type { __experimental_CheckoutProps } from '@clerk/types';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { useCheckoutContext, withCoreUserGuard } from '../../contexts';
import { __experimental_CheckoutContext } from '../../contexts';
import { Flow } from '../../customizables';
import { Drawer } from '../../elements';
import { Route, Switch } from '../../router';
import { CheckoutPage } from './CheckoutPage';

export const __experimental_Checkout = (props: __experimental_CheckoutProps) => {
 return (
 <Flow.Root flow='checkout'>
 <Flow.Part>
 <Switch>
 <Route>
 <AuthenticatedRoutes {...props} />
 </Route>
 </Switch>
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 }}
 >
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </__experimental_CheckoutContext.Provider>
 </Flow.Part>
 </Flow.Root>
 );
};

const AuthenticatedRoutes = withCoreUserGuard((props: __experimental_CheckoutProps) => {
 const { mode = 'mounted', isOpen = false, setIsOpen = () => {} } = useCheckoutContext();

 return (
 <Drawer.Root
 open={isOpen}
 onOpenChange={setIsOpen}
 strategy={mode === 'mounted' ? 'fixed' : 'absolute'}
 portalProps={{
 id: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
 }}
 >
 <Drawer.Overlay />
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </Drawer.Root>
 );
});

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

import { useCheckoutContext } from '../../contexts';
import { Box, Button, descriptors, Heading, Icon, localizationKeys, Span, Text } from '../../customizables';
import { Drawer, LineItems } from '../../elements';
import { Drawer, LineItems, useDrawerContext } from '../../elements';
import { Check } from '../../icons';

const capitalize = (name: string) => name[0].toUpperCase() + name.slice(1);

export const CheckoutComplete = ({ checkout }: { checkout: __experimental_CommerceCheckoutResource }) => {
 const { setIsOpen } = useCheckoutContext();
 const { setIsOpen } = useDrawerContext();

 const handleClose = () => {
 if (setIsOpen) {
Expand Down

34 changes: 8 additions & 26 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,9 @@ import type {
import { useState } from 'react';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { __experimental_CheckoutContext, usePricingTableContext } from '../../contexts';
import { usePricingTableContext } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { usePlans } from '../../hooks';
import { __experimental_Checkout } from '../Checkout';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
import { SubscriptionDetailDrawer } from './SubscriptionDetailDrawer';
Expand All@@ -25,10 +24,8 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 const { plans, subscriptions, revalidate } = usePlans({ subscriberType });

 const [planPeriod, setPlanPeriod] = useState<__experimental_CommerceSubscriptionPlanPeriod>('month');
 const [checkoutPlan, setCheckoutPlan] = useState<__experimental_CommercePlanResource>();
 const [detailSubscription, setDetailSubscription] = useState<__experimental_CommerceSubscriptionResource>();

 const [showCheckout, setShowCheckout] = useState(false);
 const [showSubscriptionDetailDrawer, setShowSubscriptionDetailDrawer] = useState(false);

 const selectPlan = (plan: __experimental_CommercePlanResource) => {
Expand All@@ -40,8 +37,13 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 setDetailSubscription(activeSubscription);
 setShowSubscriptionDetailDrawer(true);
 } else {
 setCheckoutPlan(plan);
 setShowCheckout(true);
 clerk.__internal_openCheckout({
 planId: plan.id,
 planPeriod,
 orgId: subscriberType === 'org' ? organization?.id : undefined,
 onSubscriptionComplete: onSubscriptionChange,
 portalId: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

does mode indicate the context PricingTable is rendered in? I feel like I would expect mode to dictate how PricingTable behaves itself, but not necessarily how it behaves depending on where it's rendered.
As a semi-related nit, I might rename mode to context.
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Mode is set on the PricingTable and I think was originally adding following the other components, but there is no modal mode for PricingTable, so yeah, it is confusing, as its only a mounted component. Will refactor naming approach in a follow up PR.

Comment on lines

+40
 to 
+45

@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This is much cleaner!
 });
 }
 };

Expand DownExpand Up@@ -74,26 +76,6 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 appearanceKey='checkout'
 appearance={props.checkoutProps?.appearance}
 >
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 mode,
 isOpen: showCheckout,
 setIsOpen: setShowCheckout,
 }}
 >
 {/*TODO: Used by InvisibleRootBox, can we simplify? */}
 <div>
 {checkoutPlan && (
 <__experimental_Checkout
 planPeriod={planPeriod}
 planId={checkoutPlan.id}
 orgId={subscriberType === 'org' ? organization?.id : undefined}
 onSubscriptionComplete={onSubscriptionChange}
 />
 )}
 </div>
 </__experimental_CheckoutContext.Provider>
 <SubscriptionDetailDrawer
 isOpen={showSubscriptionDetailDrawer}
 setIsOpen={setShowSubscriptionDetailDrawer}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js,types,clerk-react): Add internal open/close checkout methods#5481

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

alexcarpenter
merged 14 commits into

from

Apr 3, 2025
 Merged


feat(clerk-js,types,clerk-react): Add internal open/close checkout methods
#5481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
dfe84ea

init


alexcarpenter Mar 28, 2025
44d8879

WIP


alexcarpenter Mar 28, 2025
c22a321

wip


alexcarpenter Mar 28, 2025
8acac44

wip


alexcarpenter Mar 28, 2025
bb4212b

wip


alexcarpenter Mar 28, 2025
41fd1a0

wip


alexcarpenter Mar 28, 2025
e9e59d7

fix


alexcarpenter Mar 28, 2025
5c28068

fix


alexcarpenter Mar 28, 2025
0151de0

add changeset


alexcarpenter Mar 28, 2025
2b31f6e

handle close


alexcarpenter Mar 28, 2025
1e2e028

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
f779ac7

pass props


alexcarpenter Mar 28, 2025
1608130

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
d29bf85

Merge branch 'main' into alexcarpenter/com-257-add-clerkopencheckout-…


alexcarpenter Apr 3, 2025

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


7 changes: 7 additions & 0 deletions
.changeset/fancy-lies-sell.md

View file


Open in desktop

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

Introduce `clerk.__internal_openCheckout()` and `clerk.__internal_closeCheckout()` methods and remove `<Checkout />` from within the `<PricingTable />` component.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "55KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "96KB" },
 { "path": "./dist/vendors*.js", "maxSize": "30KB" },
 { "path": "./dist/vendors*.js", "maxSize": "35KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __experimental_CommerceNamespace,
 __experimental_PricingTableProps,
 __internal_ComponentNavigationContext,
Expand DownExpand Up@@ -520,6 +521,18 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls.ensureMounted().then(controls => controls.closeModal('signIn'));
 };

 public __internal_openCheckout = (props?: __experimental_CheckoutProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Checkout' })
 .then(controls => controls.openDrawer('checkout', props || {}));
 };

 public __internal_closeCheckout = (): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted().then(controls => controls.closeDrawer('checkout'));
 };

 public __internal_openReverification = (props?: __internal_UserVerificationModalProps): void => {
 this.assertComponentsReady(this.#componentControls);
 if (noUserExists(this)) {
Expand Down

63 changes: 63 additions & 0 deletions
packages/clerk-js/src/ui/Components.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useSafeLayoutEffect } from '@clerk/shared/react';
import { createDeferredPromise } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __internal_UserVerificationProps,
 Appearance,
 Clerk,
Expand All@@ -24,6 +25,7 @@ import { useClerkModalStateParams } from './hooks/useClerkModalStateParams';
import type { ClerkComponentName } from './lazyModules/components';
import {
 BlankCaptchaModal,
 Checkout,
 CreateOrganizationModal,
 ImpersonationFab,
 KeylessPrompt,
Expand All@@ -37,6 +39,7 @@ import {
} from './lazyModules/components';
import {
 LazyComponentRenderer,
 LazyDrawerRenderer,
 LazyImpersonationFabProvider,
 LazyModalRenderer,
 LazyOneTapRenderer,
Expand DownExpand Up@@ -99,6 +102,16 @@ export type ComponentControls = {
 notify?: boolean;
 },
 ) => void;
 openDrawer: <T extends 'checkout'>(
 drawer: T,
 props: T extends 'checkout' ? __experimental_CheckoutProps : never,
 ) => void;
 closeDrawer: (
 drawer: 'checkout',
 options?: {
 notify?: boolean;
 },
 ) => void;
 prefetch: (component: 'organizationSwitcher') => void;
 // Special case, as the impersonation fab mounts automatically
 mountImpersonationFab: () => void;
Expand DownExpand Up@@ -131,6 +144,10 @@ interface ComponentsState {
 blankCaptchaModal: null;
 organizationSwitcherPrefetch: boolean;
 waitlistModal: null | WaitlistProps;
 checkoutDrawer: {
 open: false;
 props: null | __experimental_CheckoutProps;
 };
 nodes: Map<HTMLDivElement, HtmlNodeOptions>;
 impersonationFab: boolean;
}
Expand DownExpand Up@@ -212,6 +229,10 @@ const Components = (props: ComponentsProps) => {
 organizationSwitcherPrefetch: false,
 waitlistModal: null,
 blankCaptchaModal: null,
 checkoutDrawer: {
 open: false,
 props: null,
 },
 nodes: new Map(),
 impersonationFab: false,
 });
Expand All@@ -226,6 +247,7 @@ const Components = (props: ComponentsProps) => {
 createOrganizationModal,
 waitlistModal,
 blankCaptchaModal,
 checkoutDrawer,
 nodes,
 } = state;

Expand DownExpand Up@@ -322,6 +344,26 @@ const Components = (props: ComponentsProps) => {
 setState(s => ({ ...s, impersonationFab: true }));
 };

 componentsControls.openDrawer = (name, props) => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 open: true,
 props,
 },
 }));
 };

 componentsControls.closeDrawer = name => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 ...s[`${name}Drawer`],
 open: false,
 },
 }));
 };

Comment on lines

+347
 to 
+365

@alexcarpenteralexcarpenterMar 28, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Introducing new drawer specific methods as we want to have an exit animation for the drawers, and removing all the props causes issues with portaling into the profile components.
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

It would be great to consolidate the modal/drawer handling at some point in the future. I would expect them to function the same, just be a different flavor of UI. Maybe there's a good reason to keep them separate though? 🤔
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

If we want modals to have an exit animation, we'd need to follow this updated drawer pattern, currently all modals are removed immediately but wiping out the props.

 componentsControls.prefetch = component => {
 setState(s => ({ ...s, [`${component}Prefetch`]: true }));
 };
Expand DownExpand Up@@ -481,6 +523,26 @@ const Components = (props: ComponentsProps) => {
 </LazyModalRenderer>
 );

 const mountedCheckoutDrawer = checkoutDrawer.props && (
 <LazyDrawerRenderer
 globalAppearance={state.appearance}
 appearanceKey={'checkout' as any}
 componentAppearance={{}}
 flowName={'checkout'}
 open={checkoutDrawer.open}
 onOpenChange={() => componentsControls.closeDrawer('checkout')}
 componentName={'Checkout'}
 portalId={checkoutDrawer.props.portalId}
 >
 <Checkout
 planId={checkoutDrawer.props.planId}
 planPeriod={checkoutDrawer.props.planPeriod}
 orgId={checkoutDrawer.props.orgId}
 onSubscriptionComplete={checkoutDrawer.props.onSubscriptionComplete}
 />
 </LazyDrawerRenderer>
 );

 return (
 <Suspense fallback={''}>
 <LazyProviders
Expand DownExpand Up@@ -511,6 +573,7 @@ const Components = (props: ComponentsProps) => {
 {createOrganizationModal && mountedCreateOrganizationModal}
 {waitlistModal && mountedWaitlistModal}
 {blankCaptchaModal && mountedBlankCaptchaModal}
 {mountedCheckoutDrawer}

 {state.impersonationFab && (
 <LazyImpersonationFabProvider globalAppearance={state.appearance}>
Expand Down

40 changes: 11 additions & 29 deletions
packages/clerk-js/src/ui/components/Checkout/Checkout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
import type { __experimental_CheckoutProps } from '@clerk/types';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { useCheckoutContext, withCoreUserGuard } from '../../contexts';
import { __experimental_CheckoutContext } from '../../contexts';
import { Flow } from '../../customizables';
import { Drawer } from '../../elements';
import { Route, Switch } from '../../router';
import { CheckoutPage } from './CheckoutPage';

export const __experimental_Checkout = (props: __experimental_CheckoutProps) => {
 return (
 <Flow.Root flow='checkout'>
 <Flow.Part>
 <Switch>
 <Route>
 <AuthenticatedRoutes {...props} />
 </Route>
 </Switch>
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 }}
 >
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </__experimental_CheckoutContext.Provider>
 </Flow.Part>
 </Flow.Root>
 );
};

const AuthenticatedRoutes = withCoreUserGuard((props: __experimental_CheckoutProps) => {
 const { mode = 'mounted', isOpen = false, setIsOpen = () => {} } = useCheckoutContext();

 return (
 <Drawer.Root
 open={isOpen}
 onOpenChange={setIsOpen}
 strategy={mode === 'mounted' ? 'fixed' : 'absolute'}
 portalProps={{
 id: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
 }}
 >
 <Drawer.Overlay />
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </Drawer.Root>
 );
});

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

import { useCheckoutContext } from '../../contexts';
import { Box, Button, descriptors, Heading, Icon, localizationKeys, Span, Text } from '../../customizables';
import { Drawer, LineItems } from '../../elements';
import { Drawer, LineItems, useDrawerContext } from '../../elements';
import { Check } from '../../icons';

const capitalize = (name: string) => name[0].toUpperCase() + name.slice(1);

export const CheckoutComplete = ({ checkout }: { checkout: __experimental_CommerceCheckoutResource }) => {
 const { setIsOpen } = useCheckoutContext();
 const { setIsOpen } = useDrawerContext();

 const handleClose = () => {
 if (setIsOpen) {
Expand Down

34 changes: 8 additions & 26 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,9 @@ import type {
import { useState } from 'react';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { __experimental_CheckoutContext, usePricingTableContext } from '../../contexts';
import { usePricingTableContext } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { usePlans } from '../../hooks';
import { __experimental_Checkout } from '../Checkout';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
import { SubscriptionDetailDrawer } from './SubscriptionDetailDrawer';
Expand All@@ -25,10 +24,8 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 const { plans, subscriptions, revalidate } = usePlans({ subscriberType });

 const [planPeriod, setPlanPeriod] = useState<__experimental_CommerceSubscriptionPlanPeriod>('month');
 const [checkoutPlan, setCheckoutPlan] = useState<__experimental_CommercePlanResource>();
 const [detailSubscription, setDetailSubscription] = useState<__experimental_CommerceSubscriptionResource>();

 const [showCheckout, setShowCheckout] = useState(false);
 const [showSubscriptionDetailDrawer, setShowSubscriptionDetailDrawer] = useState(false);

 const selectPlan = (plan: __experimental_CommercePlanResource) => {
Expand All@@ -40,8 +37,13 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 setDetailSubscription(activeSubscription);
 setShowSubscriptionDetailDrawer(true);
 } else {
 setCheckoutPlan(plan);
 setShowCheckout(true);
 clerk.__internal_openCheckout({
 planId: plan.id,
 planPeriod,
 orgId: subscriberType === 'org' ? organization?.id : undefined,
 onSubscriptionComplete: onSubscriptionChange,
 portalId: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

does mode indicate the context PricingTable is rendered in? I feel like I would expect mode to dictate how PricingTable behaves itself, but not necessarily how it behaves depending on where it's rendered.
As a semi-related nit, I might rename mode to context.
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Mode is set on the PricingTable and I think was originally adding following the other components, but there is no modal mode for PricingTable, so yeah, it is confusing, as its only a mounted component. Will refactor naming approach in a follow up PR.

Comment on lines

+40
 to 
+45

@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This is much cleaner!
 });
 }
 };

Expand DownExpand Up@@ -74,26 +76,6 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 appearanceKey='checkout'
 appearance={props.checkoutProps?.appearance}
 >
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 mode,
 isOpen: showCheckout,
 setIsOpen: setShowCheckout,
 }}
 >
 {/*TODO: Used by InvisibleRootBox, can we simplify? */}
 <div>
 {checkoutPlan && (
 <__experimental_Checkout
 planPeriod={planPeriod}
 planId={checkoutPlan.id}
 orgId={subscriberType === 'org' ? organization?.id : undefined}
 onSubscriptionComplete={onSubscriptionChange}
 />
 )}
 </div>
 </__experimental_CheckoutContext.Provider>
 <SubscriptionDetailDrawer
 isOpen={showSubscriptionDetailDrawer}
 setIsOpen={setShowSubscriptionDetailDrawer}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js,types,clerk-react): Add internal open/close checkout methods#5481

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

alexcarpenter
merged 14 commits into

from

Apr 3, 2025
 Merged


feat(clerk-js,types,clerk-react): Add internal open/close checkout methods
#5481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
dfe84ea

init


alexcarpenter Mar 28, 2025
44d8879

WIP


alexcarpenter Mar 28, 2025
c22a321

wip


alexcarpenter Mar 28, 2025
8acac44

wip


alexcarpenter Mar 28, 2025
bb4212b

wip


alexcarpenter Mar 28, 2025
41fd1a0

wip


alexcarpenter Mar 28, 2025
e9e59d7

fix


alexcarpenter Mar 28, 2025
5c28068

fix


alexcarpenter Mar 28, 2025
0151de0

add changeset


alexcarpenter Mar 28, 2025
2b31f6e

handle close


alexcarpenter Mar 28, 2025
1e2e028

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
f779ac7

pass props


alexcarpenter Mar 28, 2025
1608130

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
d29bf85

Merge branch 'main' into alexcarpenter/com-257-add-clerkopencheckout-…


alexcarpenter Apr 3, 2025

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


7 changes: 7 additions & 0 deletions
.changeset/fancy-lies-sell.md

View file


Open in desktop

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

Introduce `clerk.__internal_openCheckout()` and `clerk.__internal_closeCheckout()` methods and remove `<Checkout />` from within the `<PricingTable />` component.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "55KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "96KB" },
 { "path": "./dist/vendors*.js", "maxSize": "30KB" },
 { "path": "./dist/vendors*.js", "maxSize": "35KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __experimental_CommerceNamespace,
 __experimental_PricingTableProps,
 __internal_ComponentNavigationContext,
Expand DownExpand Up@@ -520,6 +521,18 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls.ensureMounted().then(controls => controls.closeModal('signIn'));
 };

 public __internal_openCheckout = (props?: __experimental_CheckoutProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Checkout' })
 .then(controls => controls.openDrawer('checkout', props || {}));
 };

 public __internal_closeCheckout = (): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted().then(controls => controls.closeDrawer('checkout'));
 };

 public __internal_openReverification = (props?: __internal_UserVerificationModalProps): void => {
 this.assertComponentsReady(this.#componentControls);
 if (noUserExists(this)) {
Expand Down

63 changes: 63 additions & 0 deletions
packages/clerk-js/src/ui/Components.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useSafeLayoutEffect } from '@clerk/shared/react';
import { createDeferredPromise } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __internal_UserVerificationProps,
 Appearance,
 Clerk,
Expand All@@ -24,6 +25,7 @@ import { useClerkModalStateParams } from './hooks/useClerkModalStateParams';
import type { ClerkComponentName } from './lazyModules/components';
import {
 BlankCaptchaModal,
 Checkout,
 CreateOrganizationModal,
 ImpersonationFab,
 KeylessPrompt,
Expand All@@ -37,6 +39,7 @@ import {
} from './lazyModules/components';
import {
 LazyComponentRenderer,
 LazyDrawerRenderer,
 LazyImpersonationFabProvider,
 LazyModalRenderer,
 LazyOneTapRenderer,
Expand DownExpand Up@@ -99,6 +102,16 @@ export type ComponentControls = {
 notify?: boolean;
 },
 ) => void;
 openDrawer: <T extends 'checkout'>(
 drawer: T,
 props: T extends 'checkout' ? __experimental_CheckoutProps : never,
 ) => void;
 closeDrawer: (
 drawer: 'checkout',
 options?: {
 notify?: boolean;
 },
 ) => void;
 prefetch: (component: 'organizationSwitcher') => void;
 // Special case, as the impersonation fab mounts automatically
 mountImpersonationFab: () => void;
Expand DownExpand Up@@ -131,6 +144,10 @@ interface ComponentsState {
 blankCaptchaModal: null;
 organizationSwitcherPrefetch: boolean;
 waitlistModal: null | WaitlistProps;
 checkoutDrawer: {
 open: false;
 props: null | __experimental_CheckoutProps;
 };
 nodes: Map<HTMLDivElement, HtmlNodeOptions>;
 impersonationFab: boolean;
}
Expand DownExpand Up@@ -212,6 +229,10 @@ const Components = (props: ComponentsProps) => {
 organizationSwitcherPrefetch: false,
 waitlistModal: null,
 blankCaptchaModal: null,
 checkoutDrawer: {
 open: false,
 props: null,
 },
 nodes: new Map(),
 impersonationFab: false,
 });
Expand All@@ -226,6 +247,7 @@ const Components = (props: ComponentsProps) => {
 createOrganizationModal,
 waitlistModal,
 blankCaptchaModal,
 checkoutDrawer,
 nodes,
 } = state;

Expand DownExpand Up@@ -322,6 +344,26 @@ const Components = (props: ComponentsProps) => {
 setState(s => ({ ...s, impersonationFab: true }));
 };

 componentsControls.openDrawer = (name, props) => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 open: true,
 props,
 },
 }));
 };

 componentsControls.closeDrawer = name => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 ...s[`${name}Drawer`],
 open: false,
 },
 }));
 };

Comment on lines

+347
 to 
+365

@alexcarpenteralexcarpenterMar 28, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Introducing new drawer specific methods as we want to have an exit animation for the drawers, and removing all the props causes issues with portaling into the profile components.
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

It would be great to consolidate the modal/drawer handling at some point in the future. I would expect them to function the same, just be a different flavor of UI. Maybe there's a good reason to keep them separate though? 🤔
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

If we want modals to have an exit animation, we'd need to follow this updated drawer pattern, currently all modals are removed immediately but wiping out the props.

 componentsControls.prefetch = component => {
 setState(s => ({ ...s, [`${component}Prefetch`]: true }));
 };
Expand DownExpand Up@@ -481,6 +523,26 @@ const Components = (props: ComponentsProps) => {
 </LazyModalRenderer>
 );

 const mountedCheckoutDrawer = checkoutDrawer.props && (
 <LazyDrawerRenderer
 globalAppearance={state.appearance}
 appearanceKey={'checkout' as any}
 componentAppearance={{}}
 flowName={'checkout'}
 open={checkoutDrawer.open}
 onOpenChange={() => componentsControls.closeDrawer('checkout')}
 componentName={'Checkout'}
 portalId={checkoutDrawer.props.portalId}
 >
 <Checkout
 planId={checkoutDrawer.props.planId}
 planPeriod={checkoutDrawer.props.planPeriod}
 orgId={checkoutDrawer.props.orgId}
 onSubscriptionComplete={checkoutDrawer.props.onSubscriptionComplete}
 />
 </LazyDrawerRenderer>
 );

 return (
 <Suspense fallback={''}>
 <LazyProviders
Expand DownExpand Up@@ -511,6 +573,7 @@ const Components = (props: ComponentsProps) => {
 {createOrganizationModal && mountedCreateOrganizationModal}
 {waitlistModal && mountedWaitlistModal}
 {blankCaptchaModal && mountedBlankCaptchaModal}
 {mountedCheckoutDrawer}

 {state.impersonationFab && (
 <LazyImpersonationFabProvider globalAppearance={state.appearance}>
Expand Down

40 changes: 11 additions & 29 deletions
packages/clerk-js/src/ui/components/Checkout/Checkout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
import type { __experimental_CheckoutProps } from '@clerk/types';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { useCheckoutContext, withCoreUserGuard } from '../../contexts';
import { __experimental_CheckoutContext } from '../../contexts';
import { Flow } from '../../customizables';
import { Drawer } from '../../elements';
import { Route, Switch } from '../../router';
import { CheckoutPage } from './CheckoutPage';

export const __experimental_Checkout = (props: __experimental_CheckoutProps) => {
 return (
 <Flow.Root flow='checkout'>
 <Flow.Part>
 <Switch>
 <Route>
 <AuthenticatedRoutes {...props} />
 </Route>
 </Switch>
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 }}
 >
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </__experimental_CheckoutContext.Provider>
 </Flow.Part>
 </Flow.Root>
 );
};

const AuthenticatedRoutes = withCoreUserGuard((props: __experimental_CheckoutProps) => {
 const { mode = 'mounted', isOpen = false, setIsOpen = () => {} } = useCheckoutContext();

 return (
 <Drawer.Root
 open={isOpen}
 onOpenChange={setIsOpen}
 strategy={mode === 'mounted' ? 'fixed' : 'absolute'}
 portalProps={{
 id: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
 }}
 >
 <Drawer.Overlay />
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </Drawer.Root>
 );
});

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

import { useCheckoutContext } from '../../contexts';
import { Box, Button, descriptors, Heading, Icon, localizationKeys, Span, Text } from '../../customizables';
import { Drawer, LineItems } from '../../elements';
import { Drawer, LineItems, useDrawerContext } from '../../elements';
import { Check } from '../../icons';

const capitalize = (name: string) => name[0].toUpperCase() + name.slice(1);

export const CheckoutComplete = ({ checkout }: { checkout: __experimental_CommerceCheckoutResource }) => {
 const { setIsOpen } = useCheckoutContext();
 const { setIsOpen } = useDrawerContext();

 const handleClose = () => {
 if (setIsOpen) {
Expand Down

34 changes: 8 additions & 26 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,9 @@ import type {
import { useState } from 'react';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { __experimental_CheckoutContext, usePricingTableContext } from '../../contexts';
import { usePricingTableContext } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { usePlans } from '../../hooks';
import { __experimental_Checkout } from '../Checkout';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
import { SubscriptionDetailDrawer } from './SubscriptionDetailDrawer';
Expand All@@ -25,10 +24,8 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 const { plans, subscriptions, revalidate } = usePlans({ subscriberType });

 const [planPeriod, setPlanPeriod] = useState<__experimental_CommerceSubscriptionPlanPeriod>('month');
 const [checkoutPlan, setCheckoutPlan] = useState<__experimental_CommercePlanResource>();
 const [detailSubscription, setDetailSubscription] = useState<__experimental_CommerceSubscriptionResource>();

 const [showCheckout, setShowCheckout] = useState(false);
 const [showSubscriptionDetailDrawer, setShowSubscriptionDetailDrawer] = useState(false);

 const selectPlan = (plan: __experimental_CommercePlanResource) => {
Expand All@@ -40,8 +37,13 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 setDetailSubscription(activeSubscription);
 setShowSubscriptionDetailDrawer(true);
 } else {
 setCheckoutPlan(plan);
 setShowCheckout(true);
 clerk.__internal_openCheckout({
 planId: plan.id,
 planPeriod,
 orgId: subscriberType === 'org' ? organization?.id : undefined,
 onSubscriptionComplete: onSubscriptionChange,
 portalId: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

does mode indicate the context PricingTable is rendered in? I feel like I would expect mode to dictate how PricingTable behaves itself, but not necessarily how it behaves depending on where it's rendered.
As a semi-related nit, I might rename mode to context.
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Mode is set on the PricingTable and I think was originally adding following the other components, but there is no modal mode for PricingTable, so yeah, it is confusing, as its only a mounted component. Will refactor naming approach in a follow up PR.

Comment on lines

+40
 to 
+45

@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This is much cleaner!
 });
 }
 };

Expand DownExpand Up@@ -74,26 +76,6 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 appearanceKey='checkout'
 appearance={props.checkoutProps?.appearance}
 >
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 mode,
 isOpen: showCheckout,
 setIsOpen: setShowCheckout,
 }}
 >
 {/*TODO: Used by InvisibleRootBox, can we simplify? */}
 <div>
 {checkoutPlan && (
 <__experimental_Checkout
 planPeriod={planPeriod}
 planId={checkoutPlan.id}
 orgId={subscriberType === 'org' ? organization?.id : undefined}
 onSubscriptionComplete={onSubscriptionChange}
 />
 )}
 </div>
 </__experimental_CheckoutContext.Provider>
 <SubscriptionDetailDrawer
 isOpen={showSubscriptionDetailDrawer}
 setIsOpen={setShowSubscriptionDetailDrawer}
Expand Down
Loading

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

Skip to content
feat(clerk-js,types,clerk-react): Add internal open/close checkout methods#5481

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

alexcarpenter
merged 14 commits into

from

Apr 3, 2025
 Merged


feat(clerk-js,types,clerk-react): Add internal open/close checkout methods
#5481
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
dfe84ea

init


alexcarpenter Mar 28, 2025
44d8879

WIP


alexcarpenter Mar 28, 2025
c22a321

wip


alexcarpenter Mar 28, 2025
8acac44

wip


alexcarpenter Mar 28, 2025
bb4212b

wip


alexcarpenter Mar 28, 2025
41fd1a0

wip


alexcarpenter Mar 28, 2025
e9e59d7

fix


alexcarpenter Mar 28, 2025
5c28068

fix


alexcarpenter Mar 28, 2025
0151de0

add changeset


alexcarpenter Mar 28, 2025
2b31f6e

handle close


alexcarpenter Mar 28, 2025
1e2e028

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
f779ac7

pass props


alexcarpenter Mar 28, 2025
1608130

Update bundlewatch.config.json


alexcarpenter Mar 28, 2025
d29bf85

Merge branch 'main' into alexcarpenter/com-257-add-clerkopencheckout-…


alexcarpenter Apr 3, 2025

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


7 changes: 7 additions & 0 deletions
.changeset/fancy-lies-sell.md

View file


Open in desktop

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

Introduce `clerk.__internal_openCheckout()` and `clerk.__internal_closeCheckout()` methods and remove `<Checkout />` from within the `<PricingTable />` component.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "55KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "96KB" },
 { "path": "./dist/vendors*.js", "maxSize": "30KB" },
 { "path": "./dist/vendors*.js", "maxSize": "35KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
import { addClerkPrefix, isAbsoluteUrl, stripScheme } from '@clerk/shared/url';
import { allSettled, handleValueOrFn, noop } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __experimental_CommerceNamespace,
 __experimental_PricingTableProps,
 __internal_ComponentNavigationContext,
Expand DownExpand Up@@ -520,6 +521,18 @@ export class Clerk implements ClerkInterface {
 void this.#componentControls.ensureMounted().then(controls => controls.closeModal('signIn'));
 };

 public __internal_openCheckout = (props?: __experimental_CheckoutProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'Checkout' })
 .then(controls => controls.openDrawer('checkout', props || {}));
 };

 public __internal_closeCheckout = (): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted().then(controls => controls.closeDrawer('checkout'));
 };

 public __internal_openReverification = (props?: __internal_UserVerificationModalProps): void => {
 this.assertComponentsReady(this.#componentControls);
 if (noUserExists(this)) {
Expand Down

63 changes: 63 additions & 0 deletions
packages/clerk-js/src/ui/Components.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useSafeLayoutEffect } from '@clerk/shared/react';
import { createDeferredPromise } from '@clerk/shared/utils';
import type {
 __experimental_CheckoutProps,
 __internal_UserVerificationProps,
 Appearance,
 Clerk,
Expand All@@ -24,6 +25,7 @@ import { useClerkModalStateParams } from './hooks/useClerkModalStateParams';
import type { ClerkComponentName } from './lazyModules/components';
import {
 BlankCaptchaModal,
 Checkout,
 CreateOrganizationModal,
 ImpersonationFab,
 KeylessPrompt,
Expand All@@ -37,6 +39,7 @@ import {
} from './lazyModules/components';
import {
 LazyComponentRenderer,
 LazyDrawerRenderer,
 LazyImpersonationFabProvider,
 LazyModalRenderer,
 LazyOneTapRenderer,
Expand DownExpand Up@@ -99,6 +102,16 @@ export type ComponentControls = {
 notify?: boolean;
 },
 ) => void;
 openDrawer: <T extends 'checkout'>(
 drawer: T,
 props: T extends 'checkout' ? __experimental_CheckoutProps : never,
 ) => void;
 closeDrawer: (
 drawer: 'checkout',
 options?: {
 notify?: boolean;
 },
 ) => void;
 prefetch: (component: 'organizationSwitcher') => void;
 // Special case, as the impersonation fab mounts automatically
 mountImpersonationFab: () => void;
Expand DownExpand Up@@ -131,6 +144,10 @@ interface ComponentsState {
 blankCaptchaModal: null;
 organizationSwitcherPrefetch: boolean;
 waitlistModal: null | WaitlistProps;
 checkoutDrawer: {
 open: false;
 props: null | __experimental_CheckoutProps;
 };
 nodes: Map<HTMLDivElement, HtmlNodeOptions>;
 impersonationFab: boolean;
}
Expand DownExpand Up@@ -212,6 +229,10 @@ const Components = (props: ComponentsProps) => {
 organizationSwitcherPrefetch: false,
 waitlistModal: null,
 blankCaptchaModal: null,
 checkoutDrawer: {
 open: false,
 props: null,
 },
 nodes: new Map(),
 impersonationFab: false,
 });
Expand All@@ -226,6 +247,7 @@ const Components = (props: ComponentsProps) => {
 createOrganizationModal,
 waitlistModal,
 blankCaptchaModal,
 checkoutDrawer,
 nodes,
 } = state;

Expand DownExpand Up@@ -322,6 +344,26 @@ const Components = (props: ComponentsProps) => {
 setState(s => ({ ...s, impersonationFab: true }));
 };

 componentsControls.openDrawer = (name, props) => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 open: true,
 props,
 },
 }));
 };

 componentsControls.closeDrawer = name => {
 setState(s => ({
 ...s,
 [`${name}Drawer`]: {
 ...s[`${name}Drawer`],
 open: false,
 },
 }));
 };

Comment on lines

+347
 to 
+365

@alexcarpenteralexcarpenterMar 28, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Introducing new drawer specific methods as we want to have an exit animation for the drawers, and removing all the props causes issues with portaling into the profile components.
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

It would be great to consolidate the modal/drawer handling at some point in the future. I would expect them to function the same, just be a different flavor of UI. Maybe there's a good reason to keep them separate though? 🤔
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

If we want modals to have an exit animation, we'd need to follow this updated drawer pattern, currently all modals are removed immediately but wiping out the props.

 componentsControls.prefetch = component => {
 setState(s => ({ ...s, [`${component}Prefetch`]: true }));
 };
Expand DownExpand Up@@ -481,6 +523,26 @@ const Components = (props: ComponentsProps) => {
 </LazyModalRenderer>
 );

 const mountedCheckoutDrawer = checkoutDrawer.props && (
 <LazyDrawerRenderer
 globalAppearance={state.appearance}
 appearanceKey={'checkout' as any}
 componentAppearance={{}}
 flowName={'checkout'}
 open={checkoutDrawer.open}
 onOpenChange={() => componentsControls.closeDrawer('checkout')}
 componentName={'Checkout'}
 portalId={checkoutDrawer.props.portalId}
 >
 <Checkout
 planId={checkoutDrawer.props.planId}
 planPeriod={checkoutDrawer.props.planPeriod}
 orgId={checkoutDrawer.props.orgId}
 onSubscriptionComplete={checkoutDrawer.props.onSubscriptionComplete}
 />
 </LazyDrawerRenderer>
 );

 return (
 <Suspense fallback={''}>
 <LazyProviders
Expand DownExpand Up@@ -511,6 +573,7 @@ const Components = (props: ComponentsProps) => {
 {createOrganizationModal && mountedCreateOrganizationModal}
 {waitlistModal && mountedWaitlistModal}
 {blankCaptchaModal && mountedBlankCaptchaModal}
 {mountedCheckoutDrawer}

 {state.impersonationFab && (
 <LazyImpersonationFabProvider globalAppearance={state.appearance}>
Expand Down

40 changes: 11 additions & 29 deletions
packages/clerk-js/src/ui/components/Checkout/Checkout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
import type { __experimental_CheckoutProps } from '@clerk/types';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { useCheckoutContext, withCoreUserGuard } from '../../contexts';
import { __experimental_CheckoutContext } from '../../contexts';
import { Flow } from '../../customizables';
import { Drawer } from '../../elements';
import { Route, Switch } from '../../router';
import { CheckoutPage } from './CheckoutPage';

export const __experimental_Checkout = (props: __experimental_CheckoutProps) => {
 return (
 <Flow.Root flow='checkout'>
 <Flow.Part>
 <Switch>
 <Route>
 <AuthenticatedRoutes {...props} />
 </Route>
 </Switch>
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 }}
 >
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </__experimental_CheckoutContext.Provider>
 </Flow.Part>
 </Flow.Root>
 );
};

const AuthenticatedRoutes = withCoreUserGuard((props: __experimental_CheckoutProps) => {
 const { mode = 'mounted', isOpen = false, setIsOpen = () => {} } = useCheckoutContext();

 return (
 <Drawer.Root
 open={isOpen}
 onOpenChange={setIsOpen}
 strategy={mode === 'mounted' ? 'fixed' : 'absolute'}
 portalProps={{
 id: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
 }}
 >
 <Drawer.Overlay />
 <Drawer.Content>
 <Drawer.Header title='Checkout' />
 <CheckoutPage {...props} />
 </Drawer.Content>
 </Drawer.Root>
 );
});

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

import { useCheckoutContext } from '../../contexts';
import { Box, Button, descriptors, Heading, Icon, localizationKeys, Span, Text } from '../../customizables';
import { Drawer, LineItems } from '../../elements';
import { Drawer, LineItems, useDrawerContext } from '../../elements';
import { Check } from '../../icons';

const capitalize = (name: string) => name[0].toUpperCase() + name.slice(1);

export const CheckoutComplete = ({ checkout }: { checkout: __experimental_CommerceCheckoutResource }) => {
 const { setIsOpen } = useCheckoutContext();
 const { setIsOpen } = useDrawerContext();

 const handleClose = () => {
 if (setIsOpen) {
Expand Down

34 changes: 8 additions & 26 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,9 @@ import type {
import { useState } from 'react';

import { PROFILE_CARD_SCROLLBOX_ID } from '../../constants';
import { __experimental_CheckoutContext, usePricingTableContext } from '../../contexts';
import { usePricingTableContext } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { usePlans } from '../../hooks';
import { __experimental_Checkout } from '../Checkout';
import { PricingTableDefault } from './PricingTableDefault';
import { PricingTableMatrix } from './PricingTableMatrix';
import { SubscriptionDetailDrawer } from './SubscriptionDetailDrawer';
Expand All@@ -25,10 +24,8 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 const { plans, subscriptions, revalidate } = usePlans({ subscriberType });

 const [planPeriod, setPlanPeriod] = useState<__experimental_CommerceSubscriptionPlanPeriod>('month');
 const [checkoutPlan, setCheckoutPlan] = useState<__experimental_CommercePlanResource>();
 const [detailSubscription, setDetailSubscription] = useState<__experimental_CommerceSubscriptionResource>();

 const [showCheckout, setShowCheckout] = useState(false);
 const [showSubscriptionDetailDrawer, setShowSubscriptionDetailDrawer] = useState(false);

 const selectPlan = (plan: __experimental_CommercePlanResource) => {
Expand All@@ -40,8 +37,13 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 setDetailSubscription(activeSubscription);
 setShowSubscriptionDetailDrawer(true);
 } else {
 setCheckoutPlan(plan);
 setShowCheckout(true);
 clerk.__internal_openCheckout({
 planId: plan.id,
 planPeriod,
 orgId: subscriberType === 'org' ? organization?.id : undefined,
 onSubscriptionComplete: onSubscriptionChange,
 portalId: mode === 'modal' ? PROFILE_CARD_SCROLLBOX_ID : undefined,
@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

does mode indicate the context PricingTable is rendered in? I feel like I would expect mode to dictate how PricingTable behaves itself, but not necessarily how it behaves depending on where it's rendered.
As a semi-related nit, I might rename mode to context.
@alexcarpenteralexcarpenterApr 3, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Mode is set on the PricingTable and I think was originally adding following the other components, but there is no modal mode for PricingTable, so yeah, it is confusing, as its only a mounted component. Will refactor naming approach in a follow up PR.

Comment on lines

+40
 to 
+45

@brkalowbrkalowApr 3, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This is much cleaner!
 });
 }
 };

Expand DownExpand Up@@ -74,26 +76,6 @@ export const __experimental_PricingTable = (props: __experimental_PricingTablePr
 appearanceKey='checkout'
 appearance={props.checkoutProps?.appearance}
 >
 <__experimental_CheckoutContext.Provider
 value={{
 componentName: 'Checkout',
 mode,
 isOpen: showCheckout,
 setIsOpen: setShowCheckout,
 }}
 >
 {/*TODO: Used by InvisibleRootBox, can we simplify? */}
 <div>
 {checkoutPlan && (
 <__experimental_Checkout
 planPeriod={planPeriod}
 planId={checkoutPlan.id}
 orgId={subscriberType === 'org' ? organization?.id : undefined}
 onSubscriptionComplete={onSubscriptionChange}
 />
 )}
 </div>
 </__experimental_CheckoutContext.Provider>
 <SubscriptionDetailDrawer
 isOpen={showSubscriptionDetailDrawer}
 setIsOpen={setShowSubscriptionDetailDrawer}
Expand Down
Loading