chore(clerk-js): Tidy up layout and logic of PlanDetails drawer#5928

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
aeliox merged 8 commits into from
May 30, 2025
Merged

chore(clerk-js): Tidy up layout and logic of PlanDetails drawer #5928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9193f74
tidy up layout and logic of PlanDetails drawer
aeliox May 14, 2025
4aaa1a4
changeset
aeliox May 14, 2025
c5f8ddb
drop log
aeliox May 14, 2025
1be77eb
Merge branch 'main' into keiran/com-795-plan-details
aeliox May 28, 2025
af7f39d
add some descriptors
aeliox May 29, 2025
9f9f0bd
bundle size
aeliox May 29, 2025
a5f71a8
fix unmounting of PlanDetails drawer, rename PlanDetails prop
aeliox May 29, 2025
c412857
Merge branch 'main' into keiran/com-795-plan-details
aeliox May 29, 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
5 changes: 5 additions & 0 deletions .changeset/metal-tips-joke.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Clean up layout and logic of the `PlanDetails` drawer
171 changes: 99 additions & 72 deletions packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import type {
CommerceSubscriptionResource,
} from '@clerk/types';
import * as React from 'react';
import { useState } from 'react';
import { useMemo, useState } from 'react';

import { useProtect } from '../../common';
import { SubscriberTypeContext, usePlansContext, useSubscriberTypeContext, useSubscriptions } from '../../contexts';
Expand All@@ -19,7 +19,9 @@ import { handleError } from '../../utils';
export const PlanDetails = (props: __internal_PlanDetailsProps) => {
return (
<SubscriberTypeContext.Provider value={props.subscriberType || 'user'}>
<PlanDetailsInternal {...props} />
<Drawer.Content>
<PlanDetailsInternal {...props} />
</Drawer.Content>
Comment on lines +22 to +24

@panteliselefpanteliselefMay 29, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

😉

</SubscriberTypeContext.Provider>
);
};
Expand All@@ -28,18 +30,22 @@ const PlanDetailsInternal = ({
plan,
onSubscriptionCancel,
portalRoot,
planPeriod: _planPeriod = 'month',
initialPlanPeriod = 'month',
}: __internal_PlanDetailsProps) => {
const clerk = useClerk();
const { organization } = useOrganization();
const [showConfirmation, setShowConfirmation] = useState(false);
const [isSubmitting, setIsSubmitting] = useState(false);
const [cancelError, setCancelError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();
const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(_planPeriod);
const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(initialPlanPeriod);

const { setIsOpen } = useDrawerContext();
const { activeOrUpcomingSubscription, revalidateAll, buttonPropsForPlan, isDefaultPlanImplicitlyActiveOrUpcoming } =
usePlansContext();
const {
activeOrUpcomingSubscriptionBasedOnPlanPeriod,
revalidateAll,
buttonPropsForPlan,
isDefaultPlanImplicitlyActiveOrUpcoming,
} = usePlansContext();
const subscriberType = useSubscriberTypeContext();
const canManageBilling = useProtect(
has => has({ permission: 'org:sys_billing:manage' }) || subscriberType === 'user',
Expand All@@ -49,7 +55,7 @@ const PlanDetailsInternal = ({
return null;
}

const subscription = activeOrUpcomingSubscription(plan);
const subscription = activeOrUpcomingSubscriptionBasedOnPlanPeriod(plan, planPeriod);

const handleClose = () => {
if (setIsOpen) {
Expand DownExpand Up@@ -105,7 +111,7 @@ const PlanDetailsInternal = ({
};

return (
<Drawer.Content>
<>
<Drawer.Header
sx={t =>
!hasFeatures
Expand DownExpand Up@@ -209,7 +215,10 @@ const PlanDetailsInternal = ({
/>
) : (
<Col gap={4}>
{!!subscription && subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0 ? (
{!!subscription &&
subscription.planPeriod === 'month' &&
plan.annualMonthlyAmount > 0 &&
planPeriod === 'annual' ? (
<Button
block
variant='bordered'
Expand All@@ -220,7 +229,7 @@ const PlanDetailsInternal = ({
localizationKey={localizationKeys('commerce.switchToAnnual')}
/>
) : null}
{!!subscription && subscription.planPeriod === 'annual' ? (
{!!subscription && subscription.planPeriod === 'annual' && planPeriod === 'month' ? (
<Button
block
variant='bordered'
Expand DownExpand Up@@ -314,7 +323,7 @@ const PlanDetailsInternal = ({
)}
</Drawer.Confirmation>
) : null}
</Drawer.Content>
</>
);
};

Expand All@@ -338,7 +347,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {

const isImplicitlyActiveOrUpcoming = isDefaultPlanImplicitlyActiveOrUpcoming && plan.isDefault;

const showBadge = !!subscription || isImplicitlyActiveOrUpcoming;
const showBadge = !!subscription;

const getPlanFee = useMemo(() => {
if (plan.annualMonthlyAmount <= 0) {
return plan.amountFormatted;
}
return planPeriod === 'annual' ? plan.annualMonthlyAmountFormatted : plan.amountFormatted;
}, [plan, planPeriod]);

return (
<Box
Expand All@@ -362,27 +378,58 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
</Box>
) : null}

{plan.avatarUrl ? (
<Avatar
boxElementDescriptor={descriptors.planDetailAvatar}
size={_ => 40}
title={plan.name}
initials={plan.name[0]}
rounded={false}
imageUrl={plan.avatarUrl}
sx={t => ({
marginBlockEnd: t.space.$3,
})}
/>
) : null}
<Box
sx={t => ({
paddingInlineEnd: t.space.$10,
})}
<Col
gap={3}
elementDescriptor={descriptors.planDetailBadgeAvatarTitleDescriptionContainer}
>
<Flex
gap={2}
align='center'
{showBadge ? (
<Flex
align='center'
gap={3}
elementDescriptor={descriptors.planDetailBadgeContainer}
sx={t => ({
paddingInlineEnd: t.space.$10,
})}
>
{subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
<Badge
elementDescriptor={descriptors.planDetailBadge}
localizationKey={localizationKeys('badge__activePlan')}
colorScheme={'secondary'}
/>
) : (
<Badge
elementDescriptor={descriptors.planDetailBadge}
localizationKey={localizationKeys('badge__upcomingPlan')}
colorScheme={'primary'}
/>
)}
{!!subscription && (
<Text
elementDescriptor={descriptors.planDetailCaption}
variant={'caption'}
localizationKey={captionForSubscription(subscription)}
colorScheme='secondary'
/>
)}
</Flex>
) : null}
{plan.avatarUrl ? (
<Avatar
boxElementDescriptor={descriptors.planDetailAvatar}
size={_ => 40}
title={plan.name}
initials={plan.name[0]}
rounded={false}
imageUrl={plan.avatarUrl}
sx={t => ({
marginBlockEnd: t.space.$3,
})}
/>
) : null}
<Col
gap={1}
elementDescriptor={descriptors.planDetailTitleDescriptionContainer}
>
<Heading
elementDescriptor={descriptors.planDetailTitle}
Expand All@@ -391,37 +438,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
>
{plan.name}
</Heading>
{showBadge ? (
<Flex elementDescriptor={descriptors.planDetailBadgeContainer}>
{subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
<Badge
elementDescriptor={descriptors.planDetailBadge}
localizationKey={localizationKeys('badge__activePlan')}
colorScheme={'secondary'}
/>
) : (
<Badge
elementDescriptor={descriptors.planDetailBadge}
localizationKey={localizationKeys('badge__upcomingPlan')}
colorScheme={'primary'}
/>
)}
</Flex>
{plan.description ? (
<Text
elementDescriptor={descriptors.planDetailDescription}
variant='subtitle'
colorScheme='secondary'
>
{plan.description}
</Text>
) : null}
</Flex>
{plan.description ? (
<Text
elementDescriptor={descriptors.planDetailDescription}
variant='subtitle'
colorScheme='secondary'
sx={t => ({
marginTop: t.space.$1,
})}
>
{plan.description}
</Text>
) : null}
</Box>
</Col>
</Col>

<Flex
elementDescriptor={descriptors.planDetailFeeContainer}
Expand All@@ -439,9 +466,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
colorScheme='body'
>
{plan.currencySymbol}
{(subscription && subscription.planPeriod === 'annual') || planPeriod === 'annual'
? plan.annualMonthlyAmountFormatted
: plan.amountFormatted}
{getPlanFee}
</Text>
<Text
elementDescriptor={descriptors.planDetailFeePeriod}
Expand All@@ -459,7 +484,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
</>
</Flex>

{!subscription || (subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0) ? (
{plan.annualMonthlyAmount > 0 ? (
<Box
elementDescriptor={descriptors.planDetailPeriodToggle}
sx={t => ({
Expand All@@ -473,15 +498,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
label={localizationKeys('commerce.billedAnnually')}
/>
</Box>
) : null}

{!!subscription && (
) : (
<Text
elementDescriptor={descriptors.planDetailCaption}
variant={'caption'}
localizationKey={captionForSubscription(subscription)}
elementDescriptor={descriptors.pricingTableCardFeePeriodNotice}
variant='caption'
colorScheme='secondary'
localizationKey={
plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
}
sx={t => ({
justifySelf: 'flex-start',
alignSelf: 'center',
marginTop: t.space.$3,
})}
/>
Expand Down
7 changes: 4 additions & 3 deletions packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,7 @@ function Card(props: CardProps) {
clerk.__internal_openPlanDetails({
plan,
subscriberType,
planPeriod,
initialPlanPeriod: planPeriod,
portalRoot,
});
};
Expand DownExpand Up@@ -414,10 +414,11 @@ const CardHeader = React.forwardRef<HTMLDivElement, CardHeaderProps>((props, ref
localizationKey={
plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
}
sx={{
sx={t => ({
justifySelf: 'flex-start',
alignSelf: 'center',
}}
marginTop: t.space.$1,
})}
/>
)}
</Box>
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/ui/contexts/components/Plans.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -339,13 +339,14 @@ export const usePlansContext = () => {
appearance,
newSubscriptionRedirectUrl,
}: HandleSelectPlanProps) => {
const subscription = activeOrUpcomingSubscription(plan);
const subscription = activeOrUpcomingSubscriptionWithPlanPeriod(plan, planPeriod);

const portalRoot = getClosestProfileScrollBox(mode, event);

if (subscription && subscription.planPeriod === planPeriod && !subscription.canceledAt) {
clerk.__internal_openPlanDetails({
plan,
initialPlanPeriod: planPeriod,
subscriberType,
onSubscriptionCancel: () => {
revalidateAll();
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/ui/customizables/elementDescriptors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -288,11 +288,12 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'pricingTableMatrixFooter',

'planDetailHeader',
'planDetailAvatarBadgeContainer',
'planDetailAvatar',
'planDetailBadgeAvatarTitleDescriptionContainer',
'planDetailBadgeContainer',
'planDetailBadge',
'planDetailTitle',
'planDetailTitleDescriptionContainer',
'planDetailDescription',
'planDetailAction',
'planDetailFeeContainer',
Expand Down
3 changes: 2 additions & 1 deletion packages/types/src/appearance.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -421,11 +421,12 @@ export type ElementsConfig = {
pricingTableMatrixFooter: WithOptions;

planDetailHeader: WithOptions;
planDetailAvatarBadgeContainer: WithOptions;
planDetailAvatar: WithOptions;
planDetailBadgeAvatarTitleDescriptionContainer: WithOptions;
planDetailBadgeContainer: WithOptions;
planDetailBadge: WithOptions;
planDetailTitle: WithOptions;
planDetailTitleDescriptionContainer: WithOptions;
planDetailDescription: WithOptions;
planDetailAction: WithOptions;
planDetailFeeContainer: WithOptions;
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1641,7 +1641,7 @@ export type __internal_PlanDetailsProps = {
appearance?: PlanDetailTheme;
plan?: CommercePlanResource;
subscriberType?: CommerceSubscriberType;
planPeriod?: CommerceSubscriptionPlanPeriod;
initialPlanPeriod?: CommerceSubscriptionPlanPeriod;
onSubscriptionCancel?: () => void;
portalId?: string;
portalRoot?: PortalRoot;
Expand Down
, '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
chore(clerk-js): Tidy up layout and logic of PlanDetails drawer#5928

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

aeliox
merged 8 commits into

from

May 30, 2025
 Merged


chore(clerk-js): Tidy up layout and logic of PlanDetails drawer
#5928
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
9193f74

tidy up layout and logic of PlanDetails drawer


aeliox May 14, 2025
4aaa1a4

changeset


aeliox May 14, 2025
c5f8ddb

drop log


aeliox May 14, 2025
1be77eb

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 28, 2025
af7f39d

add some descriptors


aeliox May 29, 2025
9f9f0bd

bundle size


aeliox May 29, 2025
a5f71a8

fix unmounting of PlanDetails drawer, rename PlanDetails prop


aeliox May 29, 2025
c412857

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 29, 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


5 changes: 5 additions & 0 deletions
.changeset/metal-tips-joke.md

View file


Open in desktop

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

Clean up layout and logic of the `PlanDetails` drawer

171 changes: 99 additions & 72 deletions
packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import type {
 CommerceSubscriptionResource,
} from '@clerk/types';
import * as React from 'react';
import { useState } from 'react';
import { useMemo, useState } from 'react';

import { useProtect } from '../../common';
import { SubscriberTypeContext, usePlansContext, useSubscriberTypeContext, useSubscriptions } from '../../contexts';
Expand All@@ -19,7 +19,9 @@ import { handleError } from '../../utils';
export const PlanDetails = (props: __internal_PlanDetailsProps) => {
 return (
 <SubscriberTypeContext.Provider value={props.subscriberType || 'user'}>
 <PlanDetailsInternal {...props} />
 <Drawer.Content>
 <PlanDetailsInternal {...props} />
 </Drawer.Content>

Comment on lines

+22
 to 
+24

@panteliselefpanteliselefMay 29, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

😉
 </SubscriberTypeContext.Provider>
 );
};
Expand All@@ -28,18 +30,22 @@ const PlanDetailsInternal = ({
 plan,
 onSubscriptionCancel,
 portalRoot,
planPeriod: _planPeriod = 'month',
initialPlanPeriod = 'month',
}: __internal_PlanDetailsProps) => {
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [showConfirmation, setShowConfirmation] = useState(false);
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [cancelError, setCancelError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(_planPeriod);
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(initialPlanPeriod);

 const { setIsOpen } = useDrawerContext();
 const { activeOrUpcomingSubscription, revalidateAll, buttonPropsForPlan, isDefaultPlanImplicitlyActiveOrUpcoming } =
 usePlansContext();
 const {
 activeOrUpcomingSubscriptionBasedOnPlanPeriod,
 revalidateAll,
 buttonPropsForPlan,
 isDefaultPlanImplicitlyActiveOrUpcoming,
 } = usePlansContext();
 const subscriberType = useSubscriberTypeContext();
 const canManageBilling = useProtect(
 has => has({ permission: 'org:sys_billing:manage' }) || subscriberType === 'user',
Expand All@@ -49,7 +55,7 @@ const PlanDetailsInternal = ({
 return null;
 }

 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionBasedOnPlanPeriod(plan, planPeriod);

 const handleClose = () => {
 if (setIsOpen) {
Expand DownExpand Up@@ -105,7 +111,7 @@ const PlanDetailsInternal = ({
 };

 return (
 <Drawer.Content>
 <>
 <Drawer.Header
 sx={t =>
 !hasFeatures
Expand DownExpand Up@@ -209,7 +215,10 @@ const PlanDetailsInternal = ({
 />
 ) : (
 <Col gap={4}>
 {!!subscription && subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0 ? (
 {!!subscription &&
 subscription.planPeriod === 'month' &&
 plan.annualMonthlyAmount > 0 &&
 planPeriod === 'annual' ? (
 <Button
 block
 variant='bordered'
Expand All@@ -220,7 +229,7 @@ const PlanDetailsInternal = ({
 localizationKey={localizationKeys('commerce.switchToAnnual')}
 />
 ) : null}
 {!!subscription && subscription.planPeriod === 'annual' ? (
 {!!subscription && subscription.planPeriod === 'annual' && planPeriod === 'month' ? (
 <Button
 block
 variant='bordered'
Expand DownExpand Up@@ -314,7 +323,7 @@ const PlanDetailsInternal = ({
 )}
 </Drawer.Confirmation>
 ) : null}
 </Drawer.Content>
 </>
 );
};

Expand All@@ -338,7 +347,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {

 const isImplicitlyActiveOrUpcoming = isDefaultPlanImplicitlyActiveOrUpcoming && plan.isDefault;

 const showBadge = !!subscription || isImplicitlyActiveOrUpcoming;
 const showBadge = !!subscription;

 const getPlanFee = useMemo(() => {
 if (plan.annualMonthlyAmount <= 0) {
 return plan.amountFormatted;
 }
 return planPeriod === 'annual' ? plan.annualMonthlyAmountFormatted : plan.amountFormatted;
 }, [plan, planPeriod]);

 return (
 <Box
Expand All@@ -362,27 +378,58 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </Box>
 ) : null}

 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Box
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 <Col
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeAvatarTitleDescriptionContainer}
 >
 <Flex
 gap={2}
 align='center'
 {showBadge ? (
 <Flex
 align='center'
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeContainer}
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 >
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 {!!subscription && (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 colorScheme='secondary'
 />
 )}
 </Flex>
 ) : null}
 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Col
 gap={1}
 elementDescriptor={descriptors.planDetailTitleDescriptionContainer}
 >
 <Heading
 elementDescriptor={descriptors.planDetailTitle}
Expand All@@ -391,37 +438,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 >
 {plan.name}
 </Heading>
 {showBadge ? (
 <Flex elementDescriptor={descriptors.planDetailBadgeContainer}>
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 >
 {plan.description}
 </Text>
 ) : null}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 sx={t => ({
 marginTop: t.space.$1,
 })}
 >
 {plan.description}
 </Text>
 ) : null}
 </Box>
 </Col>
 </Col>

 <Flex
 elementDescriptor={descriptors.planDetailFeeContainer}
Expand All@@ -439,9 +466,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 colorScheme='body'
 >
 {plan.currencySymbol}
 {(subscription && subscription.planPeriod === 'annual') || planPeriod === 'annual'
 ? plan.annualMonthlyAmountFormatted
 : plan.amountFormatted}
 {getPlanFee}
 </Text>
 <Text
 elementDescriptor={descriptors.planDetailFeePeriod}
Expand All@@ -459,7 +484,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </>
 </Flex>

 {!subscription || (subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0) ? (
 {plan.annualMonthlyAmount > 0 ? (
 <Box
 elementDescriptor={descriptors.planDetailPeriodToggle}
 sx={t => ({
Expand All@@ -473,15 +498,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 label={localizationKeys('commerce.billedAnnually')}
 />
 </Box>
 ) : null}

 {!!subscription && (
 ) : (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 elementDescriptor={descriptors.pricingTableCardFeePeriodNotice}
 variant='caption'
 colorScheme='secondary'
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 marginTop: t.space.$3,
 })}
 />
Expand Down

7 changes: 4 additions & 3 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,7 @@ function Card(props: CardProps) {
 clerk.__internal_openPlanDetails({
 plan,
 subscriberType,
 planPeriod,
initialPlanPeriod: planPeriod,
 portalRoot,
 });
 };
Expand DownExpand Up@@ -414,10 +414,11 @@ const CardHeader = React.forwardRef<HTMLDivElement, CardHeaderProps>((props, ref
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={{
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 }}
 marginTop: t.space.$1,
 })}
 />
 )}
 </Box>
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -339,13 +339,14 @@ export const usePlansContext = () => {
 appearance,
 newSubscriptionRedirectUrl,
 }: HandleSelectPlanProps) => {
 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionWithPlanPeriod(plan, planPeriod);

 const portalRoot = getClosestProfileScrollBox(mode, event);

 if (subscription && subscription.planPeriod === planPeriod && !subscription.canceledAt) {
 clerk.__internal_openPlanDetails({
 plan,
 initialPlanPeriod: planPeriod,
 subscriberType,
 onSubscriptionCancel: () => {
 revalidateAll();
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,11 +288,12 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'pricingTableMatrixFooter',

 'planDetailHeader',
 'planDetailAvatarBadgeContainer',
 'planDetailAvatar',
 'planDetailBadgeAvatarTitleDescriptionContainer',
 'planDetailBadgeContainer',
 'planDetailBadge',
 'planDetailTitle',
 'planDetailTitleDescriptionContainer',
 'planDetailDescription',
 'planDetailAction',
 'planDetailFeeContainer',
Expand Down

3 changes: 2 additions & 1 deletion
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -421,11 +421,12 @@ export type ElementsConfig = {
 pricingTableMatrixFooter: WithOptions;

 planDetailHeader: WithOptions;
 planDetailAvatarBadgeContainer: WithOptions;
 planDetailAvatar: WithOptions;
 planDetailBadgeAvatarTitleDescriptionContainer: WithOptions;
 planDetailBadgeContainer: WithOptions;
 planDetailBadge: WithOptions;
 planDetailTitle: WithOptions;
 planDetailTitleDescriptionContainer: WithOptions;
 planDetailDescription: WithOptions;
 planDetailAction: WithOptions;
 planDetailFeeContainer: WithOptions;
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1641,7 +1641,7 @@ export type __internal_PlanDetailsProps = {
 appearance?: PlanDetailTheme;
 plan?: CommercePlanResource;
 subscriberType?: CommerceSubscriberType;
planPeriod?: CommerceSubscriptionPlanPeriod;
initialPlanPeriod?: CommerceSubscriptionPlanPeriod;
 onSubscriptionCancel?: () => void;
 portalId?: string;
 portalRoot?: PortalRoot;
Expand Down

, '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
chore(clerk-js): Tidy up layout and logic of PlanDetails drawer#5928

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

aeliox
merged 8 commits into

from

May 30, 2025
 Merged


chore(clerk-js): Tidy up layout and logic of PlanDetails drawer
#5928
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
9193f74

tidy up layout and logic of PlanDetails drawer


aeliox May 14, 2025
4aaa1a4

changeset


aeliox May 14, 2025
c5f8ddb

drop log


aeliox May 14, 2025
1be77eb

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 28, 2025
af7f39d

add some descriptors


aeliox May 29, 2025
9f9f0bd

bundle size


aeliox May 29, 2025
a5f71a8

fix unmounting of PlanDetails drawer, rename PlanDetails prop


aeliox May 29, 2025
c412857

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 29, 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


5 changes: 5 additions & 0 deletions
.changeset/metal-tips-joke.md

View file


Open in desktop

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

Clean up layout and logic of the `PlanDetails` drawer

171 changes: 99 additions & 72 deletions
packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import type {
 CommerceSubscriptionResource,
} from '@clerk/types';
import * as React from 'react';
import { useState } from 'react';
import { useMemo, useState } from 'react';

import { useProtect } from '../../common';
import { SubscriberTypeContext, usePlansContext, useSubscriberTypeContext, useSubscriptions } from '../../contexts';
Expand All@@ -19,7 +19,9 @@ import { handleError } from '../../utils';
export const PlanDetails = (props: __internal_PlanDetailsProps) => {
 return (
 <SubscriberTypeContext.Provider value={props.subscriberType || 'user'}>
 <PlanDetailsInternal {...props} />
 <Drawer.Content>
 <PlanDetailsInternal {...props} />
 </Drawer.Content>

Comment on lines

+22
 to 
+24

@panteliselefpanteliselefMay 29, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

😉
 </SubscriberTypeContext.Provider>
 );
};
Expand All@@ -28,18 +30,22 @@ const PlanDetailsInternal = ({
 plan,
 onSubscriptionCancel,
 portalRoot,
planPeriod: _planPeriod = 'month',
initialPlanPeriod = 'month',
}: __internal_PlanDetailsProps) => {
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [showConfirmation, setShowConfirmation] = useState(false);
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [cancelError, setCancelError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(_planPeriod);
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(initialPlanPeriod);

 const { setIsOpen } = useDrawerContext();
 const { activeOrUpcomingSubscription, revalidateAll, buttonPropsForPlan, isDefaultPlanImplicitlyActiveOrUpcoming } =
 usePlansContext();
 const {
 activeOrUpcomingSubscriptionBasedOnPlanPeriod,
 revalidateAll,
 buttonPropsForPlan,
 isDefaultPlanImplicitlyActiveOrUpcoming,
 } = usePlansContext();
 const subscriberType = useSubscriberTypeContext();
 const canManageBilling = useProtect(
 has => has({ permission: 'org:sys_billing:manage' }) || subscriberType === 'user',
Expand All@@ -49,7 +55,7 @@ const PlanDetailsInternal = ({
 return null;
 }

 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionBasedOnPlanPeriod(plan, planPeriod);

 const handleClose = () => {
 if (setIsOpen) {
Expand DownExpand Up@@ -105,7 +111,7 @@ const PlanDetailsInternal = ({
 };

 return (
 <Drawer.Content>
 <>
 <Drawer.Header
 sx={t =>
 !hasFeatures
Expand DownExpand Up@@ -209,7 +215,10 @@ const PlanDetailsInternal = ({
 />
 ) : (
 <Col gap={4}>
 {!!subscription && subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0 ? (
 {!!subscription &&
 subscription.planPeriod === 'month' &&
 plan.annualMonthlyAmount > 0 &&
 planPeriod === 'annual' ? (
 <Button
 block
 variant='bordered'
Expand All@@ -220,7 +229,7 @@ const PlanDetailsInternal = ({
 localizationKey={localizationKeys('commerce.switchToAnnual')}
 />
 ) : null}
 {!!subscription && subscription.planPeriod === 'annual' ? (
 {!!subscription && subscription.planPeriod === 'annual' && planPeriod === 'month' ? (
 <Button
 block
 variant='bordered'
Expand DownExpand Up@@ -314,7 +323,7 @@ const PlanDetailsInternal = ({
 )}
 </Drawer.Confirmation>
 ) : null}
 </Drawer.Content>
 </>
 );
};

Expand All@@ -338,7 +347,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {

 const isImplicitlyActiveOrUpcoming = isDefaultPlanImplicitlyActiveOrUpcoming && plan.isDefault;

 const showBadge = !!subscription || isImplicitlyActiveOrUpcoming;
 const showBadge = !!subscription;

 const getPlanFee = useMemo(() => {
 if (plan.annualMonthlyAmount <= 0) {
 return plan.amountFormatted;
 }
 return planPeriod === 'annual' ? plan.annualMonthlyAmountFormatted : plan.amountFormatted;
 }, [plan, planPeriod]);

 return (
 <Box
Expand All@@ -362,27 +378,58 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </Box>
 ) : null}

 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Box
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 <Col
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeAvatarTitleDescriptionContainer}
 >
 <Flex
 gap={2}
 align='center'
 {showBadge ? (
 <Flex
 align='center'
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeContainer}
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 >
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 {!!subscription && (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 colorScheme='secondary'
 />
 )}
 </Flex>
 ) : null}
 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Col
 gap={1}
 elementDescriptor={descriptors.planDetailTitleDescriptionContainer}
 >
 <Heading
 elementDescriptor={descriptors.planDetailTitle}
Expand All@@ -391,37 +438,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 >
 {plan.name}
 </Heading>
 {showBadge ? (
 <Flex elementDescriptor={descriptors.planDetailBadgeContainer}>
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 >
 {plan.description}
 </Text>
 ) : null}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 sx={t => ({
 marginTop: t.space.$1,
 })}
 >
 {plan.description}
 </Text>
 ) : null}
 </Box>
 </Col>
 </Col>

 <Flex
 elementDescriptor={descriptors.planDetailFeeContainer}
Expand All@@ -439,9 +466,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 colorScheme='body'
 >
 {plan.currencySymbol}
 {(subscription && subscription.planPeriod === 'annual') || planPeriod === 'annual'
 ? plan.annualMonthlyAmountFormatted
 : plan.amountFormatted}
 {getPlanFee}
 </Text>
 <Text
 elementDescriptor={descriptors.planDetailFeePeriod}
Expand All@@ -459,7 +484,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </>
 </Flex>

 {!subscription || (subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0) ? (
 {plan.annualMonthlyAmount > 0 ? (
 <Box
 elementDescriptor={descriptors.planDetailPeriodToggle}
 sx={t => ({
Expand All@@ -473,15 +498,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 label={localizationKeys('commerce.billedAnnually')}
 />
 </Box>
 ) : null}

 {!!subscription && (
 ) : (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 elementDescriptor={descriptors.pricingTableCardFeePeriodNotice}
 variant='caption'
 colorScheme='secondary'
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 marginTop: t.space.$3,
 })}
 />
Expand Down

7 changes: 4 additions & 3 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,7 @@ function Card(props: CardProps) {
 clerk.__internal_openPlanDetails({
 plan,
 subscriberType,
 planPeriod,
initialPlanPeriod: planPeriod,
 portalRoot,
 });
 };
Expand DownExpand Up@@ -414,10 +414,11 @@ const CardHeader = React.forwardRef<HTMLDivElement, CardHeaderProps>((props, ref
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={{
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 }}
 marginTop: t.space.$1,
 })}
 />
 )}
 </Box>
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -339,13 +339,14 @@ export const usePlansContext = () => {
 appearance,
 newSubscriptionRedirectUrl,
 }: HandleSelectPlanProps) => {
 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionWithPlanPeriod(plan, planPeriod);

 const portalRoot = getClosestProfileScrollBox(mode, event);

 if (subscription && subscription.planPeriod === planPeriod && !subscription.canceledAt) {
 clerk.__internal_openPlanDetails({
 plan,
 initialPlanPeriod: planPeriod,
 subscriberType,
 onSubscriptionCancel: () => {
 revalidateAll();
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,11 +288,12 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'pricingTableMatrixFooter',

 'planDetailHeader',
 'planDetailAvatarBadgeContainer',
 'planDetailAvatar',
 'planDetailBadgeAvatarTitleDescriptionContainer',
 'planDetailBadgeContainer',
 'planDetailBadge',
 'planDetailTitle',
 'planDetailTitleDescriptionContainer',
 'planDetailDescription',
 'planDetailAction',
 'planDetailFeeContainer',
Expand Down

3 changes: 2 additions & 1 deletion
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -421,11 +421,12 @@ export type ElementsConfig = {
 pricingTableMatrixFooter: WithOptions;

 planDetailHeader: WithOptions;
 planDetailAvatarBadgeContainer: WithOptions;
 planDetailAvatar: WithOptions;
 planDetailBadgeAvatarTitleDescriptionContainer: WithOptions;
 planDetailBadgeContainer: WithOptions;
 planDetailBadge: WithOptions;
 planDetailTitle: WithOptions;
 planDetailTitleDescriptionContainer: WithOptions;
 planDetailDescription: WithOptions;
 planDetailAction: WithOptions;
 planDetailFeeContainer: WithOptions;
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1641,7 +1641,7 @@ export type __internal_PlanDetailsProps = {
 appearance?: PlanDetailTheme;
 plan?: CommercePlanResource;
 subscriberType?: CommerceSubscriberType;
planPeriod?: CommerceSubscriptionPlanPeriod;
initialPlanPeriod?: CommerceSubscriptionPlanPeriod;
 onSubscriptionCancel?: () => void;
 portalId?: string;
 portalRoot?: PortalRoot;
Expand Down

, '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
chore(clerk-js): Tidy up layout and logic of PlanDetails drawer#5928

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

aeliox
merged 8 commits into

from

May 30, 2025
 Merged


chore(clerk-js): Tidy up layout and logic of PlanDetails drawer
#5928
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
9193f74

tidy up layout and logic of PlanDetails drawer


aeliox May 14, 2025
4aaa1a4

changeset


aeliox May 14, 2025
c5f8ddb

drop log


aeliox May 14, 2025
1be77eb

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 28, 2025
af7f39d

add some descriptors


aeliox May 29, 2025
9f9f0bd

bundle size


aeliox May 29, 2025
a5f71a8

fix unmounting of PlanDetails drawer, rename PlanDetails prop


aeliox May 29, 2025
c412857

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 29, 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


5 changes: 5 additions & 0 deletions
.changeset/metal-tips-joke.md

View file


Open in desktop

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

Clean up layout and logic of the `PlanDetails` drawer

171 changes: 99 additions & 72 deletions
packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import type {
 CommerceSubscriptionResource,
} from '@clerk/types';
import * as React from 'react';
import { useState } from 'react';
import { useMemo, useState } from 'react';

import { useProtect } from '../../common';
import { SubscriberTypeContext, usePlansContext, useSubscriberTypeContext, useSubscriptions } from '../../contexts';
Expand All@@ -19,7 +19,9 @@ import { handleError } from '../../utils';
export const PlanDetails = (props: __internal_PlanDetailsProps) => {
 return (
 <SubscriberTypeContext.Provider value={props.subscriberType || 'user'}>
 <PlanDetailsInternal {...props} />
 <Drawer.Content>
 <PlanDetailsInternal {...props} />
 </Drawer.Content>

Comment on lines

+22
 to 
+24

@panteliselefpanteliselefMay 29, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

😉
 </SubscriberTypeContext.Provider>
 );
};
Expand All@@ -28,18 +30,22 @@ const PlanDetailsInternal = ({
 plan,
 onSubscriptionCancel,
 portalRoot,
planPeriod: _planPeriod = 'month',
initialPlanPeriod = 'month',
}: __internal_PlanDetailsProps) => {
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [showConfirmation, setShowConfirmation] = useState(false);
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [cancelError, setCancelError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(_planPeriod);
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(initialPlanPeriod);

 const { setIsOpen } = useDrawerContext();
 const { activeOrUpcomingSubscription, revalidateAll, buttonPropsForPlan, isDefaultPlanImplicitlyActiveOrUpcoming } =
 usePlansContext();
 const {
 activeOrUpcomingSubscriptionBasedOnPlanPeriod,
 revalidateAll,
 buttonPropsForPlan,
 isDefaultPlanImplicitlyActiveOrUpcoming,
 } = usePlansContext();
 const subscriberType = useSubscriberTypeContext();
 const canManageBilling = useProtect(
 has => has({ permission: 'org:sys_billing:manage' }) || subscriberType === 'user',
Expand All@@ -49,7 +55,7 @@ const PlanDetailsInternal = ({
 return null;
 }

 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionBasedOnPlanPeriod(plan, planPeriod);

 const handleClose = () => {
 if (setIsOpen) {
Expand DownExpand Up@@ -105,7 +111,7 @@ const PlanDetailsInternal = ({
 };

 return (
 <Drawer.Content>
 <>
 <Drawer.Header
 sx={t =>
 !hasFeatures
Expand DownExpand Up@@ -209,7 +215,10 @@ const PlanDetailsInternal = ({
 />
 ) : (
 <Col gap={4}>
 {!!subscription && subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0 ? (
 {!!subscription &&
 subscription.planPeriod === 'month' &&
 plan.annualMonthlyAmount > 0 &&
 planPeriod === 'annual' ? (
 <Button
 block
 variant='bordered'
Expand All@@ -220,7 +229,7 @@ const PlanDetailsInternal = ({
 localizationKey={localizationKeys('commerce.switchToAnnual')}
 />
 ) : null}
 {!!subscription && subscription.planPeriod === 'annual' ? (
 {!!subscription && subscription.planPeriod === 'annual' && planPeriod === 'month' ? (
 <Button
 block
 variant='bordered'
Expand DownExpand Up@@ -314,7 +323,7 @@ const PlanDetailsInternal = ({
 )}
 </Drawer.Confirmation>
 ) : null}
 </Drawer.Content>
 </>
 );
};

Expand All@@ -338,7 +347,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {

 const isImplicitlyActiveOrUpcoming = isDefaultPlanImplicitlyActiveOrUpcoming && plan.isDefault;

 const showBadge = !!subscription || isImplicitlyActiveOrUpcoming;
 const showBadge = !!subscription;

 const getPlanFee = useMemo(() => {
 if (plan.annualMonthlyAmount <= 0) {
 return plan.amountFormatted;
 }
 return planPeriod === 'annual' ? plan.annualMonthlyAmountFormatted : plan.amountFormatted;
 }, [plan, planPeriod]);

 return (
 <Box
Expand All@@ -362,27 +378,58 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </Box>
 ) : null}

 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Box
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 <Col
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeAvatarTitleDescriptionContainer}
 >
 <Flex
 gap={2}
 align='center'
 {showBadge ? (
 <Flex
 align='center'
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeContainer}
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 >
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 {!!subscription && (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 colorScheme='secondary'
 />
 )}
 </Flex>
 ) : null}
 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Col
 gap={1}
 elementDescriptor={descriptors.planDetailTitleDescriptionContainer}
 >
 <Heading
 elementDescriptor={descriptors.planDetailTitle}
Expand All@@ -391,37 +438,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 >
 {plan.name}
 </Heading>
 {showBadge ? (
 <Flex elementDescriptor={descriptors.planDetailBadgeContainer}>
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 >
 {plan.description}
 </Text>
 ) : null}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 sx={t => ({
 marginTop: t.space.$1,
 })}
 >
 {plan.description}
 </Text>
 ) : null}
 </Box>
 </Col>
 </Col>

 <Flex
 elementDescriptor={descriptors.planDetailFeeContainer}
Expand All@@ -439,9 +466,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 colorScheme='body'
 >
 {plan.currencySymbol}
 {(subscription && subscription.planPeriod === 'annual') || planPeriod === 'annual'
 ? plan.annualMonthlyAmountFormatted
 : plan.amountFormatted}
 {getPlanFee}
 </Text>
 <Text
 elementDescriptor={descriptors.planDetailFeePeriod}
Expand All@@ -459,7 +484,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </>
 </Flex>

 {!subscription || (subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0) ? (
 {plan.annualMonthlyAmount > 0 ? (
 <Box
 elementDescriptor={descriptors.planDetailPeriodToggle}
 sx={t => ({
Expand All@@ -473,15 +498,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 label={localizationKeys('commerce.billedAnnually')}
 />
 </Box>
 ) : null}

 {!!subscription && (
 ) : (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 elementDescriptor={descriptors.pricingTableCardFeePeriodNotice}
 variant='caption'
 colorScheme='secondary'
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 marginTop: t.space.$3,
 })}
 />
Expand Down

7 changes: 4 additions & 3 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,7 @@ function Card(props: CardProps) {
 clerk.__internal_openPlanDetails({
 plan,
 subscriberType,
 planPeriod,
initialPlanPeriod: planPeriod,
 portalRoot,
 });
 };
Expand DownExpand Up@@ -414,10 +414,11 @@ const CardHeader = React.forwardRef<HTMLDivElement, CardHeaderProps>((props, ref
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={{
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 }}
 marginTop: t.space.$1,
 })}
 />
 )}
 </Box>
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -339,13 +339,14 @@ export const usePlansContext = () => {
 appearance,
 newSubscriptionRedirectUrl,
 }: HandleSelectPlanProps) => {
 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionWithPlanPeriod(plan, planPeriod);

 const portalRoot = getClosestProfileScrollBox(mode, event);

 if (subscription && subscription.planPeriod === planPeriod && !subscription.canceledAt) {
 clerk.__internal_openPlanDetails({
 plan,
 initialPlanPeriod: planPeriod,
 subscriberType,
 onSubscriptionCancel: () => {
 revalidateAll();
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,11 +288,12 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'pricingTableMatrixFooter',

 'planDetailHeader',
 'planDetailAvatarBadgeContainer',
 'planDetailAvatar',
 'planDetailBadgeAvatarTitleDescriptionContainer',
 'planDetailBadgeContainer',
 'planDetailBadge',
 'planDetailTitle',
 'planDetailTitleDescriptionContainer',
 'planDetailDescription',
 'planDetailAction',
 'planDetailFeeContainer',
Expand Down

3 changes: 2 additions & 1 deletion
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -421,11 +421,12 @@ export type ElementsConfig = {
 pricingTableMatrixFooter: WithOptions;

 planDetailHeader: WithOptions;
 planDetailAvatarBadgeContainer: WithOptions;
 planDetailAvatar: WithOptions;
 planDetailBadgeAvatarTitleDescriptionContainer: WithOptions;
 planDetailBadgeContainer: WithOptions;
 planDetailBadge: WithOptions;
 planDetailTitle: WithOptions;
 planDetailTitleDescriptionContainer: WithOptions;
 planDetailDescription: WithOptions;
 planDetailAction: WithOptions;
 planDetailFeeContainer: WithOptions;
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1641,7 +1641,7 @@ export type __internal_PlanDetailsProps = {
 appearance?: PlanDetailTheme;
 plan?: CommercePlanResource;
 subscriberType?: CommerceSubscriberType;
planPeriod?: CommerceSubscriptionPlanPeriod;
initialPlanPeriod?: CommerceSubscriptionPlanPeriod;
 onSubscriptionCancel?: () => void;
 portalId?: string;
 portalRoot?: PortalRoot;
Expand Down

, '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
chore(clerk-js): Tidy up layout and logic of PlanDetails drawer#5928

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

aeliox
merged 8 commits into

from

May 30, 2025
 Merged


chore(clerk-js): Tidy up layout and logic of PlanDetails drawer
#5928
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
9193f74

tidy up layout and logic of PlanDetails drawer


aeliox May 14, 2025
4aaa1a4

changeset


aeliox May 14, 2025
c5f8ddb

drop log


aeliox May 14, 2025
1be77eb

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 28, 2025
af7f39d

add some descriptors


aeliox May 29, 2025
9f9f0bd

bundle size


aeliox May 29, 2025
a5f71a8

fix unmounting of PlanDetails drawer, rename PlanDetails prop


aeliox May 29, 2025
c412857

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 29, 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


5 changes: 5 additions & 0 deletions
.changeset/metal-tips-joke.md

View file


Open in desktop

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

Clean up layout and logic of the `PlanDetails` drawer

171 changes: 99 additions & 72 deletions
packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import type {
 CommerceSubscriptionResource,
} from '@clerk/types';
import * as React from 'react';
import { useState } from 'react';
import { useMemo, useState } from 'react';

import { useProtect } from '../../common';
import { SubscriberTypeContext, usePlansContext, useSubscriberTypeContext, useSubscriptions } from '../../contexts';
Expand All@@ -19,7 +19,9 @@ import { handleError } from '../../utils';
export const PlanDetails = (props: __internal_PlanDetailsProps) => {
 return (
 <SubscriberTypeContext.Provider value={props.subscriberType || 'user'}>
 <PlanDetailsInternal {...props} />
 <Drawer.Content>
 <PlanDetailsInternal {...props} />
 </Drawer.Content>

Comment on lines

+22
 to 
+24

@panteliselefpanteliselefMay 29, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

😉
 </SubscriberTypeContext.Provider>
 );
};
Expand All@@ -28,18 +30,22 @@ const PlanDetailsInternal = ({
 plan,
 onSubscriptionCancel,
 portalRoot,
planPeriod: _planPeriod = 'month',
initialPlanPeriod = 'month',
}: __internal_PlanDetailsProps) => {
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [showConfirmation, setShowConfirmation] = useState(false);
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [cancelError, setCancelError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(_planPeriod);
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(initialPlanPeriod);

 const { setIsOpen } = useDrawerContext();
 const { activeOrUpcomingSubscription, revalidateAll, buttonPropsForPlan, isDefaultPlanImplicitlyActiveOrUpcoming } =
 usePlansContext();
 const {
 activeOrUpcomingSubscriptionBasedOnPlanPeriod,
 revalidateAll,
 buttonPropsForPlan,
 isDefaultPlanImplicitlyActiveOrUpcoming,
 } = usePlansContext();
 const subscriberType = useSubscriberTypeContext();
 const canManageBilling = useProtect(
 has => has({ permission: 'org:sys_billing:manage' }) || subscriberType === 'user',
Expand All@@ -49,7 +55,7 @@ const PlanDetailsInternal = ({
 return null;
 }

 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionBasedOnPlanPeriod(plan, planPeriod);

 const handleClose = () => {
 if (setIsOpen) {
Expand DownExpand Up@@ -105,7 +111,7 @@ const PlanDetailsInternal = ({
 };

 return (
 <Drawer.Content>
 <>
 <Drawer.Header
 sx={t =>
 !hasFeatures
Expand DownExpand Up@@ -209,7 +215,10 @@ const PlanDetailsInternal = ({
 />
 ) : (
 <Col gap={4}>
 {!!subscription && subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0 ? (
 {!!subscription &&
 subscription.planPeriod === 'month' &&
 plan.annualMonthlyAmount > 0 &&
 planPeriod === 'annual' ? (
 <Button
 block
 variant='bordered'
Expand All@@ -220,7 +229,7 @@ const PlanDetailsInternal = ({
 localizationKey={localizationKeys('commerce.switchToAnnual')}
 />
 ) : null}
 {!!subscription && subscription.planPeriod === 'annual' ? (
 {!!subscription && subscription.planPeriod === 'annual' && planPeriod === 'month' ? (
 <Button
 block
 variant='bordered'
Expand DownExpand Up@@ -314,7 +323,7 @@ const PlanDetailsInternal = ({
 )}
 </Drawer.Confirmation>
 ) : null}
 </Drawer.Content>
 </>
 );
};

Expand All@@ -338,7 +347,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {

 const isImplicitlyActiveOrUpcoming = isDefaultPlanImplicitlyActiveOrUpcoming && plan.isDefault;

 const showBadge = !!subscription || isImplicitlyActiveOrUpcoming;
 const showBadge = !!subscription;

 const getPlanFee = useMemo(() => {
 if (plan.annualMonthlyAmount <= 0) {
 return plan.amountFormatted;
 }
 return planPeriod === 'annual' ? plan.annualMonthlyAmountFormatted : plan.amountFormatted;
 }, [plan, planPeriod]);

 return (
 <Box
Expand All@@ -362,27 +378,58 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </Box>
 ) : null}

 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Box
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 <Col
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeAvatarTitleDescriptionContainer}
 >
 <Flex
 gap={2}
 align='center'
 {showBadge ? (
 <Flex
 align='center'
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeContainer}
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 >
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 {!!subscription && (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 colorScheme='secondary'
 />
 )}
 </Flex>
 ) : null}
 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Col
 gap={1}
 elementDescriptor={descriptors.planDetailTitleDescriptionContainer}
 >
 <Heading
 elementDescriptor={descriptors.planDetailTitle}
Expand All@@ -391,37 +438,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 >
 {plan.name}
 </Heading>
 {showBadge ? (
 <Flex elementDescriptor={descriptors.planDetailBadgeContainer}>
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 >
 {plan.description}
 </Text>
 ) : null}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 sx={t => ({
 marginTop: t.space.$1,
 })}
 >
 {plan.description}
 </Text>
 ) : null}
 </Box>
 </Col>
 </Col>

 <Flex
 elementDescriptor={descriptors.planDetailFeeContainer}
Expand All@@ -439,9 +466,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 colorScheme='body'
 >
 {plan.currencySymbol}
 {(subscription && subscription.planPeriod === 'annual') || planPeriod === 'annual'
 ? plan.annualMonthlyAmountFormatted
 : plan.amountFormatted}
 {getPlanFee}
 </Text>
 <Text
 elementDescriptor={descriptors.planDetailFeePeriod}
Expand All@@ -459,7 +484,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </>
 </Flex>

 {!subscription || (subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0) ? (
 {plan.annualMonthlyAmount > 0 ? (
 <Box
 elementDescriptor={descriptors.planDetailPeriodToggle}
 sx={t => ({
Expand All@@ -473,15 +498,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 label={localizationKeys('commerce.billedAnnually')}
 />
 </Box>
 ) : null}

 {!!subscription && (
 ) : (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 elementDescriptor={descriptors.pricingTableCardFeePeriodNotice}
 variant='caption'
 colorScheme='secondary'
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 marginTop: t.space.$3,
 })}
 />
Expand Down

7 changes: 4 additions & 3 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,7 @@ function Card(props: CardProps) {
 clerk.__internal_openPlanDetails({
 plan,
 subscriberType,
 planPeriod,
initialPlanPeriod: planPeriod,
 portalRoot,
 });
 };
Expand DownExpand Up@@ -414,10 +414,11 @@ const CardHeader = React.forwardRef<HTMLDivElement, CardHeaderProps>((props, ref
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={{
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 }}
 marginTop: t.space.$1,
 })}
 />
 )}
 </Box>
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -339,13 +339,14 @@ export const usePlansContext = () => {
 appearance,
 newSubscriptionRedirectUrl,
 }: HandleSelectPlanProps) => {
 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionWithPlanPeriod(plan, planPeriod);

 const portalRoot = getClosestProfileScrollBox(mode, event);

 if (subscription && subscription.planPeriod === planPeriod && !subscription.canceledAt) {
 clerk.__internal_openPlanDetails({
 plan,
 initialPlanPeriod: planPeriod,
 subscriberType,
 onSubscriptionCancel: () => {
 revalidateAll();
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,11 +288,12 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'pricingTableMatrixFooter',

 'planDetailHeader',
 'planDetailAvatarBadgeContainer',
 'planDetailAvatar',
 'planDetailBadgeAvatarTitleDescriptionContainer',
 'planDetailBadgeContainer',
 'planDetailBadge',
 'planDetailTitle',
 'planDetailTitleDescriptionContainer',
 'planDetailDescription',
 'planDetailAction',
 'planDetailFeeContainer',
Expand Down

3 changes: 2 additions & 1 deletion
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -421,11 +421,12 @@ export type ElementsConfig = {
 pricingTableMatrixFooter: WithOptions;

 planDetailHeader: WithOptions;
 planDetailAvatarBadgeContainer: WithOptions;
 planDetailAvatar: WithOptions;
 planDetailBadgeAvatarTitleDescriptionContainer: WithOptions;
 planDetailBadgeContainer: WithOptions;
 planDetailBadge: WithOptions;
 planDetailTitle: WithOptions;
 planDetailTitleDescriptionContainer: WithOptions;
 planDetailDescription: WithOptions;
 planDetailAction: WithOptions;
 planDetailFeeContainer: WithOptions;
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1641,7 +1641,7 @@ export type __internal_PlanDetailsProps = {
 appearance?: PlanDetailTheme;
 plan?: CommercePlanResource;
 subscriberType?: CommerceSubscriberType;
planPeriod?: CommerceSubscriptionPlanPeriod;
initialPlanPeriod?: CommerceSubscriptionPlanPeriod;
 onSubscriptionCancel?: () => void;
 portalId?: string;
 portalRoot?: PortalRoot;
Expand Down

, '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
chore(clerk-js): Tidy up layout and logic of PlanDetails drawer#5928

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

aeliox
merged 8 commits into

from

May 30, 2025
 Merged


chore(clerk-js): Tidy up layout and logic of PlanDetails drawer
#5928
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
9193f74

tidy up layout and logic of PlanDetails drawer


aeliox May 14, 2025
4aaa1a4

changeset


aeliox May 14, 2025
c5f8ddb

drop log


aeliox May 14, 2025
1be77eb

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 28, 2025
af7f39d

add some descriptors


aeliox May 29, 2025
9f9f0bd

bundle size


aeliox May 29, 2025
a5f71a8

fix unmounting of PlanDetails drawer, rename PlanDetails prop


aeliox May 29, 2025
c412857

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 29, 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


5 changes: 5 additions & 0 deletions
.changeset/metal-tips-joke.md

View file


Open in desktop

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

Clean up layout and logic of the `PlanDetails` drawer

171 changes: 99 additions & 72 deletions
packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import type {
 CommerceSubscriptionResource,
} from '@clerk/types';
import * as React from 'react';
import { useState } from 'react';
import { useMemo, useState } from 'react';

import { useProtect } from '../../common';
import { SubscriberTypeContext, usePlansContext, useSubscriberTypeContext, useSubscriptions } from '../../contexts';
Expand All@@ -19,7 +19,9 @@ import { handleError } from '../../utils';
export const PlanDetails = (props: __internal_PlanDetailsProps) => {
 return (
 <SubscriberTypeContext.Provider value={props.subscriberType || 'user'}>
 <PlanDetailsInternal {...props} />
 <Drawer.Content>
 <PlanDetailsInternal {...props} />
 </Drawer.Content>

Comment on lines

+22
 to 
+24

@panteliselefpanteliselefMay 29, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

😉
 </SubscriberTypeContext.Provider>
 );
};
Expand All@@ -28,18 +30,22 @@ const PlanDetailsInternal = ({
 plan,
 onSubscriptionCancel,
 portalRoot,
planPeriod: _planPeriod = 'month',
initialPlanPeriod = 'month',
}: __internal_PlanDetailsProps) => {
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [showConfirmation, setShowConfirmation] = useState(false);
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [cancelError, setCancelError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(_planPeriod);
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(initialPlanPeriod);

 const { setIsOpen } = useDrawerContext();
 const { activeOrUpcomingSubscription, revalidateAll, buttonPropsForPlan, isDefaultPlanImplicitlyActiveOrUpcoming } =
 usePlansContext();
 const {
 activeOrUpcomingSubscriptionBasedOnPlanPeriod,
 revalidateAll,
 buttonPropsForPlan,
 isDefaultPlanImplicitlyActiveOrUpcoming,
 } = usePlansContext();
 const subscriberType = useSubscriberTypeContext();
 const canManageBilling = useProtect(
 has => has({ permission: 'org:sys_billing:manage' }) || subscriberType === 'user',
Expand All@@ -49,7 +55,7 @@ const PlanDetailsInternal = ({
 return null;
 }

 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionBasedOnPlanPeriod(plan, planPeriod);

 const handleClose = () => {
 if (setIsOpen) {
Expand DownExpand Up@@ -105,7 +111,7 @@ const PlanDetailsInternal = ({
 };

 return (
 <Drawer.Content>
 <>
 <Drawer.Header
 sx={t =>
 !hasFeatures
Expand DownExpand Up@@ -209,7 +215,10 @@ const PlanDetailsInternal = ({
 />
 ) : (
 <Col gap={4}>
 {!!subscription && subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0 ? (
 {!!subscription &&
 subscription.planPeriod === 'month' &&
 plan.annualMonthlyAmount > 0 &&
 planPeriod === 'annual' ? (
 <Button
 block
 variant='bordered'
Expand All@@ -220,7 +229,7 @@ const PlanDetailsInternal = ({
 localizationKey={localizationKeys('commerce.switchToAnnual')}
 />
 ) : null}
 {!!subscription && subscription.planPeriod === 'annual' ? (
 {!!subscription && subscription.planPeriod === 'annual' && planPeriod === 'month' ? (
 <Button
 block
 variant='bordered'
Expand DownExpand Up@@ -314,7 +323,7 @@ const PlanDetailsInternal = ({
 )}
 </Drawer.Confirmation>
 ) : null}
 </Drawer.Content>
 </>
 );
};

Expand All@@ -338,7 +347,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {

 const isImplicitlyActiveOrUpcoming = isDefaultPlanImplicitlyActiveOrUpcoming && plan.isDefault;

 const showBadge = !!subscription || isImplicitlyActiveOrUpcoming;
 const showBadge = !!subscription;

 const getPlanFee = useMemo(() => {
 if (plan.annualMonthlyAmount <= 0) {
 return plan.amountFormatted;
 }
 return planPeriod === 'annual' ? plan.annualMonthlyAmountFormatted : plan.amountFormatted;
 }, [plan, planPeriod]);

 return (
 <Box
Expand All@@ -362,27 +378,58 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </Box>
 ) : null}

 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Box
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 <Col
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeAvatarTitleDescriptionContainer}
 >
 <Flex
 gap={2}
 align='center'
 {showBadge ? (
 <Flex
 align='center'
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeContainer}
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 >
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 {!!subscription && (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 colorScheme='secondary'
 />
 )}
 </Flex>
 ) : null}
 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Col
 gap={1}
 elementDescriptor={descriptors.planDetailTitleDescriptionContainer}
 >
 <Heading
 elementDescriptor={descriptors.planDetailTitle}
Expand All@@ -391,37 +438,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 >
 {plan.name}
 </Heading>
 {showBadge ? (
 <Flex elementDescriptor={descriptors.planDetailBadgeContainer}>
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 >
 {plan.description}
 </Text>
 ) : null}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 sx={t => ({
 marginTop: t.space.$1,
 })}
 >
 {plan.description}
 </Text>
 ) : null}
 </Box>
 </Col>
 </Col>

 <Flex
 elementDescriptor={descriptors.planDetailFeeContainer}
Expand All@@ -439,9 +466,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 colorScheme='body'
 >
 {plan.currencySymbol}
 {(subscription && subscription.planPeriod === 'annual') || planPeriod === 'annual'
 ? plan.annualMonthlyAmountFormatted
 : plan.amountFormatted}
 {getPlanFee}
 </Text>
 <Text
 elementDescriptor={descriptors.planDetailFeePeriod}
Expand All@@ -459,7 +484,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </>
 </Flex>

 {!subscription || (subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0) ? (
 {plan.annualMonthlyAmount > 0 ? (
 <Box
 elementDescriptor={descriptors.planDetailPeriodToggle}
 sx={t => ({
Expand All@@ -473,15 +498,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 label={localizationKeys('commerce.billedAnnually')}
 />
 </Box>
 ) : null}

 {!!subscription && (
 ) : (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 elementDescriptor={descriptors.pricingTableCardFeePeriodNotice}
 variant='caption'
 colorScheme='secondary'
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 marginTop: t.space.$3,
 })}
 />
Expand Down

7 changes: 4 additions & 3 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,7 @@ function Card(props: CardProps) {
 clerk.__internal_openPlanDetails({
 plan,
 subscriberType,
 planPeriod,
initialPlanPeriod: planPeriod,
 portalRoot,
 });
 };
Expand DownExpand Up@@ -414,10 +414,11 @@ const CardHeader = React.forwardRef<HTMLDivElement, CardHeaderProps>((props, ref
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={{
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 }}
 marginTop: t.space.$1,
 })}
 />
 )}
 </Box>
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -339,13 +339,14 @@ export const usePlansContext = () => {
 appearance,
 newSubscriptionRedirectUrl,
 }: HandleSelectPlanProps) => {
 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionWithPlanPeriod(plan, planPeriod);

 const portalRoot = getClosestProfileScrollBox(mode, event);

 if (subscription && subscription.planPeriod === planPeriod && !subscription.canceledAt) {
 clerk.__internal_openPlanDetails({
 plan,
 initialPlanPeriod: planPeriod,
 subscriberType,
 onSubscriptionCancel: () => {
 revalidateAll();
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,11 +288,12 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'pricingTableMatrixFooter',

 'planDetailHeader',
 'planDetailAvatarBadgeContainer',
 'planDetailAvatar',
 'planDetailBadgeAvatarTitleDescriptionContainer',
 'planDetailBadgeContainer',
 'planDetailBadge',
 'planDetailTitle',
 'planDetailTitleDescriptionContainer',
 'planDetailDescription',
 'planDetailAction',
 'planDetailFeeContainer',
Expand Down

3 changes: 2 additions & 1 deletion
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -421,11 +421,12 @@ export type ElementsConfig = {
 pricingTableMatrixFooter: WithOptions;

 planDetailHeader: WithOptions;
 planDetailAvatarBadgeContainer: WithOptions;
 planDetailAvatar: WithOptions;
 planDetailBadgeAvatarTitleDescriptionContainer: WithOptions;
 planDetailBadgeContainer: WithOptions;
 planDetailBadge: WithOptions;
 planDetailTitle: WithOptions;
 planDetailTitleDescriptionContainer: WithOptions;
 planDetailDescription: WithOptions;
 planDetailAction: WithOptions;
 planDetailFeeContainer: WithOptions;
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1641,7 +1641,7 @@ export type __internal_PlanDetailsProps = {
 appearance?: PlanDetailTheme;
 plan?: CommercePlanResource;
 subscriberType?: CommerceSubscriberType;
planPeriod?: CommerceSubscriptionPlanPeriod;
initialPlanPeriod?: CommerceSubscriptionPlanPeriod;
 onSubscriptionCancel?: () => void;
 portalId?: string;
 portalRoot?: PortalRoot;
Expand Down

, '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
chore(clerk-js): Tidy up layout and logic of PlanDetails drawer#5928

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

aeliox
merged 8 commits into

from

May 30, 2025
 Merged


chore(clerk-js): Tidy up layout and logic of PlanDetails drawer
#5928
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
9193f74

tidy up layout and logic of PlanDetails drawer


aeliox May 14, 2025
4aaa1a4

changeset


aeliox May 14, 2025
c5f8ddb

drop log


aeliox May 14, 2025
1be77eb

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 28, 2025
af7f39d

add some descriptors


aeliox May 29, 2025
9f9f0bd

bundle size


aeliox May 29, 2025
a5f71a8

fix unmounting of PlanDetails drawer, rename PlanDetails prop


aeliox May 29, 2025
c412857

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 29, 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


5 changes: 5 additions & 0 deletions
.changeset/metal-tips-joke.md

View file


Open in desktop

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

Clean up layout and logic of the `PlanDetails` drawer

171 changes: 99 additions & 72 deletions
packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import type {
 CommerceSubscriptionResource,
} from '@clerk/types';
import * as React from 'react';
import { useState } from 'react';
import { useMemo, useState } from 'react';

import { useProtect } from '../../common';
import { SubscriberTypeContext, usePlansContext, useSubscriberTypeContext, useSubscriptions } from '../../contexts';
Expand All@@ -19,7 +19,9 @@ import { handleError } from '../../utils';
export const PlanDetails = (props: __internal_PlanDetailsProps) => {
 return (
 <SubscriberTypeContext.Provider value={props.subscriberType || 'user'}>
 <PlanDetailsInternal {...props} />
 <Drawer.Content>
 <PlanDetailsInternal {...props} />
 </Drawer.Content>

Comment on lines

+22
 to 
+24

@panteliselefpanteliselefMay 29, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

😉
 </SubscriberTypeContext.Provider>
 );
};
Expand All@@ -28,18 +30,22 @@ const PlanDetailsInternal = ({
 plan,
 onSubscriptionCancel,
 portalRoot,
planPeriod: _planPeriod = 'month',
initialPlanPeriod = 'month',
}: __internal_PlanDetailsProps) => {
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [showConfirmation, setShowConfirmation] = useState(false);
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [cancelError, setCancelError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(_planPeriod);
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(initialPlanPeriod);

 const { setIsOpen } = useDrawerContext();
 const { activeOrUpcomingSubscription, revalidateAll, buttonPropsForPlan, isDefaultPlanImplicitlyActiveOrUpcoming } =
 usePlansContext();
 const {
 activeOrUpcomingSubscriptionBasedOnPlanPeriod,
 revalidateAll,
 buttonPropsForPlan,
 isDefaultPlanImplicitlyActiveOrUpcoming,
 } = usePlansContext();
 const subscriberType = useSubscriberTypeContext();
 const canManageBilling = useProtect(
 has => has({ permission: 'org:sys_billing:manage' }) || subscriberType === 'user',
Expand All@@ -49,7 +55,7 @@ const PlanDetailsInternal = ({
 return null;
 }

 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionBasedOnPlanPeriod(plan, planPeriod);

 const handleClose = () => {
 if (setIsOpen) {
Expand DownExpand Up@@ -105,7 +111,7 @@ const PlanDetailsInternal = ({
 };

 return (
 <Drawer.Content>
 <>
 <Drawer.Header
 sx={t =>
 !hasFeatures
Expand DownExpand Up@@ -209,7 +215,10 @@ const PlanDetailsInternal = ({
 />
 ) : (
 <Col gap={4}>
 {!!subscription && subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0 ? (
 {!!subscription &&
 subscription.planPeriod === 'month' &&
 plan.annualMonthlyAmount > 0 &&
 planPeriod === 'annual' ? (
 <Button
 block
 variant='bordered'
Expand All@@ -220,7 +229,7 @@ const PlanDetailsInternal = ({
 localizationKey={localizationKeys('commerce.switchToAnnual')}
 />
 ) : null}
 {!!subscription && subscription.planPeriod === 'annual' ? (
 {!!subscription && subscription.planPeriod === 'annual' && planPeriod === 'month' ? (
 <Button
 block
 variant='bordered'
Expand DownExpand Up@@ -314,7 +323,7 @@ const PlanDetailsInternal = ({
 )}
 </Drawer.Confirmation>
 ) : null}
 </Drawer.Content>
 </>
 );
};

Expand All@@ -338,7 +347,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {

 const isImplicitlyActiveOrUpcoming = isDefaultPlanImplicitlyActiveOrUpcoming && plan.isDefault;

 const showBadge = !!subscription || isImplicitlyActiveOrUpcoming;
 const showBadge = !!subscription;

 const getPlanFee = useMemo(() => {
 if (plan.annualMonthlyAmount <= 0) {
 return plan.amountFormatted;
 }
 return planPeriod === 'annual' ? plan.annualMonthlyAmountFormatted : plan.amountFormatted;
 }, [plan, planPeriod]);

 return (
 <Box
Expand All@@ -362,27 +378,58 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </Box>
 ) : null}

 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Box
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 <Col
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeAvatarTitleDescriptionContainer}
 >
 <Flex
 gap={2}
 align='center'
 {showBadge ? (
 <Flex
 align='center'
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeContainer}
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 >
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 {!!subscription && (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 colorScheme='secondary'
 />
 )}
 </Flex>
 ) : null}
 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Col
 gap={1}
 elementDescriptor={descriptors.planDetailTitleDescriptionContainer}
 >
 <Heading
 elementDescriptor={descriptors.planDetailTitle}
Expand All@@ -391,37 +438,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 >
 {plan.name}
 </Heading>
 {showBadge ? (
 <Flex elementDescriptor={descriptors.planDetailBadgeContainer}>
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 >
 {plan.description}
 </Text>
 ) : null}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 sx={t => ({
 marginTop: t.space.$1,
 })}
 >
 {plan.description}
 </Text>
 ) : null}
 </Box>
 </Col>
 </Col>

 <Flex
 elementDescriptor={descriptors.planDetailFeeContainer}
Expand All@@ -439,9 +466,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 colorScheme='body'
 >
 {plan.currencySymbol}
 {(subscription && subscription.planPeriod === 'annual') || planPeriod === 'annual'
 ? plan.annualMonthlyAmountFormatted
 : plan.amountFormatted}
 {getPlanFee}
 </Text>
 <Text
 elementDescriptor={descriptors.planDetailFeePeriod}
Expand All@@ -459,7 +484,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </>
 </Flex>

 {!subscription || (subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0) ? (
 {plan.annualMonthlyAmount > 0 ? (
 <Box
 elementDescriptor={descriptors.planDetailPeriodToggle}
 sx={t => ({
Expand All@@ -473,15 +498,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 label={localizationKeys('commerce.billedAnnually')}
 />
 </Box>
 ) : null}

 {!!subscription && (
 ) : (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 elementDescriptor={descriptors.pricingTableCardFeePeriodNotice}
 variant='caption'
 colorScheme='secondary'
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 marginTop: t.space.$3,
 })}
 />
Expand Down

7 changes: 4 additions & 3 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,7 @@ function Card(props: CardProps) {
 clerk.__internal_openPlanDetails({
 plan,
 subscriberType,
 planPeriod,
initialPlanPeriod: planPeriod,
 portalRoot,
 });
 };
Expand DownExpand Up@@ -414,10 +414,11 @@ const CardHeader = React.forwardRef<HTMLDivElement, CardHeaderProps>((props, ref
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={{
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 }}
 marginTop: t.space.$1,
 })}
 />
 )}
 </Box>
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -339,13 +339,14 @@ export const usePlansContext = () => {
 appearance,
 newSubscriptionRedirectUrl,
 }: HandleSelectPlanProps) => {
 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionWithPlanPeriod(plan, planPeriod);

 const portalRoot = getClosestProfileScrollBox(mode, event);

 if (subscription && subscription.planPeriod === planPeriod && !subscription.canceledAt) {
 clerk.__internal_openPlanDetails({
 plan,
 initialPlanPeriod: planPeriod,
 subscriberType,
 onSubscriptionCancel: () => {
 revalidateAll();
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,11 +288,12 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'pricingTableMatrixFooter',

 'planDetailHeader',
 'planDetailAvatarBadgeContainer',
 'planDetailAvatar',
 'planDetailBadgeAvatarTitleDescriptionContainer',
 'planDetailBadgeContainer',
 'planDetailBadge',
 'planDetailTitle',
 'planDetailTitleDescriptionContainer',
 'planDetailDescription',
 'planDetailAction',
 'planDetailFeeContainer',
Expand Down

3 changes: 2 additions & 1 deletion
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -421,11 +421,12 @@ export type ElementsConfig = {
 pricingTableMatrixFooter: WithOptions;

 planDetailHeader: WithOptions;
 planDetailAvatarBadgeContainer: WithOptions;
 planDetailAvatar: WithOptions;
 planDetailBadgeAvatarTitleDescriptionContainer: WithOptions;
 planDetailBadgeContainer: WithOptions;
 planDetailBadge: WithOptions;
 planDetailTitle: WithOptions;
 planDetailTitleDescriptionContainer: WithOptions;
 planDetailDescription: WithOptions;
 planDetailAction: WithOptions;
 planDetailFeeContainer: WithOptions;
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1641,7 +1641,7 @@ export type __internal_PlanDetailsProps = {
 appearance?: PlanDetailTheme;
 plan?: CommercePlanResource;
 subscriberType?: CommerceSubscriberType;
planPeriod?: CommerceSubscriptionPlanPeriod;
initialPlanPeriod?: CommerceSubscriptionPlanPeriod;
 onSubscriptionCancel?: () => void;
 portalId?: string;
 portalRoot?: PortalRoot;
Expand Down

, '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
chore(clerk-js): Tidy up layout and logic of PlanDetails drawer#5928

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

aeliox
merged 8 commits into

from

May 30, 2025
 Merged


chore(clerk-js): Tidy up layout and logic of PlanDetails drawer
#5928
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
9193f74

tidy up layout and logic of PlanDetails drawer


aeliox May 14, 2025
4aaa1a4

changeset


aeliox May 14, 2025
c5f8ddb

drop log


aeliox May 14, 2025
1be77eb

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 28, 2025
af7f39d

add some descriptors


aeliox May 29, 2025
9f9f0bd

bundle size


aeliox May 29, 2025
a5f71a8

fix unmounting of PlanDetails drawer, rename PlanDetails prop


aeliox May 29, 2025
c412857

Merge branch 'main' into keiran/com-795-plan-details


aeliox May 29, 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


5 changes: 5 additions & 0 deletions
.changeset/metal-tips-joke.md

View file


Open in desktop

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

Clean up layout and logic of the `PlanDetails` drawer

171 changes: 99 additions & 72 deletions
packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import type {
 CommerceSubscriptionResource,
} from '@clerk/types';
import * as React from 'react';
import { useState } from 'react';
import { useMemo, useState } from 'react';

import { useProtect } from '../../common';
import { SubscriberTypeContext, usePlansContext, useSubscriberTypeContext, useSubscriptions } from '../../contexts';
Expand All@@ -19,7 +19,9 @@ import { handleError } from '../../utils';
export const PlanDetails = (props: __internal_PlanDetailsProps) => {
 return (
 <SubscriberTypeContext.Provider value={props.subscriberType || 'user'}>
 <PlanDetailsInternal {...props} />
 <Drawer.Content>
 <PlanDetailsInternal {...props} />
 </Drawer.Content>

Comment on lines

+22
 to 
+24

@panteliselefpanteliselefMay 29, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

😉
 </SubscriberTypeContext.Provider>
 );
};
Expand All@@ -28,18 +30,22 @@ const PlanDetailsInternal = ({
 plan,
 onSubscriptionCancel,
 portalRoot,
planPeriod: _planPeriod = 'month',
initialPlanPeriod = 'month',
}: __internal_PlanDetailsProps) => {
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [showConfirmation, setShowConfirmation] = useState(false);
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [cancelError, setCancelError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(_planPeriod);
 const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(initialPlanPeriod);

 const { setIsOpen } = useDrawerContext();
 const { activeOrUpcomingSubscription, revalidateAll, buttonPropsForPlan, isDefaultPlanImplicitlyActiveOrUpcoming } =
 usePlansContext();
 const {
 activeOrUpcomingSubscriptionBasedOnPlanPeriod,
 revalidateAll,
 buttonPropsForPlan,
 isDefaultPlanImplicitlyActiveOrUpcoming,
 } = usePlansContext();
 const subscriberType = useSubscriberTypeContext();
 const canManageBilling = useProtect(
 has => has({ permission: 'org:sys_billing:manage' }) || subscriberType === 'user',
Expand All@@ -49,7 +55,7 @@ const PlanDetailsInternal = ({
 return null;
 }

 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionBasedOnPlanPeriod(plan, planPeriod);

 const handleClose = () => {
 if (setIsOpen) {
Expand DownExpand Up@@ -105,7 +111,7 @@ const PlanDetailsInternal = ({
 };

 return (
 <Drawer.Content>
 <>
 <Drawer.Header
 sx={t =>
 !hasFeatures
Expand DownExpand Up@@ -209,7 +215,10 @@ const PlanDetailsInternal = ({
 />
 ) : (
 <Col gap={4}>
 {!!subscription && subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0 ? (
 {!!subscription &&
 subscription.planPeriod === 'month' &&
 plan.annualMonthlyAmount > 0 &&
 planPeriod === 'annual' ? (
 <Button
 block
 variant='bordered'
Expand All@@ -220,7 +229,7 @@ const PlanDetailsInternal = ({
 localizationKey={localizationKeys('commerce.switchToAnnual')}
 />
 ) : null}
 {!!subscription && subscription.planPeriod === 'annual' ? (
 {!!subscription && subscription.planPeriod === 'annual' && planPeriod === 'month' ? (
 <Button
 block
 variant='bordered'
Expand DownExpand Up@@ -314,7 +323,7 @@ const PlanDetailsInternal = ({
 )}
 </Drawer.Confirmation>
 ) : null}
 </Drawer.Content>
 </>
 );
};

Expand All@@ -338,7 +347,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {

 const isImplicitlyActiveOrUpcoming = isDefaultPlanImplicitlyActiveOrUpcoming && plan.isDefault;

 const showBadge = !!subscription || isImplicitlyActiveOrUpcoming;
 const showBadge = !!subscription;

 const getPlanFee = useMemo(() => {
 if (plan.annualMonthlyAmount <= 0) {
 return plan.amountFormatted;
 }
 return planPeriod === 'annual' ? plan.annualMonthlyAmountFormatted : plan.amountFormatted;
 }, [plan, planPeriod]);

 return (
 <Box
Expand All@@ -362,27 +378,58 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </Box>
 ) : null}

 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Box
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 <Col
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeAvatarTitleDescriptionContainer}
 >
 <Flex
 gap={2}
 align='center'
 {showBadge ? (
 <Flex
 align='center'
 gap={3}
 elementDescriptor={descriptors.planDetailBadgeContainer}
 sx={t => ({
 paddingInlineEnd: t.space.$10,
 })}
 >
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 {!!subscription && (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 colorScheme='secondary'
 />
 )}
 </Flex>
 ) : null}
 {plan.avatarUrl ? (
 <Avatar
 boxElementDescriptor={descriptors.planDetailAvatar}
 size={_ => 40}
 title={plan.name}
 initials={plan.name[0]}
 rounded={false}
 imageUrl={plan.avatarUrl}
 sx={t => ({
 marginBlockEnd: t.space.$3,
 })}
 />
 ) : null}
 <Col
 gap={1}
 elementDescriptor={descriptors.planDetailTitleDescriptionContainer}
 >
 <Heading
 elementDescriptor={descriptors.planDetailTitle}
Expand All@@ -391,37 +438,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 >
 {plan.name}
 </Heading>
 {showBadge ? (
 <Flex elementDescriptor={descriptors.planDetailBadgeContainer}>
 {subscription?.status === 'active' || (isImplicitlyActiveOrUpcoming && subscriptions.length === 0) ? (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__activePlan')}
 colorScheme={'secondary'}
 />
 ) : (
 <Badge
 elementDescriptor={descriptors.planDetailBadge}
 localizationKey={localizationKeys('badge__upcomingPlan')}
 colorScheme={'primary'}
 />
 )}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 >
 {plan.description}
 </Text>
 ) : null}
 </Flex>
 {plan.description ? (
 <Text
 elementDescriptor={descriptors.planDetailDescription}
 variant='subtitle'
 colorScheme='secondary'
 sx={t => ({
 marginTop: t.space.$1,
 })}
 >
 {plan.description}
 </Text>
 ) : null}
 </Box>
 </Col>
 </Col>

 <Flex
 elementDescriptor={descriptors.planDetailFeeContainer}
Expand All@@ -439,9 +466,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 colorScheme='body'
 >
 {plan.currencySymbol}
 {(subscription && subscription.planPeriod === 'annual') || planPeriod === 'annual'
 ? plan.annualMonthlyAmountFormatted
 : plan.amountFormatted}
 {getPlanFee}
 </Text>
 <Text
 elementDescriptor={descriptors.planDetailFeePeriod}
Expand All@@ -459,7 +484,7 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 </>
 </Flex>

 {!subscription || (subscription.planPeriod === 'month' && plan.annualMonthlyAmount > 0) ? (
 {plan.annualMonthlyAmount > 0 ? (
 <Box
 elementDescriptor={descriptors.planDetailPeriodToggle}
 sx={t => ({
Expand All@@ -473,15 +498,17 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>((props, ref) => {
 label={localizationKeys('commerce.billedAnnually')}
 />
 </Box>
 ) : null}

 {!!subscription && (
 ) : (
 <Text
 elementDescriptor={descriptors.planDetailCaption}
 variant={'caption'}
 localizationKey={captionForSubscription(subscription)}
 elementDescriptor={descriptors.pricingTableCardFeePeriodNotice}
 variant='caption'
 colorScheme='secondary'
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 marginTop: t.space.$3,
 })}
 />
Expand Down

7 changes: 4 additions & 3 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,7 @@ function Card(props: CardProps) {
 clerk.__internal_openPlanDetails({
 plan,
 subscriberType,
 planPeriod,
initialPlanPeriod: planPeriod,
 portalRoot,
 });
 };
Expand DownExpand Up@@ -414,10 +414,11 @@ const CardHeader = React.forwardRef<HTMLDivElement, CardHeaderProps>((props, ref
 localizationKey={
 plan.isDefault ? localizationKeys('commerce.alwaysFree') : localizationKeys('commerce.billedMonthlyOnly')
 }
 sx={{
 sx={t => ({
 justifySelf: 'flex-start',
 alignSelf: 'center',
 }}
 marginTop: t.space.$1,
 })}
 />
 )}
 </Box>
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/contexts/components/Plans.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -339,13 +339,14 @@ export const usePlansContext = () => {
 appearance,
 newSubscriptionRedirectUrl,
 }: HandleSelectPlanProps) => {
 const subscription = activeOrUpcomingSubscription(plan);
 const subscription = activeOrUpcomingSubscriptionWithPlanPeriod(plan, planPeriod);

 const portalRoot = getClosestProfileScrollBox(mode, event);

 if (subscription && subscription.planPeriod === planPeriod && !subscription.canceledAt) {
 clerk.__internal_openPlanDetails({
 plan,
 initialPlanPeriod: planPeriod,
 subscriberType,
 onSubscriptionCancel: () => {
 revalidateAll();
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,11 +288,12 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'pricingTableMatrixFooter',

 'planDetailHeader',
 'planDetailAvatarBadgeContainer',
 'planDetailAvatar',
 'planDetailBadgeAvatarTitleDescriptionContainer',
 'planDetailBadgeContainer',
 'planDetailBadge',
 'planDetailTitle',
 'planDetailTitleDescriptionContainer',
 'planDetailDescription',
 'planDetailAction',
 'planDetailFeeContainer',
Expand Down

3 changes: 2 additions & 1 deletion
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -421,11 +421,12 @@ export type ElementsConfig = {
 pricingTableMatrixFooter: WithOptions;

 planDetailHeader: WithOptions;
 planDetailAvatarBadgeContainer: WithOptions;
 planDetailAvatar: WithOptions;
 planDetailBadgeAvatarTitleDescriptionContainer: WithOptions;
 planDetailBadgeContainer: WithOptions;
 planDetailBadge: WithOptions;
 planDetailTitle: WithOptions;
 planDetailTitleDescriptionContainer: WithOptions;
 planDetailDescription: WithOptions;
 planDetailAction: WithOptions;
 planDetailFeeContainer: WithOptions;
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1641,7 +1641,7 @@ export type __internal_PlanDetailsProps = {
 appearance?: PlanDetailTheme;
 plan?: CommercePlanResource;
 subscriberType?: CommerceSubscriberType;
planPeriod?: CommerceSubscriptionPlanPeriod;
initialPlanPeriod?: CommerceSubscriptionPlanPeriod;
 onSubscriptionCancel?: () => void;
 portalId?: string;
 portalRoot?: PortalRoot;
Expand Down