refactor(clerk-js): Add localization support to commerce components#5390

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
alexcarpenter merged 6 commits into from
Mar 18, 2025
Merged

refactor(clerk-js): Add localization support to commerce components #5390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
43d7295
refactor(clerk-js): Add localization support to commerce components
alexcarpenter Mar 18, 2025
dfcbfe6
add changeset
alexcarpenter Mar 18, 2025
aed0b08
use string | LocalizationKey approach
alexcarpenter Mar 18, 2025
3640d41
remove
alexcarpenter Mar 18, 2025
6561d78
remove optional
alexcarpenter Mar 18, 2025
0b1a31f
Update PlanCard.tsx
alexcarpenter Mar 18, 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/chilled-garlics-knock.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Add support for localizationKeys within commerce components.
39 changes: 22 additions & 17 deletions packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

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

Expand DownExpand Up@@ -98,30 +98,35 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
>
<LineItems.Root>
<LineItems.Group variant='secondary'>
<LineItems.Title>Total paid</LineItems.Title>
<LineItems.Description>
{checkout.invoice
? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
: '–'}
</LineItems.Description>
{/* TODO(@COMMERCE): needs localization */}
<LineItems.Title title='Total paid' />
<LineItems.Description
text={
checkout.invoice
? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
: '–'
}
/>
</LineItems.Group>
<LineItems.Group variant='secondary'>
{/* TODO(@COMMERCE): needs localization */}
<LineItems.Title>Payment method</LineItems.Title>
<LineItems.Description>
{checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'}
</LineItems.Description>
<LineItems.Title title='Payment method' />
<LineItems.Description
text={
checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'
}
/>
</LineItems.Group>
<LineItems.Group variant='tertiary'>
{/* TODO(@COMMERCE): needs localization */}
<LineItems.Title>Invoice ID</LineItems.Title>
<LineItems.Description>{checkout.invoice ? checkout.invoice.id : '–'}</LineItems.Description>
<LineItems.Title title='Invoice ID' />
<LineItems.Description text={checkout.invoice ? checkout.invoice.id : '–'} />
</LineItems.Group>
</LineItems.Root>
<Button onClick={handleClose}>
{/* TODO(@COMMERCE): needs localization */}
Continue
</Button>
<Button
onClick={handleClose}
localizationKey={localizationKeys('formButtonPrimary')}
/>
</Drawer.Footer>
</>
);
Expand Down
42 changes: 19 additions & 23 deletions packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,40 +40,36 @@ export const CheckoutForm = ({
>
<LineItems.Root>
<LineItems.Group>
<LineItems.Title>{plan.name}</LineItems.Title>
<LineItems.Title title={plan.name} />
{/* TODO(@Commerce): needs localization */}
<LineItems.Description suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}>
{plan.currencySymbol}
{planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}
</LineItems.Description>
<LineItems.Description
text={`${plan.currencySymbol} ${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}
/>
</LineItems.Group>
<LineItems.Group
borderTop
variant='tertiary'
>
{/* TODO(@Commerce): needs localization */}
<LineItems.Title>Subtotal</LineItems.Title>
<LineItems.Description>
{totals.subtotal.currencySymbol}
{totals.subtotal.amountFormatted}
</LineItems.Description>
<LineItems.Title title='Subtotal' />
<LineItems.Description text={`${totals.subtotal.currencySymbol} ${totals.subtotal.amountFormatted}`} />
</LineItems.Group>
<LineItems.Group variant='tertiary'>
{/* TODO(@Commerce): needs localization */}
<LineItems.Title>Tax</LineItems.Title>
<LineItems.Description>
{totals.taxTotal.currencySymbol}
{totals.taxTotal.amountFormatted}
</LineItems.Description>
<LineItems.Title title='Tax' />
<LineItems.Description text={`${totals.taxTotal.currencySymbol} ${totals.taxTotal.amountFormatted}`} />
</LineItems.Group>
<LineItems.Group borderTop>
{/* TODO(@Commerce): needs localization */}
<LineItems.Title>Total{totals.totalDueNow ? ' Due Today' : ''}</LineItems.Title>
<LineItems.Description>
{totals.totalDueNow
? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
: `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`}
</LineItems.Description>
<LineItems.Title title={`Total${totals.totalDueNow ? ' Due Today' : ''}`} />
<LineItems.Description
text={`${
totals.totalDueNow
? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
: `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`
}`}
/>
</LineItems.Group>
</LineItems.Root>
</Box>
Expand DownExpand Up@@ -201,7 +197,7 @@ const CheckoutFormElements = ({
onOpenChange={setOpenAccountFundsDropDown}
>
{/* TODO(@Commerce): needs localization */}
<Disclosure.Trigger>Account Funds</Disclosure.Trigger>
<Disclosure.Trigger text='Account Funds' />
<Disclosure.Content>
<Col gap={3}>
<PaymentSourceMethods
Expand All@@ -222,7 +218,7 @@ const CheckoutFormElements = ({
onOpenChange={setOpenAddNewSourceDropDown}
>
{/* TODO(@Commerce): needs localization */}
<Disclosure.Trigger>Add a New Payment Source</Disclosure.Trigger>
<Disclosure.Trigger text='Add a New Payment Source' />
<Disclosure.Content>
<StripePaymentMethods
totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
Expand Down
12 changes: 10 additions & 2 deletions packages/clerk-js/src/ui/components/PricingTable/PlanCard.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -325,8 +325,16 @@ export const PlanCardHeader = React.forwardRef<HTMLDivElement, PlanCardHeaderPro
value={planPeriod}
onChange={value => setPlanPeriod(value as PlanPeriod)}
>
<SegmentedControl.Button value='month'>Monthly</SegmentedControl.Button>
<SegmentedControl.Button value='annual'>Annually</SegmentedControl.Button>
<SegmentedControl.Button
value='month'
// TODO(@Commerce): needs localization
text='Monthly'
Comment thread
alexcarpenter marked this conversation as resolved.
/>
<SegmentedControl.Button
value='annual'
// TODO(@Commerce): needs localization
text='Annually'
Comment thread
alexcarpenter marked this conversation as resolved.
/>
</SegmentedControl.Root>
</Box>
) : null}
Expand Down
9 changes: 5 additions & 4 deletions packages/clerk-js/src/ui/elements/Disclosure.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import * as React from 'react';

import { Box, descriptors, Icon, SimpleButton, useAppearance } from '../customizables';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Icon, SimpleButton, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { ChevronDown } from '../icons';
import type { ThemableCssProp } from '../styledSystem';
Expand DownExpand Up@@ -72,10 +73,10 @@ Root.displayName = 'Disclosure.Root';
* -----------------------------------------------------------------------------------------------*/

interface TriggerProps {
children: React.ReactNode;
text: string | LocalizationKey;
}

const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children }, ref) => {
const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ text }, ref) => {
const context = React.useContext(DisclosureContext);
if (!context) {
throw new Error('Disclosure.Trigger must be used within Disclosure.Root');
Expand All@@ -99,7 +100,7 @@ const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children },
zIndex: 2,
})}
>
{children}
<Span localizationKey={text} />
<Icon
icon={ChevronDown}
colorScheme='neutral'
Expand Down
11 changes: 7 additions & 4 deletions packages/clerk-js/src/ui/elements/Drawer.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
import * as React from 'react';

import { transitionDurationValues, transitionTiming } from '../../ui/foundations/transitions';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Flex, Heading, Icon, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { useScrollLock } from '../hooks/useScrollLock';
Expand DownExpand Up@@ -263,7 +264,7 @@ Overlay.displayName = 'Drawer.Content';
* -----------------------------------------------------------------------------------------------*/

interface HeaderProps {
title?: string;
title?: string | LocalizationKey;
children?: React.ReactNode;
sx?: ThemableCssProp;
}
Expand DownExpand Up@@ -295,15 +296,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>(({ title, children,
{title ? (
<>
<Heading
localizationKey={title}
as='h2'
elementDescriptor={descriptors.drawerTitle}
textVariant='h2'
sx={{
alignSelf: 'center',
}}
>
{title}
</Heading>
/>
<Close />
</>
) : (
Expand DownExpand Up@@ -416,6 +416,9 @@ interface ConfirmationProps {
onOpenChange: (open: boolean) => void;
children: React.ReactNode;
actionsSlot: React.ReactNode;
/**
* @see https://floating-ui.com/docs/userole
*/
Comment thread
alexcarpenter marked this conversation as resolved.
roleProps?: UseRoleProps;
}

Expand Down
43 changes: 17 additions & 26 deletions packages/clerk-js/src/ui/elements/LineItems.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import * as React from 'react';

import type { LocalizationKey } from '../customizables';
import { Box, Dd, descriptors, Dl, Dt, Span } from '../customizables';
import { common } from '../styledSystem';

Expand DownExpand Up@@ -76,11 +77,11 @@ function Group({ children, borderTop = false, variant = 'primary' }: GroupProps)
* -----------------------------------------------------------------------------------------------*/

interface TitleProps {
children: React.ReactNode;
description?: React.ReactNode;
title: string | LocalizationKey;
description?: string | LocalizationKey;
}

function Title({ children, description }: TitleProps) {
function Title({ title, description }: TitleProps) {
const context = React.useContext(GroupContext);
if (!context) {
throw new Error('LineItems.Title must be used within LineItems.Group');
Expand All@@ -98,17 +99,16 @@ function Title({ children, description }: TitleProps) {
...common.textVariants(t)[textVariant],
})}
>
{children}
<Span localizationKey={title} />
{description ? (
<Span
localizationKey={description}
elementDescriptor={descriptors.lineItemsTitleDescription}
sx={t => ({
fontSize: t.fontSizes.$sm,
color: t.colors.$colorTextSecondary,
})}
>
{description}
</Span>
/>
) : null}
</Dt>
);
Expand All@@ -119,18 +119,12 @@ function Title({ children, description }: TitleProps) {
* -----------------------------------------------------------------------------------------------*/

interface DescriptionProps {
children: React.ReactNode;
/**
* Render a piece of text before the description text.
*/
prefix?: React.ReactNode;
/**
* Render a note below the description text.
*/
suffix?: React.ReactNode;
text: string | LocalizationKey;
prefix?: string | LocalizationKey;
suffix?: string | LocalizationKey;
}

function Description({ children, prefix, suffix }: DescriptionProps) {
function Description({ text, prefix, suffix }: DescriptionProps) {
const context = React.useContext(GroupContext);
if (!context) {
throw new Error('LineItems.Description must be used within LineItems.Group');
Expand All@@ -157,34 +151,31 @@ function Description({ children, prefix, suffix }: DescriptionProps) {
>
{prefix ? (
<Span
localizationKey={prefix}
elementDescriptor={descriptors.lineItemsDescriptionPrefix}
sx={t => ({
color: t.colors.$colorTextSecondary,
...common.textVariants(t).caption,
})}
>
{prefix}
</Span>
/>
) : null}
<Span
localizationKey={text}
elementDescriptor={descriptors.lineItemsDescriptionText}
sx={t => ({
...common.textVariants(t).body,
})}
>
{children}
</Span>
/>
</Span>
{suffix ? (
<Span
localizationKey={suffix}
elementDescriptor={descriptors.lineItemsDescriptionSuffix}
sx={t => ({
color: t.colors.$colorTextSecondary,
...common.textVariants(t).caption,
})}
>
{suffix}
</Span>
/>
) : null}
</Dd>
);
Expand Down
10 changes: 5 additions & 5 deletions packages/clerk-js/src/ui/elements/SegmentedControl.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Composite, CompositeItem } from '@floating-ui/react';
import React, { createContext, useContext, useState } from 'react';

import type { LocalizationKey } from '../customizables';
import { descriptors, Flex, SimpleButton } from '../customizables';

/* -------------------------------------------------------------------------------------------------
Expand DownExpand Up@@ -83,11 +84,11 @@ Root.displayName = 'SegmentedControl.Root';
* -----------------------------------------------------------------------------------------------*/

interface ButtonProps {
children: React.ReactNode;
text: string | LocalizationKey;
value: string;
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, value }, ref) => {
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ text, value }, ref) => {
const { currentValue, onValueChange } = useSegmentedControlContext();
const isSelected = value === currentValue;

Expand All@@ -98,6 +99,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
<SimpleButton
ref={ref}
{...compProps}
localizationKey={text}
elementDescriptor={descriptors.segmentedControlButton}
variant='unstyled'
role='radio'
Expand All@@ -118,9 +120,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
zIndex: 2,
},
})}
>
{children}
</SimpleButton>
/>
);
}}
/>
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
refactor(clerk-js): Add localization support to commerce components#5390

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 6 commits into

from

Mar 18, 2025
 Merged


refactor(clerk-js): Add localization support to commerce components
#5390
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
43d7295

refactor(clerk-js): Add localization support to commerce components


alexcarpenter Mar 18, 2025
dfcbfe6

add changeset


alexcarpenter Mar 18, 2025
aed0b08

use string | LocalizationKey approach


alexcarpenter Mar 18, 2025
3640d41

remove


alexcarpenter Mar 18, 2025
6561d78

remove optional


alexcarpenter Mar 18, 2025
0b1a31f

Update PlanCard.tsx


alexcarpenter Mar 18, 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/chilled-garlics-knock.md

View file


Open in desktop

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

Add support for localizationKeys within commerce components.

39 changes: 22 additions & 17 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

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

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

Expand DownExpand Up@@ -98,30 +98,35 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
 >
 <LineItems.Root>
 <LineItems.Group variant='secondary'>
 <LineItems.Title>Total paid</LineItems.Title>
 <LineItems.Description>
 {checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'}
 </LineItems.Description>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title title='Total paid' />
 <LineItems.Description
 text={
 checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='secondary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Payment method</LineItems.Title>
 <LineItems.Description>
 {checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'}
 </LineItems.Description>
 <LineItems.Title title='Payment method' />
 <LineItems.Description
 text={
 checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Invoice ID</LineItems.Title>
 <LineItems.Description>{checkout.invoice ? checkout.invoice.id : '–'}</LineItems.Description>
 <LineItems.Title title='Invoice ID' />
 <LineItems.Description text={checkout.invoice ? checkout.invoice.id : '–'} />
 </LineItems.Group>
 </LineItems.Root>
 <Button onClick={handleClose}>
{/* TODO(@COMMERCE): needs localization */}
Continue
</Button>
 <Button
onClick={handleClose}
localizationKey={localizationKeys('formButtonPrimary')}
/>
 </Drawer.Footer>
 </>
 );
Expand Down

42 changes: 19 additions & 23 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,40 +40,36 @@ export const CheckoutForm = ({
 >
 <LineItems.Root>
 <LineItems.Group>
 <LineItems.Title>{plan.name}</LineItems.Title>
 <LineItems.Title title={plan.name} />
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Description suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}>
{plan.currencySymbol}
{planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}
</LineItems.Description>
 <LineItems.Description
text={`${plan.currencySymbol} ${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}
/>
 </LineItems.Group>
 <LineItems.Group
 borderTop
 variant='tertiary'
 >
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Subtotal</LineItems.Title>
 <LineItems.Description>
 {totals.subtotal.currencySymbol}
 {totals.subtotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Subtotal' />
 <LineItems.Description text={`${totals.subtotal.currencySymbol} ${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Tax</LineItems.Title>
 <LineItems.Description>
 {totals.taxTotal.currencySymbol}
 {totals.taxTotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Tax' />
 <LineItems.Description text={`${totals.taxTotal.currencySymbol} ${totals.taxTotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group borderTop>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Total{totals.totalDueNow ? ' Due Today' : ''}</LineItems.Title>
 <LineItems.Description>
 {totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`}
 </LineItems.Description>
 <LineItems.Title title={`Total${totals.totalDueNow ? ' Due Today' : ''}`} />
 <LineItems.Description
 text={`${
 totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`
 }`}
 />
 </LineItems.Group>
 </LineItems.Root>
 </Box>
Expand DownExpand Up@@ -201,7 +197,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAccountFundsDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Account Funds</Disclosure.Trigger>
 <Disclosure.Trigger text='Account Funds' />
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
Expand All@@ -222,7 +218,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAddNewSourceDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Add a New Payment Source</Disclosure.Trigger>
 <Disclosure.Trigger text='Add a New Payment Source' />
 <Disclosure.Content>
 <StripePaymentMethods
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
Expand Down

12 changes: 10 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PlanCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -325,8 +325,16 @@ export const PlanCardHeader = React.forwardRef<HTMLDivElement, PlanCardHeaderPro
 value={planPeriod}
 onChange={value => setPlanPeriod(value as PlanPeriod)}
 >
 <SegmentedControl.Button value='month'>Monthly</SegmentedControl.Button>
 <SegmentedControl.Button value='annual'>Annually</SegmentedControl.Button>
 <SegmentedControl.Button
 value='month'
 // TODO(@Commerce): needs localization
 text='Monthly'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 <SegmentedControl.Button
 value='annual'
 // TODO(@Commerce): needs localization
 text='Annually'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 </SegmentedControl.Root>
 </Box>
 ) : null}
Expand Down

9 changes: 5 additions & 4 deletions
packages/clerk-js/src/ui/elements/Disclosure.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import * as React from 'react';

import { Box, descriptors, Icon, SimpleButton, useAppearance } from '../customizables';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Icon, SimpleButton, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { ChevronDown } from '../icons';
import type { ThemableCssProp } from '../styledSystem';
Expand DownExpand Up@@ -72,10 +73,10 @@ Root.displayName = 'Disclosure.Root';
 * -----------------------------------------------------------------------------------------------*/

interface TriggerProps {
children: React.ReactNode;
text: string | LocalizationKey;
}

const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children }, ref) => {
const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ text }, ref) => {
 const context = React.useContext(DisclosureContext);
 if (!context) {
 throw new Error('Disclosure.Trigger must be used within Disclosure.Root');
Expand All@@ -99,7 +100,7 @@ const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children },
 zIndex: 2,
 })}
 >
{children}
<Span localizationKey={text} />
 <Icon
 icon={ChevronDown}
 colorScheme='neutral'
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/elements/Drawer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
import * as React from 'react';

