Skip to content
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

fix(clerk-js): Conditionally render avatar #5348

Merged
merged 3 commits into from
Mar 13, 2025
Merged

fix(clerk-js): Conditionally render avatar #5348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30fdd43
fix(clerk-js): Conditionally render avatar
alexcarpenter Mar 13, 2025
fd463e8
Create purple-lamps-beg.md
alexcarpenter Mar 13, 2025
13d2959
Update PlanCard.tsx
alexcarpenter Mar 13, 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
6 changes: 6 additions & 0 deletions .changeset/purple-lamps-beg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Conditionally render the avatar and badge components within PlanCard.
95 changes: 56 additions & 39 deletions packages/clerk-js/src/ui/components/PricingTable/PlanCard.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,24 @@ interface PlanCardProps {

export function PlanCard(props: PlanCardProps) {
const { plan, period, setPeriod, onSelect, props: pricingTableProps, isCompact = false } = props;
const {
id,
slug,
name,
description,
avatarUrl,
features,
isActiveForPayer,
hasBaseFee,
currencySymbol,
amountFormatted,
annualMonthlyAmountFormatted,
} = plan;
const { ctaPosition = 'top', collapseFeatures = false } = pricingTableProps;
const [showAllFeatures, setShowAllFeatures] = React.useState(false);
const totalFeatures = plan.features.length;
const totalFeatures = features.length;
const hasFeatures = totalFeatures > 0;
const canToggleFeatures = isCompact && totalFeatures > 3;
const isActivePlan = plan.isActiveForPayer;
const prefersReducedMotion = usePrefersReducedMotion();
const { animations: appearanceAnimations } = useAppearance().parsedLayout;
const planCardFeePeriodNoticeAnimation: ThemableCssProp = t => ({
Expand All @@ -54,9 +66,9 @@ export function PlanCard(props: PlanCardProps) {

return (
<Box
key={plan.id}
key={id}
elementDescriptor={[descriptors.planCard, isCompact ? descriptors.planCardCompact : descriptors.planCardDefault]}
elementId={descriptors.planCard.setId(plan.slug)}
elementId={descriptors.planCard.setId(slug)}
sx={t => ({
display: 'flex',
flexDirection: 'column',
Expand All @@ -79,44 +91,49 @@ export function PlanCard(props: PlanCardProps) {
padding: isCompact ? t.space.$3 : t.space.$4,
})}
>
<Flex
elementDescriptor={descriptors.planCardAvatarContainer}
align='start'
justify='between'
sx={{ width: '100%' }}
>
<Avatar
boxElementDescriptor={descriptors.planCardAvatar}
size={_ => 40}
title={plan.name}
initials={plan.name[0]}
rounded={false}
imageUrl={plan.avatarUrl}
/>
{isActivePlan ? (
<Badge
localizationKey={localizationKeys('badge__currentPlan')}
colorScheme='secondary'
/>
) : null}
</Flex>
{avatarUrl || isActiveForPayer ? (
<Box
elementDescriptor={descriptors.planCardAvatarBadgeContainer}
sx={t => ({
display: 'flex',
alignItems: 'start',
justifyContent: 'space-between',
gap: t.space.$3,
marginBlockEnd: t.space.$3,
})}
>
{avatarUrl ? (
<Avatar
boxElementDescriptor={descriptors.planCardAvatar}
size={_ => 40}
title={name}
initials={name[0]}
rounded={false}
imageUrl={avatarUrl}
/>
) : null}
{isActiveForPayer ? (
<Badge
localizationKey={localizationKeys('badge__currentPlan')}
colorScheme='secondary'
/>
) : null}
</Box>
) : null}
<Heading
elementDescriptor={descriptors.planCardTitle}
as='h2'
textVariant={isCompact ? 'h3' : 'h2'}
sx={t => ({
marginTop: t.space.$3,
})}
>
{plan.name}
{name}
</Heading>
{!isCompact && plan.description ? (
{!isCompact && description ? (
<Text
elementDescriptor={descriptors.planCardDescription}
variant='subtitle'
colorScheme='secondary'
>
{plan.description}
{description}
</Text>
) : null}
<Flex
Expand All @@ -128,15 +145,15 @@ export function PlanCard(props: PlanCardProps) {
columnGap: t.space.$1x5,
})}
>
{plan.hasBaseFee ? (
{hasBaseFee ? (
<>
<Text
elementDescriptor={descriptors.planCardFee}
variant={isCompact ? 'h2' : 'h1'}
colorScheme='body'
>
{plan.currencySymbol}
{period === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}
{currencySymbol}
{period === 'month' ? amountFormatted : annualMonthlyAmountFormatted}
</Text>
<Text
elementDescriptor={descriptors.planCardFeePeriod}
Expand Down Expand Up @@ -202,7 +219,7 @@ export function PlanCard(props: PlanCardProps) {
/>
)}
</Flex>
{plan.hasBaseFee ? (
{hasBaseFee ? (
<Box
elementDescriptor={descriptors.planCardPeriodToggle}
sx={t => ({
Expand Down Expand Up @@ -246,7 +263,7 @@ export function PlanCard(props: PlanCardProps) {
rowGap: isCompact ? t.space.$2 : t.space.$3,
})}
>
{plan.features.slice(0, showAllFeatures ? totalFeatures : 3).map(feature => (
{features.slice(0, showAllFeatures ? totalFeatures : 3).map(feature => (
<Box
elementDescriptor={descriptors.planCardFeaturesListItem}
elementId={descriptors.planCardFeaturesListItem.setId(feature.slug)}
Expand Down Expand Up @@ -302,10 +319,10 @@ export function PlanCard(props: PlanCardProps) {
<Button
block
textVariant={isCompact ? 'buttonSmall' : 'buttonLarge'}
variant={isActivePlan ? 'bordered' : 'solid'}
colorScheme={isActivePlan ? 'secondary' : 'primary'}
variant={isCompact || isActiveForPayer ? 'bordered' : 'solid'}
colorScheme={isCompact || isActiveForPayer ? 'secondary' : 'primary'}
localizationKey={
isActivePlan
isActiveForPayer
? localizationKeys('__experimental_commerce.manageMembership')
: localizationKeys('__experimental_commerce.getStarted')
}
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/customizables/elementDescriptors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'planCardHeader',
'planCardTitle',
'planCardDescription',
'planCardAvatarContainer',
'planCardAvatarBadgeContainer',
'planCardAvatar',
'planCardFeatures',
'planCardFeaturesList',
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/appearance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ export type ElementsConfig = {
planCardDefault: WithOptions;
planCardCompact: WithOptions;
planCardHeader: WithOptions;
planCardAvatarContainer: WithOptions;
planCardAvatarBadgeContainer: WithOptions;
planCardAvatar: WithOptions;
planCardTitle: WithOptions;
planCardDescription: WithOptions;
Expand Down