import { transitionDurationValues, transitionTiming } from '../../ui/foundations/transitions';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Flex, Heading, Icon, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { useScrollLock } from '../hooks/useScrollLock';
Expand DownExpand Up@@ -263,7 +264,7 @@ Overlay.displayName = 'Drawer.Content';
 * -----------------------------------------------------------------------------------------------*/

interface HeaderProps {
 title?: string;
 title?: string | LocalizationKey;
 children?: React.ReactNode;
 sx?: ThemableCssProp;
}
Expand DownExpand Up@@ -295,15 +296,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>(({ title, children,
 {title ? (
 <>
 <Heading
 localizationKey={title}
 as='h2'
 elementDescriptor={descriptors.drawerTitle}
 textVariant='h2'
 sx={{
 alignSelf: 'center',
 }}
 >
 {title}
 </Heading>
 />
 <Close />
 </>
 ) : (
Expand DownExpand Up@@ -416,6 +416,9 @@ interface ConfirmationProps {
 onOpenChange: (open: boolean) => void;
 children: React.ReactNode;
 actionsSlot: React.ReactNode;
 /**
 * @see https://floating-ui.com/docs/userole
 */
Comment thread
alexcarpenter marked this conversation as resolved.

 roleProps?: UseRoleProps;
}

Expand Down

43 changes: 17 additions & 26 deletions
packages/clerk-js/src/ui/elements/LineItems.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import * as React from 'react';

import type { LocalizationKey } from '../customizables';
import { Box, Dd, descriptors, Dl, Dt, Span } from '../customizables';
import { common } from '../styledSystem';

Expand DownExpand Up@@ -76,11 +77,11 @@ function Group({ children, borderTop = false, variant = 'primary' }: GroupProps)
 * -----------------------------------------------------------------------------------------------*/

interface TitleProps {
children: React.ReactNode;
 description?: React.ReactNode;
title: string | LocalizationKey;
 description?: string | LocalizationKey;
}

function Title({ children, description }: TitleProps) {
function Title({ title, description }: TitleProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Title must be used within LineItems.Group');
Expand All@@ -98,17 +99,16 @@ function Title({ children, description }: TitleProps) {
 ...common.textVariants(t)[textVariant],
 })}
 >
{children}
<Span localizationKey={title} />
 {description ? (
 <Span
 localizationKey={description}
 elementDescriptor={descriptors.lineItemsTitleDescription}
 sx={t => ({
 fontSize: t.fontSizes.$sm,
 color: t.colors.$colorTextSecondary,
 })}
 >
 {description}
 </Span>
 />
 ) : null}
 </Dt>
 );
Expand All@@ -119,18 +119,12 @@ function Title({ children, description }: TitleProps) {
 * -----------------------------------------------------------------------------------------------*/

interface DescriptionProps {
 children: React.ReactNode;
 /**
 * Render a piece of text before the description text.
 */
 prefix?: React.ReactNode;
 /**
 * Render a note below the description text.
 */
 suffix?: React.ReactNode;
 text: string | LocalizationKey;
 prefix?: string | LocalizationKey;
 suffix?: string | LocalizationKey;
}

function Description({ children, prefix, suffix }: DescriptionProps) {
function Description({ text, prefix, suffix }: DescriptionProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Description must be used within LineItems.Group');
Expand All@@ -157,34 +151,31 @@ function Description({ children, prefix, suffix }: DescriptionProps) {
 >
 {prefix ? (
 <Span
 localizationKey={prefix}
 elementDescriptor={descriptors.lineItemsDescriptionPrefix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {prefix}
 </Span>
 />
 ) : null}
 <Span
 localizationKey={text}
 elementDescriptor={descriptors.lineItemsDescriptionText}
 sx={t => ({
 ...common.textVariants(t).body,
 })}
 >
 {children}
 </Span>
 />
 </Span>
 {suffix ? (
 <Span
 localizationKey={suffix}
 elementDescriptor={descriptors.lineItemsDescriptionSuffix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {suffix}
 </Span>
 />
 ) : null}
 </Dd>
 );
Expand Down

10 changes: 5 additions & 5 deletions
packages/clerk-js/src/ui/elements/SegmentedControl.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Composite, CompositeItem } from '@floating-ui/react';
import React, { createContext, useContext, useState } from 'react';

import type { LocalizationKey } from '../customizables';
import { descriptors, Flex, SimpleButton } from '../customizables';

/* -------------------------------------------------------------------------------------------------
Expand DownExpand Up@@ -83,11 +84,11 @@ Root.displayName = 'SegmentedControl.Root';
 * -----------------------------------------------------------------------------------------------*/

interface ButtonProps {
children: React.ReactNode;
text: string | LocalizationKey;
 value: string;
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, value }, ref) => {
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ text, value }, ref) => {
 const { currentValue, onValueChange } = useSegmentedControlContext();
 const isSelected = value === currentValue;

Expand All@@ -98,6 +99,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 <SimpleButton
 ref={ref}
 {...compProps}
 localizationKey={text}
 elementDescriptor={descriptors.segmentedControlButton}
 variant='unstyled'
 role='radio'
Expand All@@ -118,9 +120,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 zIndex: 2,
 },
 })}
 >
 {children}
 </SimpleButton>
 />
 );
 }}
 />
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
refactor(clerk-js): Add localization support to commerce components#5390

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 6 commits into

from

Mar 18, 2025
 Merged


refactor(clerk-js): Add localization support to commerce components
#5390
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
43d7295

refactor(clerk-js): Add localization support to commerce components


alexcarpenter Mar 18, 2025
dfcbfe6

add changeset


alexcarpenter Mar 18, 2025
aed0b08

use string | LocalizationKey approach


alexcarpenter Mar 18, 2025
3640d41

remove


alexcarpenter Mar 18, 2025
6561d78

remove optional


alexcarpenter Mar 18, 2025
0b1a31f

Update PlanCard.tsx


alexcarpenter Mar 18, 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/chilled-garlics-knock.md

View file


Open in desktop

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

Add support for localizationKeys within commerce components.

39 changes: 22 additions & 17 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

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

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

Expand DownExpand Up@@ -98,30 +98,35 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
 >
 <LineItems.Root>
 <LineItems.Group variant='secondary'>
 <LineItems.Title>Total paid</LineItems.Title>
 <LineItems.Description>
 {checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'}
 </LineItems.Description>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title title='Total paid' />
 <LineItems.Description
 text={
 checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='secondary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Payment method</LineItems.Title>
 <LineItems.Description>
 {checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'}
 </LineItems.Description>
 <LineItems.Title title='Payment method' />
 <LineItems.Description
 text={
 checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Invoice ID</LineItems.Title>
 <LineItems.Description>{checkout.invoice ? checkout.invoice.id : '–'}</LineItems.Description>
 <LineItems.Title title='Invoice ID' />
 <LineItems.Description text={checkout.invoice ? checkout.invoice.id : '–'} />
 </LineItems.Group>
 </LineItems.Root>
 <Button onClick={handleClose}>
{/* TODO(@COMMERCE): needs localization */}
Continue
</Button>
 <Button
onClick={handleClose}
localizationKey={localizationKeys('formButtonPrimary')}
/>
 </Drawer.Footer>
 </>
 );
Expand Down

42 changes: 19 additions & 23 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,40 +40,36 @@ export const CheckoutForm = ({
 >
 <LineItems.Root>
 <LineItems.Group>
 <LineItems.Title>{plan.name}</LineItems.Title>
 <LineItems.Title title={plan.name} />
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Description suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}>
{plan.currencySymbol}
{planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}
</LineItems.Description>
 <LineItems.Description
text={`${plan.currencySymbol} ${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}
/>
 </LineItems.Group>
 <LineItems.Group
 borderTop
 variant='tertiary'
 >
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Subtotal</LineItems.Title>
 <LineItems.Description>
 {totals.subtotal.currencySymbol}
 {totals.subtotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Subtotal' />
 <LineItems.Description text={`${totals.subtotal.currencySymbol} ${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Tax</LineItems.Title>
 <LineItems.Description>
 {totals.taxTotal.currencySymbol}
 {totals.taxTotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Tax' />
 <LineItems.Description text={`${totals.taxTotal.currencySymbol} ${totals.taxTotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group borderTop>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Total{totals.totalDueNow ? ' Due Today' : ''}</LineItems.Title>
 <LineItems.Description>
 {totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`}
 </LineItems.Description>
 <LineItems.Title title={`Total${totals.totalDueNow ? ' Due Today' : ''}`} />
 <LineItems.Description
 text={`${
 totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`
 }`}
 />
 </LineItems.Group>
 </LineItems.Root>
 </Box>
Expand DownExpand Up@@ -201,7 +197,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAccountFundsDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Account Funds</Disclosure.Trigger>
 <Disclosure.Trigger text='Account Funds' />
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
Expand All@@ -222,7 +218,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAddNewSourceDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Add a New Payment Source</Disclosure.Trigger>
 <Disclosure.Trigger text='Add a New Payment Source' />
 <Disclosure.Content>
 <StripePaymentMethods
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
Expand Down

12 changes: 10 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PlanCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -325,8 +325,16 @@ export const PlanCardHeader = React.forwardRef<HTMLDivElement, PlanCardHeaderPro
 value={planPeriod}
 onChange={value => setPlanPeriod(value as PlanPeriod)}
 >
 <SegmentedControl.Button value='month'>Monthly</SegmentedControl.Button>
 <SegmentedControl.Button value='annual'>Annually</SegmentedControl.Button>
 <SegmentedControl.Button
 value='month'
 // TODO(@Commerce): needs localization
 text='Monthly'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 <SegmentedControl.Button
 value='annual'
 // TODO(@Commerce): needs localization
 text='Annually'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 </SegmentedControl.Root>
 </Box>
 ) : null}
Expand Down

9 changes: 5 additions & 4 deletions
packages/clerk-js/src/ui/elements/Disclosure.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import * as React from 'react';

import { Box, descriptors, Icon, SimpleButton, useAppearance } from '../customizables';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Icon, SimpleButton, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { ChevronDown } from '../icons';
import type { ThemableCssProp } from '../styledSystem';
Expand DownExpand Up@@ -72,10 +73,10 @@ Root.displayName = 'Disclosure.Root';
 * -----------------------------------------------------------------------------------------------*/

interface TriggerProps {
children: React.ReactNode;
text: string | LocalizationKey;
}

const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children }, ref) => {
const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ text }, ref) => {
 const context = React.useContext(DisclosureContext);
 if (!context) {
 throw new Error('Disclosure.Trigger must be used within Disclosure.Root');
Expand All@@ -99,7 +100,7 @@ const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children },
 zIndex: 2,
 })}
 >
{children}
<Span localizationKey={text} />
 <Icon
 icon={ChevronDown}
 colorScheme='neutral'
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/elements/Drawer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
import * as React from 'react';

import { transitionDurationValues, transitionTiming } from '../../ui/foundations/transitions';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Flex, Heading, Icon, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { useScrollLock } from '../hooks/useScrollLock';
Expand DownExpand Up@@ -263,7 +264,7 @@ Overlay.displayName = 'Drawer.Content';
 * -----------------------------------------------------------------------------------------------*/

interface HeaderProps {
 title?: string;
 title?: string | LocalizationKey;
 children?: React.ReactNode;
 sx?: ThemableCssProp;
}
Expand DownExpand Up@@ -295,15 +296,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>(({ title, children,
 {title ? (
 <>
 <Heading
 localizationKey={title}
 as='h2'
 elementDescriptor={descriptors.drawerTitle}
 textVariant='h2'
 sx={{
 alignSelf: 'center',
 }}
 >
 {title}
 </Heading>
 />
 <Close />
 </>
 ) : (
Expand DownExpand Up@@ -416,6 +416,9 @@ interface ConfirmationProps {
 onOpenChange: (open: boolean) => void;
 children: React.ReactNode;
 actionsSlot: React.ReactNode;
 /**
 * @see https://floating-ui.com/docs/userole
 */
Comment thread
alexcarpenter marked this conversation as resolved.

 roleProps?: UseRoleProps;
}

Expand Down

43 changes: 17 additions & 26 deletions
packages/clerk-js/src/ui/elements/LineItems.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import * as React from 'react';

import type { LocalizationKey } from '../customizables';
import { Box, Dd, descriptors, Dl, Dt, Span } from '../customizables';
import { common } from '../styledSystem';

Expand DownExpand Up@@ -76,11 +77,11 @@ function Group({ children, borderTop = false, variant = 'primary' }: GroupProps)
 * -----------------------------------------------------------------------------------------------*/

interface TitleProps {
children: React.ReactNode;
 description?: React.ReactNode;
title: string | LocalizationKey;
 description?: string | LocalizationKey;
}

function Title({ children, description }: TitleProps) {
function Title({ title, description }: TitleProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Title must be used within LineItems.Group');
Expand All@@ -98,17 +99,16 @@ function Title({ children, description }: TitleProps) {
 ...common.textVariants(t)[textVariant],
 })}
 >
{children}
<Span localizationKey={title} />
 {description ? (
 <Span
 localizationKey={description}
 elementDescriptor={descriptors.lineItemsTitleDescription}
 sx={t => ({
 fontSize: t.fontSizes.$sm,
 color: t.colors.$colorTextSecondary,
 })}
 >
 {description}
 </Span>
 />
 ) : null}
 </Dt>
 );
Expand All@@ -119,18 +119,12 @@ function Title({ children, description }: TitleProps) {
 * -----------------------------------------------------------------------------------------------*/

interface DescriptionProps {
 children: React.ReactNode;
 /**
 * Render a piece of text before the description text.
 */
 prefix?: React.ReactNode;
 /**
 * Render a note below the description text.
 */
 suffix?: React.ReactNode;
 text: string | LocalizationKey;
 prefix?: string | LocalizationKey;
 suffix?: string | LocalizationKey;
}

function Description({ children, prefix, suffix }: DescriptionProps) {
function Description({ text, prefix, suffix }: DescriptionProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Description must be used within LineItems.Group');
Expand All@@ -157,34 +151,31 @@ function Description({ children, prefix, suffix }: DescriptionProps) {
 >
 {prefix ? (
 <Span
 localizationKey={prefix}
 elementDescriptor={descriptors.lineItemsDescriptionPrefix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {prefix}
 </Span>
 />
 ) : null}
 <Span
 localizationKey={text}
 elementDescriptor={descriptors.lineItemsDescriptionText}
 sx={t => ({
 ...common.textVariants(t).body,
 })}
 >
 {children}
 </Span>
 />
 </Span>
 {suffix ? (
 <Span
 localizationKey={suffix}
 elementDescriptor={descriptors.lineItemsDescriptionSuffix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {suffix}
 </Span>
 />
 ) : null}
 </Dd>
 );
Expand Down

10 changes: 5 additions & 5 deletions
packages/clerk-js/src/ui/elements/SegmentedControl.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Composite, CompositeItem } from '@floating-ui/react';
import React, { createContext, useContext, useState } from 'react';

import type { LocalizationKey } from '../customizables';
import { descriptors, Flex, SimpleButton } from '../customizables';

/* -------------------------------------------------------------------------------------------------
Expand DownExpand Up@@ -83,11 +84,11 @@ Root.displayName = 'SegmentedControl.Root';
 * -----------------------------------------------------------------------------------------------*/

interface ButtonProps {
children: React.ReactNode;
text: string | LocalizationKey;
 value: string;
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, value }, ref) => {
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ text, value }, ref) => {
 const { currentValue, onValueChange } = useSegmentedControlContext();
 const isSelected = value === currentValue;

Expand All@@ -98,6 +99,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 <SimpleButton
 ref={ref}
 {...compProps}
 localizationKey={text}
 elementDescriptor={descriptors.segmentedControlButton}
 variant='unstyled'
 role='radio'
Expand All@@ -118,9 +120,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 zIndex: 2,
 },
 })}
 >
 {children}
 </SimpleButton>
 />
 );
 }}
 />
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
refactor(clerk-js): Add localization support to commerce components#5390

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 6 commits into

from

Mar 18, 2025
 Merged


refactor(clerk-js): Add localization support to commerce components
#5390
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
43d7295

refactor(clerk-js): Add localization support to commerce components


alexcarpenter Mar 18, 2025
dfcbfe6

add changeset


alexcarpenter Mar 18, 2025
aed0b08

use string | LocalizationKey approach


alexcarpenter Mar 18, 2025
3640d41

remove


alexcarpenter Mar 18, 2025
6561d78

remove optional


alexcarpenter Mar 18, 2025
0b1a31f

Update PlanCard.tsx


alexcarpenter Mar 18, 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/chilled-garlics-knock.md

View file


Open in desktop

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

Add support for localizationKeys within commerce components.

39 changes: 22 additions & 17 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

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

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

Expand DownExpand Up@@ -98,30 +98,35 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
 >
 <LineItems.Root>
 <LineItems.Group variant='secondary'>
 <LineItems.Title>Total paid</LineItems.Title>
 <LineItems.Description>
 {checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'}
 </LineItems.Description>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title title='Total paid' />
 <LineItems.Description
 text={
 checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='secondary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Payment method</LineItems.Title>
 <LineItems.Description>
 {checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'}
 </LineItems.Description>
 <LineItems.Title title='Payment method' />
 <LineItems.Description
 text={
 checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Invoice ID</LineItems.Title>
 <LineItems.Description>{checkout.invoice ? checkout.invoice.id : '–'}</LineItems.Description>
 <LineItems.Title title='Invoice ID' />
 <LineItems.Description text={checkout.invoice ? checkout.invoice.id : '–'} />
 </LineItems.Group>
 </LineItems.Root>
 <Button onClick={handleClose}>
{/* TODO(@COMMERCE): needs localization */}
Continue
</Button>
 <Button
onClick={handleClose}
localizationKey={localizationKeys('formButtonPrimary')}
/>
 </Drawer.Footer>
 </>
 );
Expand Down

42 changes: 19 additions & 23 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,40 +40,36 @@ export const CheckoutForm = ({
 >
 <LineItems.Root>
 <LineItems.Group>
 <LineItems.Title>{plan.name}</LineItems.Title>
 <LineItems.Title title={plan.name} />
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Description suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}>
{plan.currencySymbol}
{planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}
</LineItems.Description>
 <LineItems.Description
text={`${plan.currencySymbol} ${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}
/>
 </LineItems.Group>
 <LineItems.Group
 borderTop
 variant='tertiary'
 >
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Subtotal</LineItems.Title>
 <LineItems.Description>
 {totals.subtotal.currencySymbol}
 {totals.subtotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Subtotal' />
 <LineItems.Description text={`${totals.subtotal.currencySymbol} ${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Tax</LineItems.Title>
 <LineItems.Description>
 {totals.taxTotal.currencySymbol}
 {totals.taxTotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Tax' />
 <LineItems.Description text={`${totals.taxTotal.currencySymbol} ${totals.taxTotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group borderTop>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Total{totals.totalDueNow ? ' Due Today' : ''}</LineItems.Title>
 <LineItems.Description>
 {totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`}
 </LineItems.Description>
 <LineItems.Title title={`Total${totals.totalDueNow ? ' Due Today' : ''}`} />
 <LineItems.Description
 text={`${
 totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`
 }`}
 />
 </LineItems.Group>
 </LineItems.Root>
 </Box>
Expand DownExpand Up@@ -201,7 +197,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAccountFundsDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Account Funds</Disclosure.Trigger>
 <Disclosure.Trigger text='Account Funds' />
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
Expand All@@ -222,7 +218,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAddNewSourceDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Add a New Payment Source</Disclosure.Trigger>
 <Disclosure.Trigger text='Add a New Payment Source' />
 <Disclosure.Content>
 <StripePaymentMethods
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
Expand Down

12 changes: 10 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PlanCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -325,8 +325,16 @@ export const PlanCardHeader = React.forwardRef<HTMLDivElement, PlanCardHeaderPro
 value={planPeriod}
 onChange={value => setPlanPeriod(value as PlanPeriod)}
 >
 <SegmentedControl.Button value='month'>Monthly</SegmentedControl.Button>
 <SegmentedControl.Button value='annual'>Annually</SegmentedControl.Button>
 <SegmentedControl.Button
 value='month'
 // TODO(@Commerce): needs localization
 text='Monthly'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 <SegmentedControl.Button
 value='annual'
 // TODO(@Commerce): needs localization
 text='Annually'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 </SegmentedControl.Root>
 </Box>
 ) : null}
Expand Down

9 changes: 5 additions & 4 deletions
packages/clerk-js/src/ui/elements/Disclosure.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import * as React from 'react';

import { Box, descriptors, Icon, SimpleButton, useAppearance } from '../customizables';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Icon, SimpleButton, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { ChevronDown } from '../icons';
import type { ThemableCssProp } from '../styledSystem';
Expand DownExpand Up@@ -72,10 +73,10 @@ Root.displayName = 'Disclosure.Root';
 * -----------------------------------------------------------------------------------------------*/

interface TriggerProps {
children: React.ReactNode;
text: string | LocalizationKey;
}

const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children }, ref) => {
const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ text }, ref) => {
 const context = React.useContext(DisclosureContext);
 if (!context) {
 throw new Error('Disclosure.Trigger must be used within Disclosure.Root');
Expand All@@ -99,7 +100,7 @@ const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children },
 zIndex: 2,
 })}
 >
{children}
<Span localizationKey={text} />
 <Icon
 icon={ChevronDown}
 colorScheme='neutral'
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/elements/Drawer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
import * as React from 'react';

import { transitionDurationValues, transitionTiming } from '../../ui/foundations/transitions';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Flex, Heading, Icon, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { useScrollLock } from '../hooks/useScrollLock';
Expand DownExpand Up@@ -263,7 +264,7 @@ Overlay.displayName = 'Drawer.Content';
 * -----------------------------------------------------------------------------------------------*/

interface HeaderProps {
 title?: string;
 title?: string | LocalizationKey;
 children?: React.ReactNode;
 sx?: ThemableCssProp;
}
Expand DownExpand Up@@ -295,15 +296,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>(({ title, children,
 {title ? (
 <>
 <Heading
 localizationKey={title}
 as='h2'
 elementDescriptor={descriptors.drawerTitle}
 textVariant='h2'
 sx={{
 alignSelf: 'center',
 }}
 >
 {title}
 </Heading>
 />
 <Close />
 </>
 ) : (
Expand DownExpand Up@@ -416,6 +416,9 @@ interface ConfirmationProps {
 onOpenChange: (open: boolean) => void;
 children: React.ReactNode;
 actionsSlot: React.ReactNode;
 /**
 * @see https://floating-ui.com/docs/userole
 */
Comment thread
alexcarpenter marked this conversation as resolved.

 roleProps?: UseRoleProps;
}

Expand Down

43 changes: 17 additions & 26 deletions
packages/clerk-js/src/ui/elements/LineItems.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import * as React from 'react';

import type { LocalizationKey } from '../customizables';
import { Box, Dd, descriptors, Dl, Dt, Span } from '../customizables';
import { common } from '../styledSystem';

Expand DownExpand Up@@ -76,11 +77,11 @@ function Group({ children, borderTop = false, variant = 'primary' }: GroupProps)
 * -----------------------------------------------------------------------------------------------*/

interface TitleProps {
children: React.ReactNode;
 description?: React.ReactNode;
title: string | LocalizationKey;
 description?: string | LocalizationKey;
}

function Title({ children, description }: TitleProps) {
function Title({ title, description }: TitleProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Title must be used within LineItems.Group');
Expand All@@ -98,17 +99,16 @@ function Title({ children, description }: TitleProps) {
 ...common.textVariants(t)[textVariant],
 })}
 >
{children}
<Span localizationKey={title} />
 {description ? (
 <Span
 localizationKey={description}
 elementDescriptor={descriptors.lineItemsTitleDescription}
 sx={t => ({
 fontSize: t.fontSizes.$sm,
 color: t.colors.$colorTextSecondary,
 })}
 >
 {description}
 </Span>
 />
 ) : null}
 </Dt>
 );
Expand All@@ -119,18 +119,12 @@ function Title({ children, description }: TitleProps) {
 * -----------------------------------------------------------------------------------------------*/

interface DescriptionProps {
 children: React.ReactNode;
 /**
 * Render a piece of text before the description text.
 */
 prefix?: React.ReactNode;
 /**
 * Render a note below the description text.
 */
 suffix?: React.ReactNode;
 text: string | LocalizationKey;
 prefix?: string | LocalizationKey;
 suffix?: string | LocalizationKey;
}

function Description({ children, prefix, suffix }: DescriptionProps) {
function Description({ text, prefix, suffix }: DescriptionProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Description must be used within LineItems.Group');
Expand All@@ -157,34 +151,31 @@ function Description({ children, prefix, suffix }: DescriptionProps) {
 >
 {prefix ? (
 <Span
 localizationKey={prefix}
 elementDescriptor={descriptors.lineItemsDescriptionPrefix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {prefix}
 </Span>
 />
 ) : null}
 <Span
 localizationKey={text}
 elementDescriptor={descriptors.lineItemsDescriptionText}
 sx={t => ({
 ...common.textVariants(t).body,
 })}
 >
 {children}
 </Span>
 />
 </Span>
 {suffix ? (
 <Span
 localizationKey={suffix}
 elementDescriptor={descriptors.lineItemsDescriptionSuffix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {suffix}
 </Span>
 />
 ) : null}
 </Dd>
 );
Expand Down

10 changes: 5 additions & 5 deletions
packages/clerk-js/src/ui/elements/SegmentedControl.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Composite, CompositeItem } from '@floating-ui/react';
import React, { createContext, useContext, useState } from 'react';

import type { LocalizationKey } from '../customizables';
import { descriptors, Flex, SimpleButton } from '../customizables';

/* -------------------------------------------------------------------------------------------------
Expand DownExpand Up@@ -83,11 +84,11 @@ Root.displayName = 'SegmentedControl.Root';
 * -----------------------------------------------------------------------------------------------*/

interface ButtonProps {
children: React.ReactNode;
text: string | LocalizationKey;
 value: string;
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, value }, ref) => {
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ text, value }, ref) => {
 const { currentValue, onValueChange } = useSegmentedControlContext();
 const isSelected = value === currentValue;

Expand All@@ -98,6 +99,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 <SimpleButton
 ref={ref}
 {...compProps}
 localizationKey={text}
 elementDescriptor={descriptors.segmentedControlButton}
 variant='unstyled'
 role='radio'
Expand All@@ -118,9 +120,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 zIndex: 2,
 },
 })}
 >
 {children}
 </SimpleButton>
 />
 );
 }}
 />
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
refactor(clerk-js): Add localization support to commerce components#5390

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 6 commits into

from

Mar 18, 2025
 Merged


refactor(clerk-js): Add localization support to commerce components
#5390
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
43d7295

refactor(clerk-js): Add localization support to commerce components


alexcarpenter Mar 18, 2025
dfcbfe6

add changeset


alexcarpenter Mar 18, 2025
aed0b08

use string | LocalizationKey approach


alexcarpenter Mar 18, 2025
3640d41

remove


alexcarpenter Mar 18, 2025
6561d78

remove optional


alexcarpenter Mar 18, 2025
0b1a31f

Update PlanCard.tsx


alexcarpenter Mar 18, 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/chilled-garlics-knock.md

View file


Open in desktop

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

Add support for localizationKeys within commerce components.

39 changes: 22 additions & 17 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

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

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

Expand DownExpand Up@@ -98,30 +98,35 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
 >
 <LineItems.Root>
 <LineItems.Group variant='secondary'>
 <LineItems.Title>Total paid</LineItems.Title>
 <LineItems.Description>
 {checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'}
 </LineItems.Description>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title title='Total paid' />
 <LineItems.Description
 text={
 checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='secondary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Payment method</LineItems.Title>
 <LineItems.Description>
 {checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'}
 </LineItems.Description>
 <LineItems.Title title='Payment method' />
 <LineItems.Description
 text={
 checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Invoice ID</LineItems.Title>
 <LineItems.Description>{checkout.invoice ? checkout.invoice.id : '–'}</LineItems.Description>
 <LineItems.Title title='Invoice ID' />
 <LineItems.Description text={checkout.invoice ? checkout.invoice.id : '–'} />
 </LineItems.Group>
 </LineItems.Root>
 <Button onClick={handleClose}>
{/* TODO(@COMMERCE): needs localization */}
Continue
</Button>
 <Button
onClick={handleClose}
localizationKey={localizationKeys('formButtonPrimary')}
/>
 </Drawer.Footer>
 </>
 );
Expand Down

42 changes: 19 additions & 23 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,40 +40,36 @@ export const CheckoutForm = ({
 >
 <LineItems.Root>
 <LineItems.Group>
 <LineItems.Title>{plan.name}</LineItems.Title>
 <LineItems.Title title={plan.name} />
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Description suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}>
{plan.currencySymbol}
{planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}
</LineItems.Description>
 <LineItems.Description
text={`${plan.currencySymbol} ${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}
/>
 </LineItems.Group>
 <LineItems.Group
 borderTop
 variant='tertiary'
 >
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Subtotal</LineItems.Title>
 <LineItems.Description>
 {totals.subtotal.currencySymbol}
 {totals.subtotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Subtotal' />
 <LineItems.Description text={`${totals.subtotal.currencySymbol} ${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Tax</LineItems.Title>
 <LineItems.Description>
 {totals.taxTotal.currencySymbol}
 {totals.taxTotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Tax' />
 <LineItems.Description text={`${totals.taxTotal.currencySymbol} ${totals.taxTotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group borderTop>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Total{totals.totalDueNow ? ' Due Today' : ''}</LineItems.Title>
 <LineItems.Description>
 {totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`}
 </LineItems.Description>
 <LineItems.Title title={`Total${totals.totalDueNow ? ' Due Today' : ''}`} />
 <LineItems.Description
 text={`${
 totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`
 }`}
 />
 </LineItems.Group>
 </LineItems.Root>
 </Box>
Expand DownExpand Up@@ -201,7 +197,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAccountFundsDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Account Funds</Disclosure.Trigger>
 <Disclosure.Trigger text='Account Funds' />
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
Expand All@@ -222,7 +218,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAddNewSourceDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Add a New Payment Source</Disclosure.Trigger>
 <Disclosure.Trigger text='Add a New Payment Source' />
 <Disclosure.Content>
 <StripePaymentMethods
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
Expand Down

12 changes: 10 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PlanCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -325,8 +325,16 @@ export const PlanCardHeader = React.forwardRef<HTMLDivElement, PlanCardHeaderPro
 value={planPeriod}
 onChange={value => setPlanPeriod(value as PlanPeriod)}
 >
 <SegmentedControl.Button value='month'>Monthly</SegmentedControl.Button>
 <SegmentedControl.Button value='annual'>Annually</SegmentedControl.Button>
 <SegmentedControl.Button
 value='month'
 // TODO(@Commerce): needs localization
 text='Monthly'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 <SegmentedControl.Button
 value='annual'
 // TODO(@Commerce): needs localization
 text='Annually'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 </SegmentedControl.Root>
 </Box>
 ) : null}
Expand Down

9 changes: 5 additions & 4 deletions
packages/clerk-js/src/ui/elements/Disclosure.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import * as React from 'react';

import { Box, descriptors, Icon, SimpleButton, useAppearance } from '../customizables';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Icon, SimpleButton, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { ChevronDown } from '../icons';
import type { ThemableCssProp } from '../styledSystem';
Expand DownExpand Up@@ -72,10 +73,10 @@ Root.displayName = 'Disclosure.Root';
 * -----------------------------------------------------------------------------------------------*/

interface TriggerProps {
children: React.ReactNode;
text: string | LocalizationKey;
}

const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children }, ref) => {
const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ text }, ref) => {
 const context = React.useContext(DisclosureContext);
 if (!context) {
 throw new Error('Disclosure.Trigger must be used within Disclosure.Root');
Expand All@@ -99,7 +100,7 @@ const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children },
 zIndex: 2,
 })}
 >
{children}
<Span localizationKey={text} />
 <Icon
 icon={ChevronDown}
 colorScheme='neutral'
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/elements/Drawer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
import * as React from 'react';

import { transitionDurationValues, transitionTiming } from '../../ui/foundations/transitions';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Flex, Heading, Icon, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { useScrollLock } from '../hooks/useScrollLock';
Expand DownExpand Up@@ -263,7 +264,7 @@ Overlay.displayName = 'Drawer.Content';
 * -----------------------------------------------------------------------------------------------*/

interface HeaderProps {
 title?: string;
 title?: string | LocalizationKey;
 children?: React.ReactNode;
 sx?: ThemableCssProp;
}
Expand DownExpand Up@@ -295,15 +296,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>(({ title, children,
 {title ? (
 <>
 <Heading
 localizationKey={title}
 as='h2'
 elementDescriptor={descriptors.drawerTitle}
 textVariant='h2'
 sx={{
 alignSelf: 'center',
 }}
 >
 {title}
 </Heading>
 />
 <Close />
 </>
 ) : (
Expand DownExpand Up@@ -416,6 +416,9 @@ interface ConfirmationProps {
 onOpenChange: (open: boolean) => void;
 children: React.ReactNode;
 actionsSlot: React.ReactNode;
 /**
 * @see https://floating-ui.com/docs/userole
 */
Comment thread
alexcarpenter marked this conversation as resolved.

 roleProps?: UseRoleProps;
}

Expand Down

43 changes: 17 additions & 26 deletions
packages/clerk-js/src/ui/elements/LineItems.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import * as React from 'react';

import type { LocalizationKey } from '../customizables';
import { Box, Dd, descriptors, Dl, Dt, Span } from '../customizables';
import { common } from '../styledSystem';

Expand DownExpand Up@@ -76,11 +77,11 @@ function Group({ children, borderTop = false, variant = 'primary' }: GroupProps)
 * -----------------------------------------------------------------------------------------------*/

interface TitleProps {
children: React.ReactNode;
 description?: React.ReactNode;
title: string | LocalizationKey;
 description?: string | LocalizationKey;
}

function Title({ children, description }: TitleProps) {
function Title({ title, description }: TitleProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Title must be used within LineItems.Group');
Expand All@@ -98,17 +99,16 @@ function Title({ children, description }: TitleProps) {
 ...common.textVariants(t)[textVariant],
 })}
 >
{children}
<Span localizationKey={title} />
 {description ? (
 <Span
 localizationKey={description}
 elementDescriptor={descriptors.lineItemsTitleDescription}
 sx={t => ({
 fontSize: t.fontSizes.$sm,
 color: t.colors.$colorTextSecondary,
 })}
 >
 {description}
 </Span>
 />
 ) : null}
 </Dt>
 );
Expand All@@ -119,18 +119,12 @@ function Title({ children, description }: TitleProps) {
 * -----------------------------------------------------------------------------------------------*/

interface DescriptionProps {
 children: React.ReactNode;
 /**
 * Render a piece of text before the description text.
 */
 prefix?: React.ReactNode;
 /**
 * Render a note below the description text.
 */
 suffix?: React.ReactNode;
 text: string | LocalizationKey;
 prefix?: string | LocalizationKey;
 suffix?: string | LocalizationKey;
}

function Description({ children, prefix, suffix }: DescriptionProps) {
function Description({ text, prefix, suffix }: DescriptionProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Description must be used within LineItems.Group');
Expand All@@ -157,34 +151,31 @@ function Description({ children, prefix, suffix }: DescriptionProps) {
 >
 {prefix ? (
 <Span
 localizationKey={prefix}
 elementDescriptor={descriptors.lineItemsDescriptionPrefix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {prefix}
 </Span>
 />
 ) : null}
 <Span
 localizationKey={text}
 elementDescriptor={descriptors.lineItemsDescriptionText}
 sx={t => ({
 ...common.textVariants(t).body,
 })}
 >
 {children}
 </Span>
 />
 </Span>
 {suffix ? (
 <Span
 localizationKey={suffix}
 elementDescriptor={descriptors.lineItemsDescriptionSuffix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {suffix}
 </Span>
 />
 ) : null}
 </Dd>
 );
Expand Down

10 changes: 5 additions & 5 deletions
packages/clerk-js/src/ui/elements/SegmentedControl.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Composite, CompositeItem } from '@floating-ui/react';
import React, { createContext, useContext, useState } from 'react';

import type { LocalizationKey } from '../customizables';
import { descriptors, Flex, SimpleButton } from '../customizables';

/* -------------------------------------------------------------------------------------------------
Expand DownExpand Up@@ -83,11 +84,11 @@ Root.displayName = 'SegmentedControl.Root';
 * -----------------------------------------------------------------------------------------------*/

interface ButtonProps {
children: React.ReactNode;
text: string | LocalizationKey;
 value: string;
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, value }, ref) => {
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ text, value }, ref) => {
 const { currentValue, onValueChange } = useSegmentedControlContext();
 const isSelected = value === currentValue;

Expand All@@ -98,6 +99,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 <SimpleButton
 ref={ref}
 {...compProps}
 localizationKey={text}
 elementDescriptor={descriptors.segmentedControlButton}
 variant='unstyled'
 role='radio'
Expand All@@ -118,9 +120,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 zIndex: 2,
 },
 })}
 >
 {children}
 </SimpleButton>
 />
 );
 }}
 />
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
refactor(clerk-js): Add localization support to commerce components#5390

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 6 commits into

from

Mar 18, 2025
 Merged


refactor(clerk-js): Add localization support to commerce components
#5390
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
43d7295

refactor(clerk-js): Add localization support to commerce components


alexcarpenter Mar 18, 2025
dfcbfe6

add changeset


alexcarpenter Mar 18, 2025
aed0b08

use string | LocalizationKey approach


alexcarpenter Mar 18, 2025
3640d41

remove


alexcarpenter Mar 18, 2025
6561d78

remove optional


alexcarpenter Mar 18, 2025
0b1a31f

Update PlanCard.tsx


alexcarpenter Mar 18, 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/chilled-garlics-knock.md

View file


Open in desktop

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

Add support for localizationKeys within commerce components.

39 changes: 22 additions & 17 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

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

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

Expand DownExpand Up@@ -98,30 +98,35 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
 >
 <LineItems.Root>
 <LineItems.Group variant='secondary'>
 <LineItems.Title>Total paid</LineItems.Title>
 <LineItems.Description>
 {checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'}
 </LineItems.Description>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title title='Total paid' />
 <LineItems.Description
 text={
 checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='secondary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Payment method</LineItems.Title>
 <LineItems.Description>
 {checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'}
 </LineItems.Description>
 <LineItems.Title title='Payment method' />
 <LineItems.Description
 text={
 checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Invoice ID</LineItems.Title>
 <LineItems.Description>{checkout.invoice ? checkout.invoice.id : '–'}</LineItems.Description>
 <LineItems.Title title='Invoice ID' />
 <LineItems.Description text={checkout.invoice ? checkout.invoice.id : '–'} />
 </LineItems.Group>
 </LineItems.Root>
 <Button onClick={handleClose}>
{/* TODO(@COMMERCE): needs localization */}
Continue
</Button>
 <Button
onClick={handleClose}
localizationKey={localizationKeys('formButtonPrimary')}
/>
 </Drawer.Footer>
 </>
 );
Expand Down

42 changes: 19 additions & 23 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,40 +40,36 @@ export const CheckoutForm = ({
 >
 <LineItems.Root>
 <LineItems.Group>
 <LineItems.Title>{plan.name}</LineItems.Title>
 <LineItems.Title title={plan.name} />
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Description suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}>
{plan.currencySymbol}
{planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}
</LineItems.Description>
 <LineItems.Description
text={`${plan.currencySymbol} ${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}
/>
 </LineItems.Group>
 <LineItems.Group
 borderTop
 variant='tertiary'
 >
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Subtotal</LineItems.Title>
 <LineItems.Description>
 {totals.subtotal.currencySymbol}
 {totals.subtotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Subtotal' />
 <LineItems.Description text={`${totals.subtotal.currencySymbol} ${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Tax</LineItems.Title>
 <LineItems.Description>
 {totals.taxTotal.currencySymbol}
 {totals.taxTotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Tax' />
 <LineItems.Description text={`${totals.taxTotal.currencySymbol} ${totals.taxTotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group borderTop>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Total{totals.totalDueNow ? ' Due Today' : ''}</LineItems.Title>
 <LineItems.Description>
 {totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`}
 </LineItems.Description>
 <LineItems.Title title={`Total${totals.totalDueNow ? ' Due Today' : ''}`} />
 <LineItems.Description
 text={`${
 totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`
 }`}
 />
 </LineItems.Group>
 </LineItems.Root>
 </Box>
Expand DownExpand Up@@ -201,7 +197,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAccountFundsDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Account Funds</Disclosure.Trigger>
 <Disclosure.Trigger text='Account Funds' />
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
Expand All@@ -222,7 +218,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAddNewSourceDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Add a New Payment Source</Disclosure.Trigger>
 <Disclosure.Trigger text='Add a New Payment Source' />
 <Disclosure.Content>
 <StripePaymentMethods
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
Expand Down

12 changes: 10 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PlanCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -325,8 +325,16 @@ export const PlanCardHeader = React.forwardRef<HTMLDivElement, PlanCardHeaderPro
 value={planPeriod}
 onChange={value => setPlanPeriod(value as PlanPeriod)}
 >
 <SegmentedControl.Button value='month'>Monthly</SegmentedControl.Button>
 <SegmentedControl.Button value='annual'>Annually</SegmentedControl.Button>
 <SegmentedControl.Button
 value='month'
 // TODO(@Commerce): needs localization
 text='Monthly'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 <SegmentedControl.Button
 value='annual'
 // TODO(@Commerce): needs localization
 text='Annually'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 </SegmentedControl.Root>
 </Box>
 ) : null}
Expand Down

9 changes: 5 additions & 4 deletions
packages/clerk-js/src/ui/elements/Disclosure.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import * as React from 'react';

import { Box, descriptors, Icon, SimpleButton, useAppearance } from '../customizables';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Icon, SimpleButton, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { ChevronDown } from '../icons';
import type { ThemableCssProp } from '../styledSystem';
Expand DownExpand Up@@ -72,10 +73,10 @@ Root.displayName = 'Disclosure.Root';
 * -----------------------------------------------------------------------------------------------*/

interface TriggerProps {
children: React.ReactNode;
text: string | LocalizationKey;
}

const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children }, ref) => {
const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ text }, ref) => {
 const context = React.useContext(DisclosureContext);
 if (!context) {
 throw new Error('Disclosure.Trigger must be used within Disclosure.Root');
Expand All@@ -99,7 +100,7 @@ const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children },
 zIndex: 2,
 })}
 >
{children}
<Span localizationKey={text} />
 <Icon
 icon={ChevronDown}
 colorScheme='neutral'
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/elements/Drawer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
import * as React from 'react';

import { transitionDurationValues, transitionTiming } from '../../ui/foundations/transitions';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Flex, Heading, Icon, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { useScrollLock } from '../hooks/useScrollLock';
Expand DownExpand Up@@ -263,7 +264,7 @@ Overlay.displayName = 'Drawer.Content';
 * -----------------------------------------------------------------------------------------------*/

interface HeaderProps {
 title?: string;
 title?: string | LocalizationKey;
 children?: React.ReactNode;
 sx?: ThemableCssProp;
}
Expand DownExpand Up@@ -295,15 +296,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>(({ title, children,
 {title ? (
 <>
 <Heading
 localizationKey={title}
 as='h2'
 elementDescriptor={descriptors.drawerTitle}
 textVariant='h2'
 sx={{
 alignSelf: 'center',
 }}
 >
 {title}
 </Heading>
 />
 <Close />
 </>
 ) : (
Expand DownExpand Up@@ -416,6 +416,9 @@ interface ConfirmationProps {
 onOpenChange: (open: boolean) => void;
 children: React.ReactNode;
 actionsSlot: React.ReactNode;
 /**
 * @see https://floating-ui.com/docs/userole
 */
Comment thread
alexcarpenter marked this conversation as resolved.

 roleProps?: UseRoleProps;
}

Expand Down

43 changes: 17 additions & 26 deletions
packages/clerk-js/src/ui/elements/LineItems.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import * as React from 'react';

import type { LocalizationKey } from '../customizables';
import { Box, Dd, descriptors, Dl, Dt, Span } from '../customizables';
import { common } from '../styledSystem';

Expand DownExpand Up@@ -76,11 +77,11 @@ function Group({ children, borderTop = false, variant = 'primary' }: GroupProps)
 * -----------------------------------------------------------------------------------------------*/

interface TitleProps {
children: React.ReactNode;
 description?: React.ReactNode;
title: string | LocalizationKey;
 description?: string | LocalizationKey;
}

function Title({ children, description }: TitleProps) {
function Title({ title, description }: TitleProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Title must be used within LineItems.Group');
Expand All@@ -98,17 +99,16 @@ function Title({ children, description }: TitleProps) {
 ...common.textVariants(t)[textVariant],
 })}
 >
{children}
<Span localizationKey={title} />
 {description ? (
 <Span
 localizationKey={description}
 elementDescriptor={descriptors.lineItemsTitleDescription}
 sx={t => ({
 fontSize: t.fontSizes.$sm,
 color: t.colors.$colorTextSecondary,
 })}
 >
 {description}
 </Span>
 />
 ) : null}
 </Dt>
 );
Expand All@@ -119,18 +119,12 @@ function Title({ children, description }: TitleProps) {
 * -----------------------------------------------------------------------------------------------*/

interface DescriptionProps {
 children: React.ReactNode;
 /**
 * Render a piece of text before the description text.
 */
 prefix?: React.ReactNode;
 /**
 * Render a note below the description text.
 */
 suffix?: React.ReactNode;
 text: string | LocalizationKey;
 prefix?: string | LocalizationKey;
 suffix?: string | LocalizationKey;
}

function Description({ children, prefix, suffix }: DescriptionProps) {
function Description({ text, prefix, suffix }: DescriptionProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Description must be used within LineItems.Group');
Expand All@@ -157,34 +151,31 @@ function Description({ children, prefix, suffix }: DescriptionProps) {
 >
 {prefix ? (
 <Span
 localizationKey={prefix}
 elementDescriptor={descriptors.lineItemsDescriptionPrefix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {prefix}
 </Span>
 />
 ) : null}
 <Span
 localizationKey={text}
 elementDescriptor={descriptors.lineItemsDescriptionText}
 sx={t => ({
 ...common.textVariants(t).body,
 })}
 >
 {children}
 </Span>
 />
 </Span>
 {suffix ? (
 <Span
 localizationKey={suffix}
 elementDescriptor={descriptors.lineItemsDescriptionSuffix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {suffix}
 </Span>
 />
 ) : null}
 </Dd>
 );
Expand Down

10 changes: 5 additions & 5 deletions
packages/clerk-js/src/ui/elements/SegmentedControl.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Composite, CompositeItem } from '@floating-ui/react';
import React, { createContext, useContext, useState } from 'react';

import type { LocalizationKey } from '../customizables';
import { descriptors, Flex, SimpleButton } from '../customizables';

/* -------------------------------------------------------------------------------------------------
Expand DownExpand Up@@ -83,11 +84,11 @@ Root.displayName = 'SegmentedControl.Root';
 * -----------------------------------------------------------------------------------------------*/

interface ButtonProps {
children: React.ReactNode;
text: string | LocalizationKey;
 value: string;
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, value }, ref) => {
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ text, value }, ref) => {
 const { currentValue, onValueChange } = useSegmentedControlContext();
 const isSelected = value === currentValue;

Expand All@@ -98,6 +99,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 <SimpleButton
 ref={ref}
 {...compProps}
 localizationKey={text}
 elementDescriptor={descriptors.segmentedControlButton}
 variant='unstyled'
 role='radio'
Expand All@@ -118,9 +120,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 zIndex: 2,
 },
 })}
 >
 {children}
 </SimpleButton>
 />
 );
 }}
 />
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
refactor(clerk-js): Add localization support to commerce components#5390

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 6 commits into

from

Mar 18, 2025
 Merged


refactor(clerk-js): Add localization support to commerce components
#5390
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
43d7295

refactor(clerk-js): Add localization support to commerce components


alexcarpenter Mar 18, 2025
dfcbfe6

add changeset


alexcarpenter Mar 18, 2025
aed0b08

use string | LocalizationKey approach


alexcarpenter Mar 18, 2025
3640d41

remove


alexcarpenter Mar 18, 2025
6561d78

remove optional


alexcarpenter Mar 18, 2025
0b1a31f

Update PlanCard.tsx


alexcarpenter Mar 18, 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/chilled-garlics-knock.md

View file


Open in desktop

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

Add support for localizationKeys within commerce components.

39 changes: 22 additions & 17 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

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

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

Expand DownExpand Up@@ -98,30 +98,35 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
 >
 <LineItems.Root>
 <LineItems.Group variant='secondary'>
 <LineItems.Title>Total paid</LineItems.Title>
 <LineItems.Description>
 {checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'}
 </LineItems.Description>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title title='Total paid' />
 <LineItems.Description
 text={
 checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='secondary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Payment method</LineItems.Title>
 <LineItems.Description>
 {checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'}
 </LineItems.Description>
 <LineItems.Title title='Payment method' />
 <LineItems.Description
 text={
 checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Invoice ID</LineItems.Title>
 <LineItems.Description>{checkout.invoice ? checkout.invoice.id : '–'}</LineItems.Description>
 <LineItems.Title title='Invoice ID' />
 <LineItems.Description text={checkout.invoice ? checkout.invoice.id : '–'} />
 </LineItems.Group>
 </LineItems.Root>
 <Button onClick={handleClose}>
{/* TODO(@COMMERCE): needs localization */}
Continue
</Button>
 <Button
onClick={handleClose}
localizationKey={localizationKeys('formButtonPrimary')}
/>
 </Drawer.Footer>
 </>
 );
Expand Down

42 changes: 19 additions & 23 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,40 +40,36 @@ export const CheckoutForm = ({
 >
 <LineItems.Root>
 <LineItems.Group>
 <LineItems.Title>{plan.name}</LineItems.Title>
 <LineItems.Title title={plan.name} />
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Description suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}>
{plan.currencySymbol}
{planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}
</LineItems.Description>
 <LineItems.Description
text={`${plan.currencySymbol} ${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}
/>
 </LineItems.Group>
 <LineItems.Group
 borderTop
 variant='tertiary'
 >
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Subtotal</LineItems.Title>
 <LineItems.Description>
 {totals.subtotal.currencySymbol}
 {totals.subtotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Subtotal' />
 <LineItems.Description text={`${totals.subtotal.currencySymbol} ${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Tax</LineItems.Title>
 <LineItems.Description>
 {totals.taxTotal.currencySymbol}
 {totals.taxTotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Tax' />
 <LineItems.Description text={`${totals.taxTotal.currencySymbol} ${totals.taxTotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group borderTop>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Total{totals.totalDueNow ? ' Due Today' : ''}</LineItems.Title>
 <LineItems.Description>
 {totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`}
 </LineItems.Description>
 <LineItems.Title title={`Total${totals.totalDueNow ? ' Due Today' : ''}`} />
 <LineItems.Description
 text={`${
 totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`
 }`}
 />
 </LineItems.Group>
 </LineItems.Root>
 </Box>
Expand DownExpand Up@@ -201,7 +197,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAccountFundsDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Account Funds</Disclosure.Trigger>
 <Disclosure.Trigger text='Account Funds' />
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
Expand All@@ -222,7 +218,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAddNewSourceDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Add a New Payment Source</Disclosure.Trigger>
 <Disclosure.Trigger text='Add a New Payment Source' />
 <Disclosure.Content>
 <StripePaymentMethods
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
Expand Down

12 changes: 10 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PlanCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -325,8 +325,16 @@ export const PlanCardHeader = React.forwardRef<HTMLDivElement, PlanCardHeaderPro
 value={planPeriod}
 onChange={value => setPlanPeriod(value as PlanPeriod)}
 >
 <SegmentedControl.Button value='month'>Monthly</SegmentedControl.Button>
 <SegmentedControl.Button value='annual'>Annually</SegmentedControl.Button>
 <SegmentedControl.Button
 value='month'
 // TODO(@Commerce): needs localization
 text='Monthly'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 <SegmentedControl.Button
 value='annual'
 // TODO(@Commerce): needs localization
 text='Annually'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 </SegmentedControl.Root>
 </Box>
 ) : null}
Expand Down

9 changes: 5 additions & 4 deletions
packages/clerk-js/src/ui/elements/Disclosure.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import * as React from 'react';

import { Box, descriptors, Icon, SimpleButton, useAppearance } from '../customizables';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Icon, SimpleButton, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { ChevronDown } from '../icons';
import type { ThemableCssProp } from '../styledSystem';
Expand DownExpand Up@@ -72,10 +73,10 @@ Root.displayName = 'Disclosure.Root';
 * -----------------------------------------------------------------------------------------------*/

interface TriggerProps {
children: React.ReactNode;
text: string | LocalizationKey;
}

const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children }, ref) => {
const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ text }, ref) => {
 const context = React.useContext(DisclosureContext);
 if (!context) {
 throw new Error('Disclosure.Trigger must be used within Disclosure.Root');
Expand All@@ -99,7 +100,7 @@ const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children },
 zIndex: 2,
 })}
 >
{children}
<Span localizationKey={text} />
 <Icon
 icon={ChevronDown}
 colorScheme='neutral'
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/elements/Drawer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
import * as React from 'react';

import { transitionDurationValues, transitionTiming } from '../../ui/foundations/transitions';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Flex, Heading, Icon, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { useScrollLock } from '../hooks/useScrollLock';
Expand DownExpand Up@@ -263,7 +264,7 @@ Overlay.displayName = 'Drawer.Content';
 * -----------------------------------------------------------------------------------------------*/

interface HeaderProps {
 title?: string;
 title?: string | LocalizationKey;
 children?: React.ReactNode;
 sx?: ThemableCssProp;
}
Expand DownExpand Up@@ -295,15 +296,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>(({ title, children,
 {title ? (
 <>
 <Heading
 localizationKey={title}
 as='h2'
 elementDescriptor={descriptors.drawerTitle}
 textVariant='h2'
 sx={{
 alignSelf: 'center',
 }}
 >
 {title}
 </Heading>
 />
 <Close />
 </>
 ) : (
Expand DownExpand Up@@ -416,6 +416,9 @@ interface ConfirmationProps {
 onOpenChange: (open: boolean) => void;
 children: React.ReactNode;
 actionsSlot: React.ReactNode;
 /**
 * @see https://floating-ui.com/docs/userole
 */
Comment thread
alexcarpenter marked this conversation as resolved.

 roleProps?: UseRoleProps;
}

Expand Down

43 changes: 17 additions & 26 deletions
packages/clerk-js/src/ui/elements/LineItems.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import * as React from 'react';

import type { LocalizationKey } from '../customizables';
import { Box, Dd, descriptors, Dl, Dt, Span } from '../customizables';
import { common } from '../styledSystem';

Expand DownExpand Up@@ -76,11 +77,11 @@ function Group({ children, borderTop = false, variant = 'primary' }: GroupProps)
 * -----------------------------------------------------------------------------------------------*/

interface TitleProps {
children: React.ReactNode;
 description?: React.ReactNode;
title: string | LocalizationKey;
 description?: string | LocalizationKey;
}

function Title({ children, description }: TitleProps) {
function Title({ title, description }: TitleProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Title must be used within LineItems.Group');
Expand All@@ -98,17 +99,16 @@ function Title({ children, description }: TitleProps) {
 ...common.textVariants(t)[textVariant],
 })}
 >
{children}
<Span localizationKey={title} />
 {description ? (
 <Span
 localizationKey={description}
 elementDescriptor={descriptors.lineItemsTitleDescription}
 sx={t => ({
 fontSize: t.fontSizes.$sm,
 color: t.colors.$colorTextSecondary,
 })}
 >
 {description}
 </Span>
 />
 ) : null}
 </Dt>
 );
Expand All@@ -119,18 +119,12 @@ function Title({ children, description }: TitleProps) {
 * -----------------------------------------------------------------------------------------------*/

interface DescriptionProps {
 children: React.ReactNode;
 /**
 * Render a piece of text before the description text.
 */
 prefix?: React.ReactNode;
 /**
 * Render a note below the description text.
 */
 suffix?: React.ReactNode;
 text: string | LocalizationKey;
 prefix?: string | LocalizationKey;
 suffix?: string | LocalizationKey;
}

function Description({ children, prefix, suffix }: DescriptionProps) {
function Description({ text, prefix, suffix }: DescriptionProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Description must be used within LineItems.Group');
Expand All@@ -157,34 +151,31 @@ function Description({ children, prefix, suffix }: DescriptionProps) {
 >
 {prefix ? (
 <Span
 localizationKey={prefix}
 elementDescriptor={descriptors.lineItemsDescriptionPrefix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {prefix}
 </Span>
 />
 ) : null}
 <Span
 localizationKey={text}
 elementDescriptor={descriptors.lineItemsDescriptionText}
 sx={t => ({
 ...common.textVariants(t).body,
 })}
 >
 {children}
 </Span>
 />
 </Span>
 {suffix ? (
 <Span
 localizationKey={suffix}
 elementDescriptor={descriptors.lineItemsDescriptionSuffix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {suffix}
 </Span>
 />
 ) : null}
 </Dd>
 );
Expand Down

10 changes: 5 additions & 5 deletions
packages/clerk-js/src/ui/elements/SegmentedControl.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Composite, CompositeItem } from '@floating-ui/react';
import React, { createContext, useContext, useState } from 'react';

import type { LocalizationKey } from '../customizables';
import { descriptors, Flex, SimpleButton } from '../customizables';

/* -------------------------------------------------------------------------------------------------
Expand DownExpand Up@@ -83,11 +84,11 @@ Root.displayName = 'SegmentedControl.Root';
 * -----------------------------------------------------------------------------------------------*/

interface ButtonProps {
children: React.ReactNode;
text: string | LocalizationKey;
 value: string;
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, value }, ref) => {
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ text, value }, ref) => {
 const { currentValue, onValueChange } = useSegmentedControlContext();
 const isSelected = value === currentValue;

Expand All@@ -98,6 +99,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 <SimpleButton
 ref={ref}
 {...compProps}
 localizationKey={text}
 elementDescriptor={descriptors.segmentedControlButton}
 variant='unstyled'
 role='radio'
Expand All@@ -118,9 +120,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 zIndex: 2,
 },
 })}
 >
 {children}
 </SimpleButton>
 />
 );
 }}
 />
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
refactor(clerk-js): Add localization support to commerce components#5390

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 6 commits into

from

Mar 18, 2025
 Merged


refactor(clerk-js): Add localization support to commerce components
#5390
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
43d7295

refactor(clerk-js): Add localization support to commerce components


alexcarpenter Mar 18, 2025
dfcbfe6

add changeset


alexcarpenter Mar 18, 2025
aed0b08

use string | LocalizationKey approach


alexcarpenter Mar 18, 2025
3640d41

remove


alexcarpenter Mar 18, 2025
6561d78

remove optional


alexcarpenter Mar 18, 2025
0b1a31f

Update PlanCard.tsx


alexcarpenter Mar 18, 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/chilled-garlics-knock.md

View file


Open in desktop

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

Add support for localizationKeys within commerce components.

39 changes: 22 additions & 17 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx

View file


Open in desktop

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

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

Expand DownExpand Up@@ -98,30 +98,35 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
 >
 <LineItems.Root>
 <LineItems.Group variant='secondary'>
 <LineItems.Title>Total paid</LineItems.Title>
 <LineItems.Description>
 {checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'}
 </LineItems.Description>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title title='Total paid' />
 <LineItems.Description
 text={
 checkout.invoice
 ? `${checkout.invoice.totals.grandTotal.currencySymbol}${checkout.invoice.totals.grandTotal.amountFormatted}`
 : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='secondary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Payment method</LineItems.Title>
 <LineItems.Description>
 {checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'}
 </LineItems.Description>
 <LineItems.Title title='Payment method' />
 <LineItems.Description
 text={
 checkout.paymentSource ? `${checkout.paymentSource.cardType} ⋯ ${checkout.paymentSource.last4}` : '–'
 }
 />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@COMMERCE): needs localization */}
 <LineItems.Title>Invoice ID</LineItems.Title>
 <LineItems.Description>{checkout.invoice ? checkout.invoice.id : '–'}</LineItems.Description>
 <LineItems.Title title='Invoice ID' />
 <LineItems.Description text={checkout.invoice ? checkout.invoice.id : '–'} />
 </LineItems.Group>
 </LineItems.Root>
 <Button onClick={handleClose}>
{/* TODO(@COMMERCE): needs localization */}
Continue
</Button>
 <Button
onClick={handleClose}
localizationKey={localizationKeys('formButtonPrimary')}
/>
 </Drawer.Footer>
 </>
 );
Expand Down

42 changes: 19 additions & 23 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,40 +40,36 @@ export const CheckoutForm = ({
 >
 <LineItems.Root>
 <LineItems.Group>
 <LineItems.Title>{plan.name}</LineItems.Title>
 <LineItems.Title title={plan.name} />
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Description suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}>
{plan.currencySymbol}
{planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}
</LineItems.Description>
 <LineItems.Description
text={`${plan.currencySymbol} ${planPeriod === 'month' ? plan.amountFormatted : plan.annualMonthlyAmountFormatted}`}
suffix={`per month${planPeriod === 'annual' ? ', times 12 months' : ''}`}
/>
 </LineItems.Group>
 <LineItems.Group
 borderTop
 variant='tertiary'
 >
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Subtotal</LineItems.Title>
 <LineItems.Description>
 {totals.subtotal.currencySymbol}
 {totals.subtotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Subtotal' />
 <LineItems.Description text={`${totals.subtotal.currencySymbol} ${totals.subtotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group variant='tertiary'>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Tax</LineItems.Title>
 <LineItems.Description>
 {totals.taxTotal.currencySymbol}
 {totals.taxTotal.amountFormatted}
 </LineItems.Description>
 <LineItems.Title title='Tax' />
 <LineItems.Description text={`${totals.taxTotal.currencySymbol} ${totals.taxTotal.amountFormatted}`} />
 </LineItems.Group>
 <LineItems.Group borderTop>
 {/* TODO(@Commerce): needs localization */}
 <LineItems.Title>Total{totals.totalDueNow ? ' Due Today' : ''}</LineItems.Title>
 <LineItems.Description>
 {totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`}
 </LineItems.Description>
 <LineItems.Title title={`Total${totals.totalDueNow ? ' Due Today' : ''}`} />
 <LineItems.Description
 text={`${
 totals.totalDueNow
 ? `${totals.totalDueNow.currencySymbol}${totals.totalDueNow.amountFormatted}`
 : `${totals.grandTotal.currencySymbol}${totals.grandTotal.amountFormatted}`
 }`}
 />
 </LineItems.Group>
 </LineItems.Root>
 </Box>
Expand DownExpand Up@@ -201,7 +197,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAccountFundsDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Account Funds</Disclosure.Trigger>
 <Disclosure.Trigger text='Account Funds' />
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
Expand All@@ -222,7 +218,7 @@ const CheckoutFormElements = ({
 onOpenChange={setOpenAddNewSourceDropDown}
 >
 {/* TODO(@Commerce): needs localization */}
 <Disclosure.Trigger>Add a New Payment Source</Disclosure.Trigger>
 <Disclosure.Trigger text='Add a New Payment Source' />
 <Disclosure.Content>
 <StripePaymentMethods
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
Expand Down

12 changes: 10 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PlanCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -325,8 +325,16 @@ export const PlanCardHeader = React.forwardRef<HTMLDivElement, PlanCardHeaderPro
 value={planPeriod}
 onChange={value => setPlanPeriod(value as PlanPeriod)}
 >
 <SegmentedControl.Button value='month'>Monthly</SegmentedControl.Button>
 <SegmentedControl.Button value='annual'>Annually</SegmentedControl.Button>
 <SegmentedControl.Button
 value='month'
 // TODO(@Commerce): needs localization
 text='Monthly'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 <SegmentedControl.Button
 value='annual'
 // TODO(@Commerce): needs localization
 text='Annually'
Comment thread
alexcarpenter marked this conversation as resolved.

 />
 </SegmentedControl.Root>
 </Box>
 ) : null}
Expand Down

9 changes: 5 additions & 4 deletions
packages/clerk-js/src/ui/elements/Disclosure.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import * as React from 'react';

import { Box, descriptors, Icon, SimpleButton, useAppearance } from '../customizables';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Icon, SimpleButton, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { ChevronDown } from '../icons';
import type { ThemableCssProp } from '../styledSystem';
Expand DownExpand Up@@ -72,10 +73,10 @@ Root.displayName = 'Disclosure.Root';
 * -----------------------------------------------------------------------------------------------*/

interface TriggerProps {
children: React.ReactNode;
text: string | LocalizationKey;
}

const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children }, ref) => {
const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ text }, ref) => {
 const context = React.useContext(DisclosureContext);
 if (!context) {
 throw new Error('Disclosure.Trigger must be used within Disclosure.Root');
Expand All@@ -99,7 +100,7 @@ const Trigger = React.forwardRef<HTMLButtonElement, TriggerProps>(({ children },
 zIndex: 2,
 })}
 >
{children}
<Span localizationKey={text} />
 <Icon
 icon={ChevronDown}
 colorScheme='neutral'
Expand Down

11 changes: 7 additions & 4 deletions
packages/clerk-js/src/ui/elements/Drawer.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
import * as React from 'react';

import { transitionDurationValues, transitionTiming } from '../../ui/foundations/transitions';
import type { LocalizationKey } from '../customizables';
import { Box, descriptors, Flex, Heading, Icon, Span, useAppearance } from '../customizables';
import { usePrefersReducedMotion } from '../hooks';
import { useScrollLock } from '../hooks/useScrollLock';
Expand DownExpand Up@@ -263,7 +264,7 @@ Overlay.displayName = 'Drawer.Content';
 * -----------------------------------------------------------------------------------------------*/

interface HeaderProps {
 title?: string;
 title?: string | LocalizationKey;
 children?: React.ReactNode;
 sx?: ThemableCssProp;
}
Expand DownExpand Up@@ -295,15 +296,14 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>(({ title, children,
 {title ? (
 <>
 <Heading
 localizationKey={title}
 as='h2'
 elementDescriptor={descriptors.drawerTitle}
 textVariant='h2'
 sx={{
 alignSelf: 'center',
 }}
 >
 {title}
 </Heading>
 />
 <Close />
 </>
 ) : (
Expand DownExpand Up@@ -416,6 +416,9 @@ interface ConfirmationProps {
 onOpenChange: (open: boolean) => void;
 children: React.ReactNode;
 actionsSlot: React.ReactNode;
 /**
 * @see https://floating-ui.com/docs/userole
 */
Comment thread
alexcarpenter marked this conversation as resolved.

 roleProps?: UseRoleProps;
}

Expand Down

43 changes: 17 additions & 26 deletions
packages/clerk-js/src/ui/elements/LineItems.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import * as React from 'react';

import type { LocalizationKey } from '../customizables';
import { Box, Dd, descriptors, Dl, Dt, Span } from '../customizables';
import { common } from '../styledSystem';

Expand DownExpand Up@@ -76,11 +77,11 @@ function Group({ children, borderTop = false, variant = 'primary' }: GroupProps)
 * -----------------------------------------------------------------------------------------------*/

interface TitleProps {
children: React.ReactNode;
 description?: React.ReactNode;
title: string | LocalizationKey;
 description?: string | LocalizationKey;
}

function Title({ children, description }: TitleProps) {
function Title({ title, description }: TitleProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Title must be used within LineItems.Group');
Expand All@@ -98,17 +99,16 @@ function Title({ children, description }: TitleProps) {
 ...common.textVariants(t)[textVariant],
 })}
 >
{children}
<Span localizationKey={title} />
 {description ? (
 <Span
 localizationKey={description}
 elementDescriptor={descriptors.lineItemsTitleDescription}
 sx={t => ({
 fontSize: t.fontSizes.$sm,
 color: t.colors.$colorTextSecondary,
 })}
 >
 {description}
 </Span>
 />
 ) : null}
 </Dt>
 );
Expand All@@ -119,18 +119,12 @@ function Title({ children, description }: TitleProps) {
 * -----------------------------------------------------------------------------------------------*/

interface DescriptionProps {
 children: React.ReactNode;
 /**
 * Render a piece of text before the description text.
 */
 prefix?: React.ReactNode;
 /**
 * Render a note below the description text.
 */
 suffix?: React.ReactNode;
 text: string | LocalizationKey;
 prefix?: string | LocalizationKey;
 suffix?: string | LocalizationKey;
}

function Description({ children, prefix, suffix }: DescriptionProps) {
function Description({ text, prefix, suffix }: DescriptionProps) {
 const context = React.useContext(GroupContext);
 if (!context) {
 throw new Error('LineItems.Description must be used within LineItems.Group');
Expand All@@ -157,34 +151,31 @@ function Description({ children, prefix, suffix }: DescriptionProps) {
 >
 {prefix ? (
 <Span
 localizationKey={prefix}
 elementDescriptor={descriptors.lineItemsDescriptionPrefix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {prefix}
 </Span>
 />
 ) : null}
 <Span
 localizationKey={text}
 elementDescriptor={descriptors.lineItemsDescriptionText}
 sx={t => ({
 ...common.textVariants(t).body,
 })}
 >
 {children}
 </Span>
 />
 </Span>
 {suffix ? (
 <Span
 localizationKey={suffix}
 elementDescriptor={descriptors.lineItemsDescriptionSuffix}
 sx={t => ({
 color: t.colors.$colorTextSecondary,
 ...common.textVariants(t).caption,
 })}
 >
 {suffix}
 </Span>
 />
 ) : null}
 </Dd>
 );
Expand Down

10 changes: 5 additions & 5 deletions
packages/clerk-js/src/ui/elements/SegmentedControl.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Composite, CompositeItem } from '@floating-ui/react';
import React, { createContext, useContext, useState } from 'react';

import type { LocalizationKey } from '../customizables';
import { descriptors, Flex, SimpleButton } from '../customizables';

/* -------------------------------------------------------------------------------------------------
Expand DownExpand Up@@ -83,11 +84,11 @@ Root.displayName = 'SegmentedControl.Root';
 * -----------------------------------------------------------------------------------------------*/

interface ButtonProps {
children: React.ReactNode;
text: string | LocalizationKey;
 value: string;
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, value }, ref) => {
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ text, value }, ref) => {
 const { currentValue, onValueChange } = useSegmentedControlContext();
 const isSelected = value === currentValue;

Expand All@@ -98,6 +99,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 <SimpleButton
 ref={ref}
 {...compProps}
 localizationKey={text}
 elementDescriptor={descriptors.segmentedControlButton}
 variant='unstyled'
 role='radio'
Expand All@@ -118,9 +120,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(({ children, val
 zIndex: 2,
 },
 })}
 >
 {children}
 </SimpleButton>
 />
 );
 }}
 />
Expand Down