Skip to content

feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources#5570

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
aeliox merged 4 commits into from
Apr 13, 2025
Merged

feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources #5570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e67596
add PaymentSourceRow
aeliox Apr 9, 2025
7439e25
bundle size bump
aeliox Apr 9, 2025
fd0ba8d
add/update descriptors
alexcarpenter Apr 11, 2025
1ef5a36
Merge branch 'main' into keiran/payment-source-row
alexcarpenter Apr 11, 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/tall-clocks-call.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Add `PaymentSourceRow` for displaying payment sources
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
{ "path": "./dist/keylessPrompt*.js", "maxSize": "5.9KB" },
{ "path": "./dist/pricingTable*.js", "maxSize": "5KB" },
{ "path": "./dist/checkout*.js", "maxSize": "3KB" },
{ "path": "./dist/paymentSources*.js", "maxSize": "8.1KB" },
{ "path": "./dist/paymentSources*.js", "maxSize": "8.2KB" },
{ "path": "./dist/up-billing-page*.js", "maxSize": "1KB" },
{ "path": "./dist/op-billing-page*.js", "maxSize": "1KB" },
{ "path": "./dist/sessionTasks*.js", "maxSize": "1KB" }
Expand Down
28 changes: 9 additions & 19 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@@ -9,13 +9,13 @@ import type {
import { useMemo, useState } from 'react';

import { __experimental_PaymentSourcesContext, useCheckoutContext } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, Icon, localizationKeys, Text } from '../../customizables';
import { Box, Button, Col, descriptors, Form, localizationKeys } from '../../customizables';
import { Alert, Disclosure, Divider, Drawer, LineItems, Select, SelectButton, SelectOptionList } from '../../elements';
import { useFetch } from '../../hooks';
import { ArrowUpDown, CreditCard } from '../../icons';
import { ArrowUpDown } from '../../icons';
import { animations } from '../../styledSystem';
import { handleError } from '../../utils';
import { AddPaymentSource } from '../PaymentSources';
import { AddPaymentSource, PaymentSourceRow } from '../PaymentSources';

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

Expand DownExpand Up@@ -170,6 +170,7 @@ const CheckoutFormElements = ({
<Disclosure.Content>
<Col gap={3}>
<PaymentSourceMethods
checkout={checkout}
paymentSources={paymentSources}
totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
onPaymentSourceSubmit={onPaymentSourceSubmit}
Expand DownExpand Up@@ -208,19 +209,21 @@ const CheckoutFormElements = ({
};

const PaymentSourceMethods = ({
checkout,
totalDueNow,
paymentSources,
onPaymentSourceSubmit,
isSubmitting,
}: {
checkout: __experimental_CommerceCheckoutResource;
totalDueNow: __experimental_CommerceMoney;
paymentSources: __experimental_CommercePaymentSourceResource[];
onPaymentSourceSubmit: React.FormEventHandler<HTMLFormElement>;
isSubmitting: boolean;
}) => {
const [selectedPaymentSource, setSelectedPaymentSource] = useState<
__experimental_CommercePaymentSourceResource | undefined
>(paymentSources.length > 0 ? paymentSources[0] : undefined);
>(checkout.paymentSource || paymentSources.find(p => p.isDefault));

const options = useMemo(() => {
return paymentSources.map(source => {
Expand All@@ -241,7 +244,7 @@ const PaymentSourceMethods = ({
})}
>
<Select
elementId='role'
elementId='paymentSource'
options={options}
value={selectedPaymentSource?.id || null}
onChange={option => {
Expand All@@ -263,20 +266,7 @@ const PaymentSourceMethods = ({
backgroundColor: t.colors.$colorBackground,
})}
>
{selectedPaymentSource && (
<Flex
gap={3}
align='center'
>
<Icon icon={CreditCard} />
<Text
as='span'
colorScheme='body'
>
{capitalize(selectedPaymentSource.cardType)} ⋯ {selectedPaymentSource.last4}
</Text>
</Flex>
)}
{selectedPaymentSource && <PaymentSourceRow paymentSource={selectedPaymentSource} />}
</SelectButton>
<SelectOptionList
sx={t => ({
Expand Down
55 changes: 55 additions & 0 deletions packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
import type { __experimental_CommercePaymentSourceResource } from '@clerk/types';

import { Badge, descriptors, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { ApplePay, CreditCard } from '../../icons';

export const PaymentSourceRow = ({
paymentSource,
}: {
paymentSource: __experimental_CommercePaymentSourceResource;
}) => {
return (
<Flex
sx={{ overflow: 'hidden' }}
gap={2}
align='baseline'
elementDescriptor={descriptors.paymentSourceRow}
>
<Icon
icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
sx={{ alignSelf: 'center' }}
elementDescriptor={descriptors.paymentSourceRowIcon}
/>
<Text
sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
truncate
elementDescriptor={descriptors.paymentSourceRowType}
>
{paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
</Text>
<Text
sx={t => ({ color: t.colors.$colorTextSecondary })}
variant='caption'
truncate
elementDescriptor={descriptors.paymentSourceRowValue}
>
{paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
</Text>
{paymentSource.isDefault && (
<Badge
elementDescriptor={descriptors.paymentSourceRowBadge}
elementId={descriptors.paymentSourceRowBadge.setId('default')}
localizationKey={localizationKeys('badge__default')}
/>
)}
{paymentSource.status === 'expired' && (
<Badge
elementDescriptor={descriptors.paymentSourceRowBadge}
elementId={descriptors.paymentSourceRowBadge.setId('expired')}
colorScheme='danger'
localizationKey={localizationKeys('badge__expired')}
/>
)}
</Flex>
);
};
35 changes: 3 additions & 32 deletions packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,14 +4,14 @@ import { Fragment, useRef } from 'react';

import { RemoveResourceForm } from '../../common';
import { usePaymentSourcesContext } from '../../contexts';
import { Badge, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { localizationKeys } from '../../customizables';
import { ProfileSection, ThreeDotsMenu, useCardState } from '../../elements';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
import { useFetch } from '../../hooks';
import { ApplePay, CreditCard } from '../../icons';
import { handleError } from '../../utils';
import { AddPaymentSource } from './AddPaymentSource';
import { PaymentSourceRow } from './PaymentSourceRow';

const AddScreen = ({ onSuccess }: { onSuccess: () => void }) => {
const { close } = useActionContext();
Expand DownExpand Up@@ -108,36 +108,7 @@ const PaymentSources = (_: __experimental_PaymentSourcesProps) => {
{paymentSources.map(paymentSource => (
<Fragment key={paymentSource.id}>
<ProfileSection.Item id='paymentSources'>
<Flex
sx={{ overflow: 'hidden' }}
gap={2}
align='baseline'
>
<Icon
icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
sx={{ alignSelf: 'center' }}
/>
<Text
sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
truncate
>
{paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
</Text>
<Text
sx={t => ({ color: t.colors.$colorTextSecondary })}
variant='caption'
truncate
>
{paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
</Text>
{paymentSource.isDefault && <Badge localizationKey={localizationKeys('badge__default')} />}
{paymentSource.status === 'expired' && (
<Badge
colorScheme='danger'
localizationKey={localizationKeys('badge__expired')}
/>
)}
</Flex>
<PaymentSourceRow paymentSource={paymentSource} />
<PaymentSourceMenu
paymentSource={paymentSource}
revalidate={revalidate}
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/ui/components/PaymentSources/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export * from './AddPaymentSource';
export * from './PaymentSources';
export * from './PaymentSourceRow';
7 changes: 7 additions & 0 deletions packages/clerk-js/src/ui/customizables/elementDescriptors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -330,6 +330,13 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'selectOptionsContainer',
'selectOption',

'paymentSourceRow',
'paymentSourceRowIcon',
'paymentSourceRowText',
'paymentSourceRowType',
'paymentSourceRowValue',
'paymentSourceRowBadge',

'menuButton',
'menuButtonEllipsis',
'menuList',
Expand Down
7 changes: 7 additions & 0 deletions packages/types/src/appearance.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -454,6 +454,13 @@ export type ElementsConfig = {
selectOptionsContainer: WithOptions<SelectId>;
selectOption: WithOptions<SelectId>;

paymentSourceRow: WithOptions;
paymentSourceRowIcon: WithOptions;
paymentSourceRowText: WithOptions;
paymentSourceRowType: WithOptions;
paymentSourceRowValue: WithOptions;
paymentSourceRowBadge: WithOptions<'default' | 'expired'>;

menuButton: WithOptions<MenuId>;
menuButtonEllipsis: WithOptions;
menuList: WithOptions<MenuId>;
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/elementIds.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,4 +52,4 @@ export type OrganizationPreviewId =
export type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey' | 'waitlist';

export type MenuId = 'invitation' | 'member' | ProfileSectionId;
export type SelectId = 'countryCode' | 'role';
export type SelectId = 'countryCode' | 'role' | 'paymentSource';
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(clerk-js,types): Add `PaymentSourceRow` for displaying payment sources by aeliox · Pull Request #5570 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources#5570

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

aeliox
merged 4 commits into

from

Apr 13, 2025
 Merged


feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources
#5570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e67596

add PaymentSourceRow


aeliox Apr 9, 2025
7439e25

bundle size bump


aeliox Apr 9, 2025
fd0ba8d

add/update descriptors


alexcarpenter Apr 11, 2025
1ef5a36

Merge branch 'main' into keiran/payment-source-row


alexcarpenter Apr 11, 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/tall-clocks-call.md

View file


Open in desktop

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

Add `PaymentSourceRow` for displaying payment sources

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "5.9KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "5KB" },
 { "path": "./dist/checkout*.js", "maxSize": "3KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.1KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.2KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/sessionTasks*.js", "maxSize": "1KB" }
Expand Down

28 changes: 9 additions & 19 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@@ -9,13 +9,13 @@ import type {
import { useMemo, useState } from 'react';

import { __experimental_PaymentSourcesContext, useCheckoutContext } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, Icon, localizationKeys, Text } from '../../customizables';
import { Box, Button, Col, descriptors, Form, localizationKeys } from '../../customizables';
import { Alert, Disclosure, Divider, Drawer, LineItems, Select, SelectButton, SelectOptionList } from '../../elements';
import { useFetch } from '../../hooks';
import { ArrowUpDown, CreditCard } from '../../icons';
import { ArrowUpDown } from '../../icons';
import { animations } from '../../styledSystem';
import { handleError } from '../../utils';
import { AddPaymentSource } from '../PaymentSources';
import { AddPaymentSource, PaymentSourceRow } from '../PaymentSources';

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

Expand DownExpand Up@@ -170,6 +170,7 @@ const CheckoutFormElements = ({
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
 checkout={checkout}
 paymentSources={paymentSources}
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
 onPaymentSourceSubmit={onPaymentSourceSubmit}
Expand DownExpand Up@@ -208,19 +209,21 @@ const CheckoutFormElements = ({
};

const PaymentSourceMethods = ({
 checkout,
 totalDueNow,
 paymentSources,
 onPaymentSourceSubmit,
 isSubmitting,
}: {
 checkout: __experimental_CommerceCheckoutResource;
 totalDueNow: __experimental_CommerceMoney;
 paymentSources: __experimental_CommercePaymentSourceResource[];
 onPaymentSourceSubmit: React.FormEventHandler<HTMLFormElement>;
 isSubmitting: boolean;
}) => {
 const [selectedPaymentSource, setSelectedPaymentSource] = useState<
 __experimental_CommercePaymentSourceResource | undefined
 >(paymentSources.length > 0 ? paymentSources[0] : undefined);
 >(checkout.paymentSource || paymentSources.find(p => p.isDefault));

 const options = useMemo(() => {
 return paymentSources.map(source => {
Expand All@@ -241,7 +244,7 @@ const PaymentSourceMethods = ({
 })}
 >
 <Select
 elementId='role'
 elementId='paymentSource'
 options={options}
 value={selectedPaymentSource?.id || null}
 onChange={option => {
Expand All@@ -263,20 +266,7 @@ const PaymentSourceMethods = ({
 backgroundColor: t.colors.$colorBackground,
 })}
 >
 {selectedPaymentSource && (
 <Flex
 gap={3}
 align='center'
 >
 <Icon icon={CreditCard} />
 <Text
 as='span'
 colorScheme='body'
 >
 {capitalize(selectedPaymentSource.cardType)} ⋯ {selectedPaymentSource.last4}
 </Text>
 </Flex>
 )}
 {selectedPaymentSource && <PaymentSourceRow paymentSource={selectedPaymentSource} />}
 </SelectButton>
 <SelectOptionList
 sx={t => ({
Expand Down

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx

View file


Open in desktop

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

import { Badge, descriptors, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { ApplePay, CreditCard } from '../../icons';

export const PaymentSourceRow = ({
 paymentSource,
}: {
 paymentSource: __experimental_CommercePaymentSourceResource;
}) => {
 return (
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 elementDescriptor={descriptors.paymentSourceRow}
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 elementDescriptor={descriptors.paymentSourceRowIcon}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 elementDescriptor={descriptors.paymentSourceRowType}
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 elementDescriptor={descriptors.paymentSourceRowValue}
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('default')}
 localizationKey={localizationKeys('badge__default')}
 />
 )}
 {paymentSource.status === 'expired' && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('expired')}
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 );
};

35 changes: 3 additions & 32 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,14 +4,14 @@ import { Fragment, useRef } from 'react';

import { RemoveResourceForm } from '../../common';
import { usePaymentSourcesContext } from '../../contexts';
import { Badge, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { localizationKeys } from '../../customizables';
import { ProfileSection, ThreeDotsMenu, useCardState } from '../../elements';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
import { useFetch } from '../../hooks';
import { ApplePay, CreditCard } from '../../icons';
import { handleError } from '../../utils';
import { AddPaymentSource } from './AddPaymentSource';
import { PaymentSourceRow } from './PaymentSourceRow';

const AddScreen = ({ onSuccess }: { onSuccess: () => void }) => {
 const { close } = useActionContext();
Expand DownExpand Up@@ -108,36 +108,7 @@ const PaymentSources = (_: __experimental_PaymentSourcesProps) => {
 {paymentSources.map(paymentSource => (
 <Fragment key={paymentSource.id}>
 <ProfileSection.Item id='paymentSources'>
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && <Badge localizationKey={localizationKeys('badge__default')} />}
 {paymentSource.status === 'expired' && (
 <Badge
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidate}
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export * from './AddPaymentSource';
export * from './PaymentSources';
export * from './PaymentSourceRow';

7 changes: 7 additions & 0 deletions
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -330,6 +330,13 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'selectOptionsContainer',
 'selectOption',

 'paymentSourceRow',
 'paymentSourceRowIcon',
 'paymentSourceRowText',
 'paymentSourceRowType',
 'paymentSourceRowValue',
 'paymentSourceRowBadge',

 'menuButton',
 'menuButtonEllipsis',
 'menuList',
Expand Down

7 changes: 7 additions & 0 deletions
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -454,6 +454,13 @@ export type ElementsConfig = {
 selectOptionsContainer: WithOptions<SelectId>;
 selectOption: WithOptions<SelectId>;

 paymentSourceRow: WithOptions;
 paymentSourceRowIcon: WithOptions;
 paymentSourceRowText: WithOptions;
 paymentSourceRowType: WithOptions;
 paymentSourceRowValue: WithOptions;
 paymentSourceRowBadge: WithOptions<'default' | 'expired'>;

 menuButton: WithOptions<MenuId>;
 menuButtonEllipsis: WithOptions;
 menuList: WithOptions<MenuId>;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,4 +52,4 @@ export type OrganizationPreviewId =
export type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey' | 'waitlist';

export type MenuId = 'invitation' | 'member' | ProfileSectionId;
export type SelectId = 'countryCode' | 'role';
export type SelectId = 'countryCode' | 'role' | 'paymentSource';

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,types): Add `PaymentSourceRow` for displaying payment sources by aeliox · Pull Request #5570 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources#5570

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

aeliox
merged 4 commits into

from

Apr 13, 2025
 Merged


feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources
#5570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e67596

add PaymentSourceRow


aeliox Apr 9, 2025
7439e25

bundle size bump


aeliox Apr 9, 2025
fd0ba8d

add/update descriptors


alexcarpenter Apr 11, 2025
1ef5a36

Merge branch 'main' into keiran/payment-source-row


alexcarpenter Apr 11, 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/tall-clocks-call.md

View file


Open in desktop

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

Add `PaymentSourceRow` for displaying payment sources

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "5.9KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "5KB" },
 { "path": "./dist/checkout*.js", "maxSize": "3KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.1KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.2KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/sessionTasks*.js", "maxSize": "1KB" }
Expand Down

28 changes: 9 additions & 19 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@@ -9,13 +9,13 @@ import type {
import { useMemo, useState } from 'react';

import { __experimental_PaymentSourcesContext, useCheckoutContext } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, Icon, localizationKeys, Text } from '../../customizables';
import { Box, Button, Col, descriptors, Form, localizationKeys } from '../../customizables';
import { Alert, Disclosure, Divider, Drawer, LineItems, Select, SelectButton, SelectOptionList } from '../../elements';
import { useFetch } from '../../hooks';
import { ArrowUpDown, CreditCard } from '../../icons';
import { ArrowUpDown } from '../../icons';
import { animations } from '../../styledSystem';
import { handleError } from '../../utils';
import { AddPaymentSource } from '../PaymentSources';
import { AddPaymentSource, PaymentSourceRow } from '../PaymentSources';

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

Expand DownExpand Up@@ -170,6 +170,7 @@ const CheckoutFormElements = ({
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
 checkout={checkout}
 paymentSources={paymentSources}
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
 onPaymentSourceSubmit={onPaymentSourceSubmit}
Expand DownExpand Up@@ -208,19 +209,21 @@ const CheckoutFormElements = ({
};

const PaymentSourceMethods = ({
 checkout,
 totalDueNow,
 paymentSources,
 onPaymentSourceSubmit,
 isSubmitting,
}: {
 checkout: __experimental_CommerceCheckoutResource;
 totalDueNow: __experimental_CommerceMoney;
 paymentSources: __experimental_CommercePaymentSourceResource[];
 onPaymentSourceSubmit: React.FormEventHandler<HTMLFormElement>;
 isSubmitting: boolean;
}) => {
 const [selectedPaymentSource, setSelectedPaymentSource] = useState<
 __experimental_CommercePaymentSourceResource | undefined
 >(paymentSources.length > 0 ? paymentSources[0] : undefined);
 >(checkout.paymentSource || paymentSources.find(p => p.isDefault));

 const options = useMemo(() => {
 return paymentSources.map(source => {
Expand All@@ -241,7 +244,7 @@ const PaymentSourceMethods = ({
 })}
 >
 <Select
 elementId='role'
 elementId='paymentSource'
 options={options}
 value={selectedPaymentSource?.id || null}
 onChange={option => {
Expand All@@ -263,20 +266,7 @@ const PaymentSourceMethods = ({
 backgroundColor: t.colors.$colorBackground,
 })}
 >
 {selectedPaymentSource && (
 <Flex
 gap={3}
 align='center'
 >
 <Icon icon={CreditCard} />
 <Text
 as='span'
 colorScheme='body'
 >
 {capitalize(selectedPaymentSource.cardType)} ⋯ {selectedPaymentSource.last4}
 </Text>
 </Flex>
 )}
 {selectedPaymentSource && <PaymentSourceRow paymentSource={selectedPaymentSource} />}
 </SelectButton>
 <SelectOptionList
 sx={t => ({
Expand Down

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx

View file


Open in desktop

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

import { Badge, descriptors, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { ApplePay, CreditCard } from '../../icons';

export const PaymentSourceRow = ({
 paymentSource,
}: {
 paymentSource: __experimental_CommercePaymentSourceResource;
}) => {
 return (
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 elementDescriptor={descriptors.paymentSourceRow}
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 elementDescriptor={descriptors.paymentSourceRowIcon}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 elementDescriptor={descriptors.paymentSourceRowType}
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 elementDescriptor={descriptors.paymentSourceRowValue}
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('default')}
 localizationKey={localizationKeys('badge__default')}
 />
 )}
 {paymentSource.status === 'expired' && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('expired')}
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 );
};

35 changes: 3 additions & 32 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,14 +4,14 @@ import { Fragment, useRef } from 'react';

import { RemoveResourceForm } from '../../common';
import { usePaymentSourcesContext } from '../../contexts';
import { Badge, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { localizationKeys } from '../../customizables';
import { ProfileSection, ThreeDotsMenu, useCardState } from '../../elements';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
import { useFetch } from '../../hooks';
import { ApplePay, CreditCard } from '../../icons';
import { handleError } from '../../utils';
import { AddPaymentSource } from './AddPaymentSource';
import { PaymentSourceRow } from './PaymentSourceRow';

const AddScreen = ({ onSuccess }: { onSuccess: () => void }) => {
 const { close } = useActionContext();
Expand DownExpand Up@@ -108,36 +108,7 @@ const PaymentSources = (_: __experimental_PaymentSourcesProps) => {
 {paymentSources.map(paymentSource => (
 <Fragment key={paymentSource.id}>
 <ProfileSection.Item id='paymentSources'>
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && <Badge localizationKey={localizationKeys('badge__default')} />}
 {paymentSource.status === 'expired' && (
 <Badge
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidate}
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export * from './AddPaymentSource';
export * from './PaymentSources';
export * from './PaymentSourceRow';

7 changes: 7 additions & 0 deletions
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -330,6 +330,13 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'selectOptionsContainer',
 'selectOption',

 'paymentSourceRow',
 'paymentSourceRowIcon',
 'paymentSourceRowText',
 'paymentSourceRowType',
 'paymentSourceRowValue',
 'paymentSourceRowBadge',

 'menuButton',
 'menuButtonEllipsis',
 'menuList',
Expand Down

7 changes: 7 additions & 0 deletions
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -454,6 +454,13 @@ export type ElementsConfig = {
 selectOptionsContainer: WithOptions<SelectId>;
 selectOption: WithOptions<SelectId>;

 paymentSourceRow: WithOptions;
 paymentSourceRowIcon: WithOptions;
 paymentSourceRowText: WithOptions;
 paymentSourceRowType: WithOptions;
 paymentSourceRowValue: WithOptions;
 paymentSourceRowBadge: WithOptions<'default' | 'expired'>;

 menuButton: WithOptions<MenuId>;
 menuButtonEllipsis: WithOptions;
 menuList: WithOptions<MenuId>;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,4 +52,4 @@ export type OrganizationPreviewId =
export type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey' | 'waitlist';

export type MenuId = 'invitation' | 'member' | ProfileSectionId;
export type SelectId = 'countryCode' | 'role';
export type SelectId = 'countryCode' | 'role' | 'paymentSource';

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

aeliox
merged 4 commits into

from

Apr 13, 2025
 Merged


feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources
#5570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e67596

add PaymentSourceRow


aeliox Apr 9, 2025
7439e25

bundle size bump


aeliox Apr 9, 2025
fd0ba8d

add/update descriptors


alexcarpenter Apr 11, 2025
1ef5a36

Merge branch 'main' into keiran/payment-source-row


alexcarpenter Apr 11, 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/tall-clocks-call.md

View file


Open in desktop

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

Add `PaymentSourceRow` for displaying payment sources

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "5.9KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "5KB" },
 { "path": "./dist/checkout*.js", "maxSize": "3KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.1KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.2KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/sessionTasks*.js", "maxSize": "1KB" }
Expand Down

28 changes: 9 additions & 19 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@@ -9,13 +9,13 @@ import type {
import { useMemo, useState } from 'react';

import { __experimental_PaymentSourcesContext, useCheckoutContext } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, Icon, localizationKeys, Text } from '../../customizables';
import { Box, Button, Col, descriptors, Form, localizationKeys } from '../../customizables';
import { Alert, Disclosure, Divider, Drawer, LineItems, Select, SelectButton, SelectOptionList } from '../../elements';
import { useFetch } from '../../hooks';
import { ArrowUpDown, CreditCard } from '../../icons';
import { ArrowUpDown } from '../../icons';
import { animations } from '../../styledSystem';
import { handleError } from '../../utils';
import { AddPaymentSource } from '../PaymentSources';
import { AddPaymentSource, PaymentSourceRow } from '../PaymentSources';

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

Expand DownExpand Up@@ -170,6 +170,7 @@ const CheckoutFormElements = ({
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
 checkout={checkout}
 paymentSources={paymentSources}
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
 onPaymentSourceSubmit={onPaymentSourceSubmit}
Expand DownExpand Up@@ -208,19 +209,21 @@ const CheckoutFormElements = ({
};

const PaymentSourceMethods = ({
 checkout,
 totalDueNow,
 paymentSources,
 onPaymentSourceSubmit,
 isSubmitting,
}: {
 checkout: __experimental_CommerceCheckoutResource;
 totalDueNow: __experimental_CommerceMoney;
 paymentSources: __experimental_CommercePaymentSourceResource[];
 onPaymentSourceSubmit: React.FormEventHandler<HTMLFormElement>;
 isSubmitting: boolean;
}) => {
 const [selectedPaymentSource, setSelectedPaymentSource] = useState<
 __experimental_CommercePaymentSourceResource | undefined
 >(paymentSources.length > 0 ? paymentSources[0] : undefined);
 >(checkout.paymentSource || paymentSources.find(p => p.isDefault));

 const options = useMemo(() => {
 return paymentSources.map(source => {
Expand All@@ -241,7 +244,7 @@ const PaymentSourceMethods = ({
 })}
 >
 <Select
 elementId='role'
 elementId='paymentSource'
 options={options}
 value={selectedPaymentSource?.id || null}
 onChange={option => {
Expand All@@ -263,20 +266,7 @@ const PaymentSourceMethods = ({
 backgroundColor: t.colors.$colorBackground,
 })}
 >
 {selectedPaymentSource && (
 <Flex
 gap={3}
 align='center'
 >
 <Icon icon={CreditCard} />
 <Text
 as='span'
 colorScheme='body'
 >
 {capitalize(selectedPaymentSource.cardType)} ⋯ {selectedPaymentSource.last4}
 </Text>
 </Flex>
 )}
 {selectedPaymentSource && <PaymentSourceRow paymentSource={selectedPaymentSource} />}
 </SelectButton>
 <SelectOptionList
 sx={t => ({
Expand Down

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx

View file


Open in desktop

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

import { Badge, descriptors, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { ApplePay, CreditCard } from '../../icons';

export const PaymentSourceRow = ({
 paymentSource,
}: {
 paymentSource: __experimental_CommercePaymentSourceResource;
}) => {
 return (
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 elementDescriptor={descriptors.paymentSourceRow}
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 elementDescriptor={descriptors.paymentSourceRowIcon}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 elementDescriptor={descriptors.paymentSourceRowType}
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 elementDescriptor={descriptors.paymentSourceRowValue}
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('default')}
 localizationKey={localizationKeys('badge__default')}
 />
 )}
 {paymentSource.status === 'expired' && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('expired')}
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 );
};

35 changes: 3 additions & 32 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,14 +4,14 @@ import { Fragment, useRef } from 'react';

import { RemoveResourceForm } from '../../common';
import { usePaymentSourcesContext } from '../../contexts';
import { Badge, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { localizationKeys } from '../../customizables';
import { ProfileSection, ThreeDotsMenu, useCardState } from '../../elements';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
import { useFetch } from '../../hooks';
import { ApplePay, CreditCard } from '../../icons';
import { handleError } from '../../utils';
import { AddPaymentSource } from './AddPaymentSource';
import { PaymentSourceRow } from './PaymentSourceRow';

const AddScreen = ({ onSuccess }: { onSuccess: () => void }) => {
 const { close } = useActionContext();
Expand DownExpand Up@@ -108,36 +108,7 @@ const PaymentSources = (_: __experimental_PaymentSourcesProps) => {
 {paymentSources.map(paymentSource => (
 <Fragment key={paymentSource.id}>
 <ProfileSection.Item id='paymentSources'>
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && <Badge localizationKey={localizationKeys('badge__default')} />}
 {paymentSource.status === 'expired' && (
 <Badge
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidate}
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export * from './AddPaymentSource';
export * from './PaymentSources';
export * from './PaymentSourceRow';

7 changes: 7 additions & 0 deletions
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -330,6 +330,13 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'selectOptionsContainer',
 'selectOption',

 'paymentSourceRow',
 'paymentSourceRowIcon',
 'paymentSourceRowText',
 'paymentSourceRowType',
 'paymentSourceRowValue',
 'paymentSourceRowBadge',

 'menuButton',
 'menuButtonEllipsis',
 'menuList',
Expand Down

7 changes: 7 additions & 0 deletions
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -454,6 +454,13 @@ export type ElementsConfig = {
 selectOptionsContainer: WithOptions<SelectId>;
 selectOption: WithOptions<SelectId>;

 paymentSourceRow: WithOptions;
 paymentSourceRowIcon: WithOptions;
 paymentSourceRowText: WithOptions;
 paymentSourceRowType: WithOptions;
 paymentSourceRowValue: WithOptions;
 paymentSourceRowBadge: WithOptions<'default' | 'expired'>;

 menuButton: WithOptions<MenuId>;
 menuButtonEllipsis: WithOptions;
 menuList: WithOptions<MenuId>;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,4 +52,4 @@ export type OrganizationPreviewId =
export type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey' | 'waitlist';

export type MenuId = 'invitation' | 'member' | ProfileSectionId;
export type SelectId = 'countryCode' | 'role';
export type SelectId = 'countryCode' | 'role' | 'paymentSource';

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

aeliox
merged 4 commits into

from

Apr 13, 2025
 Merged


feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources
#5570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e67596

add PaymentSourceRow


aeliox Apr 9, 2025
7439e25

bundle size bump


aeliox Apr 9, 2025
fd0ba8d

add/update descriptors


alexcarpenter Apr 11, 2025
1ef5a36

Merge branch 'main' into keiran/payment-source-row


alexcarpenter Apr 11, 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/tall-clocks-call.md

View file


Open in desktop

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

Add `PaymentSourceRow` for displaying payment sources

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "5.9KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "5KB" },
 { "path": "./dist/checkout*.js", "maxSize": "3KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.1KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.2KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/sessionTasks*.js", "maxSize": "1KB" }
Expand Down

28 changes: 9 additions & 19 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@@ -9,13 +9,13 @@ import type {
import { useMemo, useState } from 'react';

import { __experimental_PaymentSourcesContext, useCheckoutContext } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, Icon, localizationKeys, Text } from '../../customizables';
import { Box, Button, Col, descriptors, Form, localizationKeys } from '../../customizables';
import { Alert, Disclosure, Divider, Drawer, LineItems, Select, SelectButton, SelectOptionList } from '../../elements';
import { useFetch } from '../../hooks';
import { ArrowUpDown, CreditCard } from '../../icons';
import { ArrowUpDown } from '../../icons';
import { animations } from '../../styledSystem';
import { handleError } from '../../utils';
import { AddPaymentSource } from '../PaymentSources';
import { AddPaymentSource, PaymentSourceRow } from '../PaymentSources';

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

Expand DownExpand Up@@ -170,6 +170,7 @@ const CheckoutFormElements = ({
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
 checkout={checkout}
 paymentSources={paymentSources}
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
 onPaymentSourceSubmit={onPaymentSourceSubmit}
Expand DownExpand Up@@ -208,19 +209,21 @@ const CheckoutFormElements = ({
};

const PaymentSourceMethods = ({
 checkout,
 totalDueNow,
 paymentSources,
 onPaymentSourceSubmit,
 isSubmitting,
}: {
 checkout: __experimental_CommerceCheckoutResource;
 totalDueNow: __experimental_CommerceMoney;
 paymentSources: __experimental_CommercePaymentSourceResource[];
 onPaymentSourceSubmit: React.FormEventHandler<HTMLFormElement>;
 isSubmitting: boolean;
}) => {
 const [selectedPaymentSource, setSelectedPaymentSource] = useState<
 __experimental_CommercePaymentSourceResource | undefined
 >(paymentSources.length > 0 ? paymentSources[0] : undefined);
 >(checkout.paymentSource || paymentSources.find(p => p.isDefault));

 const options = useMemo(() => {
 return paymentSources.map(source => {
Expand All@@ -241,7 +244,7 @@ const PaymentSourceMethods = ({
 })}
 >
 <Select
 elementId='role'
 elementId='paymentSource'
 options={options}
 value={selectedPaymentSource?.id || null}
 onChange={option => {
Expand All@@ -263,20 +266,7 @@ const PaymentSourceMethods = ({
 backgroundColor: t.colors.$colorBackground,
 })}
 >
 {selectedPaymentSource && (
 <Flex
 gap={3}
 align='center'
 >
 <Icon icon={CreditCard} />
 <Text
 as='span'
 colorScheme='body'
 >
 {capitalize(selectedPaymentSource.cardType)} ⋯ {selectedPaymentSource.last4}
 </Text>
 </Flex>
 )}
 {selectedPaymentSource && <PaymentSourceRow paymentSource={selectedPaymentSource} />}
 </SelectButton>
 <SelectOptionList
 sx={t => ({
Expand Down

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx

View file


Open in desktop

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

import { Badge, descriptors, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { ApplePay, CreditCard } from '../../icons';

export const PaymentSourceRow = ({
 paymentSource,
}: {
 paymentSource: __experimental_CommercePaymentSourceResource;
}) => {
 return (
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 elementDescriptor={descriptors.paymentSourceRow}
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 elementDescriptor={descriptors.paymentSourceRowIcon}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 elementDescriptor={descriptors.paymentSourceRowType}
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 elementDescriptor={descriptors.paymentSourceRowValue}
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('default')}
 localizationKey={localizationKeys('badge__default')}
 />
 )}
 {paymentSource.status === 'expired' && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('expired')}
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 );
};

35 changes: 3 additions & 32 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,14 +4,14 @@ import { Fragment, useRef } from 'react';

import { RemoveResourceForm } from '../../common';
import { usePaymentSourcesContext } from '../../contexts';
import { Badge, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { localizationKeys } from '../../customizables';
import { ProfileSection, ThreeDotsMenu, useCardState } from '../../elements';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
import { useFetch } from '../../hooks';
import { ApplePay, CreditCard } from '../../icons';
import { handleError } from '../../utils';
import { AddPaymentSource } from './AddPaymentSource';
import { PaymentSourceRow } from './PaymentSourceRow';

const AddScreen = ({ onSuccess }: { onSuccess: () => void }) => {
 const { close } = useActionContext();
Expand DownExpand Up@@ -108,36 +108,7 @@ const PaymentSources = (_: __experimental_PaymentSourcesProps) => {
 {paymentSources.map(paymentSource => (
 <Fragment key={paymentSource.id}>
 <ProfileSection.Item id='paymentSources'>
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && <Badge localizationKey={localizationKeys('badge__default')} />}
 {paymentSource.status === 'expired' && (
 <Badge
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidate}
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export * from './AddPaymentSource';
export * from './PaymentSources';
export * from './PaymentSourceRow';

7 changes: 7 additions & 0 deletions
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -330,6 +330,13 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'selectOptionsContainer',
 'selectOption',

 'paymentSourceRow',
 'paymentSourceRowIcon',
 'paymentSourceRowText',
 'paymentSourceRowType',
 'paymentSourceRowValue',
 'paymentSourceRowBadge',

 'menuButton',
 'menuButtonEllipsis',
 'menuList',
Expand Down

7 changes: 7 additions & 0 deletions
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -454,6 +454,13 @@ export type ElementsConfig = {
 selectOptionsContainer: WithOptions<SelectId>;
 selectOption: WithOptions<SelectId>;

 paymentSourceRow: WithOptions;
 paymentSourceRowIcon: WithOptions;
 paymentSourceRowText: WithOptions;
 paymentSourceRowType: WithOptions;
 paymentSourceRowValue: WithOptions;
 paymentSourceRowBadge: WithOptions<'default' | 'expired'>;

 menuButton: WithOptions<MenuId>;
 menuButtonEllipsis: WithOptions;
 menuList: WithOptions<MenuId>;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,4 +52,4 @@ export type OrganizationPreviewId =
export type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey' | 'waitlist';

export type MenuId = 'invitation' | 'member' | ProfileSectionId;
export type SelectId = 'countryCode' | 'role';
export type SelectId = 'countryCode' | 'role' | 'paymentSource';

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,types): Add `PaymentSourceRow` for displaying payment sources by aeliox · Pull Request #5570 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources#5570

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

aeliox
merged 4 commits into

from

Apr 13, 2025
 Merged


feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources
#5570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e67596

add PaymentSourceRow


aeliox Apr 9, 2025
7439e25

bundle size bump


aeliox Apr 9, 2025
fd0ba8d

add/update descriptors


alexcarpenter Apr 11, 2025
1ef5a36

Merge branch 'main' into keiran/payment-source-row


alexcarpenter Apr 11, 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/tall-clocks-call.md

View file


Open in desktop

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

Add `PaymentSourceRow` for displaying payment sources

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "5.9KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "5KB" },
 { "path": "./dist/checkout*.js", "maxSize": "3KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.1KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.2KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/sessionTasks*.js", "maxSize": "1KB" }
Expand Down

28 changes: 9 additions & 19 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@@ -9,13 +9,13 @@ import type {
import { useMemo, useState } from 'react';

import { __experimental_PaymentSourcesContext, useCheckoutContext } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, Icon, localizationKeys, Text } from '../../customizables';
import { Box, Button, Col, descriptors, Form, localizationKeys } from '../../customizables';
import { Alert, Disclosure, Divider, Drawer, LineItems, Select, SelectButton, SelectOptionList } from '../../elements';
import { useFetch } from '../../hooks';
import { ArrowUpDown, CreditCard } from '../../icons';
import { ArrowUpDown } from '../../icons';
import { animations } from '../../styledSystem';
import { handleError } from '../../utils';
import { AddPaymentSource } from '../PaymentSources';
import { AddPaymentSource, PaymentSourceRow } from '../PaymentSources';

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

Expand DownExpand Up@@ -170,6 +170,7 @@ const CheckoutFormElements = ({
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
 checkout={checkout}
 paymentSources={paymentSources}
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
 onPaymentSourceSubmit={onPaymentSourceSubmit}
Expand DownExpand Up@@ -208,19 +209,21 @@ const CheckoutFormElements = ({
};

const PaymentSourceMethods = ({
 checkout,
 totalDueNow,
 paymentSources,
 onPaymentSourceSubmit,
 isSubmitting,
}: {
 checkout: __experimental_CommerceCheckoutResource;
 totalDueNow: __experimental_CommerceMoney;
 paymentSources: __experimental_CommercePaymentSourceResource[];
 onPaymentSourceSubmit: React.FormEventHandler<HTMLFormElement>;
 isSubmitting: boolean;
}) => {
 const [selectedPaymentSource, setSelectedPaymentSource] = useState<
 __experimental_CommercePaymentSourceResource | undefined
 >(paymentSources.length > 0 ? paymentSources[0] : undefined);
 >(checkout.paymentSource || paymentSources.find(p => p.isDefault));

 const options = useMemo(() => {
 return paymentSources.map(source => {
Expand All@@ -241,7 +244,7 @@ const PaymentSourceMethods = ({
 })}
 >
 <Select
 elementId='role'
 elementId='paymentSource'
 options={options}
 value={selectedPaymentSource?.id || null}
 onChange={option => {
Expand All@@ -263,20 +266,7 @@ const PaymentSourceMethods = ({
 backgroundColor: t.colors.$colorBackground,
 })}
 >
 {selectedPaymentSource && (
 <Flex
 gap={3}
 align='center'
 >
 <Icon icon={CreditCard} />
 <Text
 as='span'
 colorScheme='body'
 >
 {capitalize(selectedPaymentSource.cardType)} ⋯ {selectedPaymentSource.last4}
 </Text>
 </Flex>
 )}
 {selectedPaymentSource && <PaymentSourceRow paymentSource={selectedPaymentSource} />}
 </SelectButton>
 <SelectOptionList
 sx={t => ({
Expand Down

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx

View file


Open in desktop

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

import { Badge, descriptors, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { ApplePay, CreditCard } from '../../icons';

export const PaymentSourceRow = ({
 paymentSource,
}: {
 paymentSource: __experimental_CommercePaymentSourceResource;
}) => {
 return (
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 elementDescriptor={descriptors.paymentSourceRow}
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 elementDescriptor={descriptors.paymentSourceRowIcon}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 elementDescriptor={descriptors.paymentSourceRowType}
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 elementDescriptor={descriptors.paymentSourceRowValue}
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('default')}
 localizationKey={localizationKeys('badge__default')}
 />
 )}
 {paymentSource.status === 'expired' && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('expired')}
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 );
};

35 changes: 3 additions & 32 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,14 +4,14 @@ import { Fragment, useRef } from 'react';

import { RemoveResourceForm } from '../../common';
import { usePaymentSourcesContext } from '../../contexts';
import { Badge, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { localizationKeys } from '../../customizables';
import { ProfileSection, ThreeDotsMenu, useCardState } from '../../elements';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
import { useFetch } from '../../hooks';
import { ApplePay, CreditCard } from '../../icons';
import { handleError } from '../../utils';
import { AddPaymentSource } from './AddPaymentSource';
import { PaymentSourceRow } from './PaymentSourceRow';

const AddScreen = ({ onSuccess }: { onSuccess: () => void }) => {
 const { close } = useActionContext();
Expand DownExpand Up@@ -108,36 +108,7 @@ const PaymentSources = (_: __experimental_PaymentSourcesProps) => {
 {paymentSources.map(paymentSource => (
 <Fragment key={paymentSource.id}>
 <ProfileSection.Item id='paymentSources'>
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && <Badge localizationKey={localizationKeys('badge__default')} />}
 {paymentSource.status === 'expired' && (
 <Badge
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidate}
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export * from './AddPaymentSource';
export * from './PaymentSources';
export * from './PaymentSourceRow';

7 changes: 7 additions & 0 deletions
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -330,6 +330,13 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'selectOptionsContainer',
 'selectOption',

 'paymentSourceRow',
 'paymentSourceRowIcon',
 'paymentSourceRowText',
 'paymentSourceRowType',
 'paymentSourceRowValue',
 'paymentSourceRowBadge',

 'menuButton',
 'menuButtonEllipsis',
 'menuList',
Expand Down

7 changes: 7 additions & 0 deletions
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -454,6 +454,13 @@ export type ElementsConfig = {
 selectOptionsContainer: WithOptions<SelectId>;
 selectOption: WithOptions<SelectId>;

 paymentSourceRow: WithOptions;
 paymentSourceRowIcon: WithOptions;
 paymentSourceRowText: WithOptions;
 paymentSourceRowType: WithOptions;
 paymentSourceRowValue: WithOptions;
 paymentSourceRowBadge: WithOptions<'default' | 'expired'>;

 menuButton: WithOptions<MenuId>;
 menuButtonEllipsis: WithOptions;
 menuList: WithOptions<MenuId>;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,4 +52,4 @@ export type OrganizationPreviewId =
export type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey' | 'waitlist';

export type MenuId = 'invitation' | 'member' | ProfileSectionId;
export type SelectId = 'countryCode' | 'role';
export type SelectId = 'countryCode' | 'role' | 'paymentSource';

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,types): Add `PaymentSourceRow` for displaying payment sources by aeliox · Pull Request #5570 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources#5570

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

aeliox
merged 4 commits into

from

Apr 13, 2025
 Merged


feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources
#5570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e67596

add PaymentSourceRow


aeliox Apr 9, 2025
7439e25

bundle size bump


aeliox Apr 9, 2025
fd0ba8d

add/update descriptors


alexcarpenter Apr 11, 2025
1ef5a36

Merge branch 'main' into keiran/payment-source-row


alexcarpenter Apr 11, 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/tall-clocks-call.md

View file


Open in desktop

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

Add `PaymentSourceRow` for displaying payment sources

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "5.9KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "5KB" },
 { "path": "./dist/checkout*.js", "maxSize": "3KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.1KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.2KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/sessionTasks*.js", "maxSize": "1KB" }
Expand Down

28 changes: 9 additions & 19 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@@ -9,13 +9,13 @@ import type {
import { useMemo, useState } from 'react';

import { __experimental_PaymentSourcesContext, useCheckoutContext } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, Icon, localizationKeys, Text } from '../../customizables';
import { Box, Button, Col, descriptors, Form, localizationKeys } from '../../customizables';
import { Alert, Disclosure, Divider, Drawer, LineItems, Select, SelectButton, SelectOptionList } from '../../elements';
import { useFetch } from '../../hooks';
import { ArrowUpDown, CreditCard } from '../../icons';
import { ArrowUpDown } from '../../icons';
import { animations } from '../../styledSystem';
import { handleError } from '../../utils';
import { AddPaymentSource } from '../PaymentSources';
import { AddPaymentSource, PaymentSourceRow } from '../PaymentSources';

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

Expand DownExpand Up@@ -170,6 +170,7 @@ const CheckoutFormElements = ({
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
 checkout={checkout}
 paymentSources={paymentSources}
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
 onPaymentSourceSubmit={onPaymentSourceSubmit}
Expand DownExpand Up@@ -208,19 +209,21 @@ const CheckoutFormElements = ({
};

const PaymentSourceMethods = ({
 checkout,
 totalDueNow,
 paymentSources,
 onPaymentSourceSubmit,
 isSubmitting,
}: {
 checkout: __experimental_CommerceCheckoutResource;
 totalDueNow: __experimental_CommerceMoney;
 paymentSources: __experimental_CommercePaymentSourceResource[];
 onPaymentSourceSubmit: React.FormEventHandler<HTMLFormElement>;
 isSubmitting: boolean;
}) => {
 const [selectedPaymentSource, setSelectedPaymentSource] = useState<
 __experimental_CommercePaymentSourceResource | undefined
 >(paymentSources.length > 0 ? paymentSources[0] : undefined);
 >(checkout.paymentSource || paymentSources.find(p => p.isDefault));

 const options = useMemo(() => {
 return paymentSources.map(source => {
Expand All@@ -241,7 +244,7 @@ const PaymentSourceMethods = ({
 })}
 >
 <Select
 elementId='role'
 elementId='paymentSource'
 options={options}
 value={selectedPaymentSource?.id || null}
 onChange={option => {
Expand All@@ -263,20 +266,7 @@ const PaymentSourceMethods = ({
 backgroundColor: t.colors.$colorBackground,
 })}
 >
 {selectedPaymentSource && (
 <Flex
 gap={3}
 align='center'
 >
 <Icon icon={CreditCard} />
 <Text
 as='span'
 colorScheme='body'
 >
 {capitalize(selectedPaymentSource.cardType)} ⋯ {selectedPaymentSource.last4}
 </Text>
 </Flex>
 )}
 {selectedPaymentSource && <PaymentSourceRow paymentSource={selectedPaymentSource} />}
 </SelectButton>
 <SelectOptionList
 sx={t => ({
Expand Down

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx

View file


Open in desktop

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

import { Badge, descriptors, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { ApplePay, CreditCard } from '../../icons';

export const PaymentSourceRow = ({
 paymentSource,
}: {
 paymentSource: __experimental_CommercePaymentSourceResource;
}) => {
 return (
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 elementDescriptor={descriptors.paymentSourceRow}
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 elementDescriptor={descriptors.paymentSourceRowIcon}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 elementDescriptor={descriptors.paymentSourceRowType}
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 elementDescriptor={descriptors.paymentSourceRowValue}
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('default')}
 localizationKey={localizationKeys('badge__default')}
 />
 )}
 {paymentSource.status === 'expired' && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('expired')}
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 );
};

35 changes: 3 additions & 32 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,14 +4,14 @@ import { Fragment, useRef } from 'react';

import { RemoveResourceForm } from '../../common';
import { usePaymentSourcesContext } from '../../contexts';
import { Badge, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { localizationKeys } from '../../customizables';
import { ProfileSection, ThreeDotsMenu, useCardState } from '../../elements';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
import { useFetch } from '../../hooks';
import { ApplePay, CreditCard } from '../../icons';
import { handleError } from '../../utils';
import { AddPaymentSource } from './AddPaymentSource';
import { PaymentSourceRow } from './PaymentSourceRow';

const AddScreen = ({ onSuccess }: { onSuccess: () => void }) => {
 const { close } = useActionContext();
Expand DownExpand Up@@ -108,36 +108,7 @@ const PaymentSources = (_: __experimental_PaymentSourcesProps) => {
 {paymentSources.map(paymentSource => (
 <Fragment key={paymentSource.id}>
 <ProfileSection.Item id='paymentSources'>
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && <Badge localizationKey={localizationKeys('badge__default')} />}
 {paymentSource.status === 'expired' && (
 <Badge
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidate}
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export * from './AddPaymentSource';
export * from './PaymentSources';
export * from './PaymentSourceRow';

7 changes: 7 additions & 0 deletions
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -330,6 +330,13 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'selectOptionsContainer',
 'selectOption',

 'paymentSourceRow',
 'paymentSourceRowIcon',
 'paymentSourceRowText',
 'paymentSourceRowType',
 'paymentSourceRowValue',
 'paymentSourceRowBadge',

 'menuButton',
 'menuButtonEllipsis',
 'menuList',
Expand Down

7 changes: 7 additions & 0 deletions
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -454,6 +454,13 @@ export type ElementsConfig = {
 selectOptionsContainer: WithOptions<SelectId>;
 selectOption: WithOptions<SelectId>;

 paymentSourceRow: WithOptions;
 paymentSourceRowIcon: WithOptions;
 paymentSourceRowText: WithOptions;
 paymentSourceRowType: WithOptions;
 paymentSourceRowValue: WithOptions;
 paymentSourceRowBadge: WithOptions<'default' | 'expired'>;

 menuButton: WithOptions<MenuId>;
 menuButtonEllipsis: WithOptions;
 menuList: WithOptions<MenuId>;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,4 +52,4 @@ export type OrganizationPreviewId =
export type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey' | 'waitlist';

export type MenuId = 'invitation' | 'member' | ProfileSectionId;
export type SelectId = 'countryCode' | 'role';
export type SelectId = 'countryCode' | 'role' | 'paymentSource';

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

aeliox
merged 4 commits into

from

Apr 13, 2025
 Merged


feat(clerk-js,types): Add PaymentSourceRow for displaying payment sources
#5570
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e67596

add PaymentSourceRow


aeliox Apr 9, 2025
7439e25

bundle size bump


aeliox Apr 9, 2025
fd0ba8d

add/update descriptors


alexcarpenter Apr 11, 2025
1ef5a36

Merge branch 'main' into keiran/payment-source-row


alexcarpenter Apr 11, 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/tall-clocks-call.md

View file


Open in desktop

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

Add `PaymentSourceRow` for displaying payment sources

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@
 { "path": "./dist/keylessPrompt*.js", "maxSize": "5.9KB" },
 { "path": "./dist/pricingTable*.js", "maxSize": "5KB" },
 { "path": "./dist/checkout*.js", "maxSize": "3KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.1KB" },
 { "path": "./dist/paymentSources*.js", "maxSize": "8.2KB" },
 { "path": "./dist/up-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/op-billing-page*.js", "maxSize": "1KB" },
 { "path": "./dist/sessionTasks*.js", "maxSize": "1KB" }
Expand Down

28 changes: 9 additions & 19 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@@ -9,13 +9,13 @@ import type {
import { useMemo, useState } from 'react';

import { __experimental_PaymentSourcesContext, useCheckoutContext } from '../../contexts';
import { Box, Button, Col, descriptors, Flex, Form, Icon, localizationKeys, Text } from '../../customizables';
import { Box, Button, Col, descriptors, Form, localizationKeys } from '../../customizables';
import { Alert, Disclosure, Divider, Drawer, LineItems, Select, SelectButton, SelectOptionList } from '../../elements';
import { useFetch } from '../../hooks';
import { ArrowUpDown, CreditCard } from '../../icons';
import { ArrowUpDown } from '../../icons';
import { animations } from '../../styledSystem';
import { handleError } from '../../utils';
import { AddPaymentSource } from '../PaymentSources';
import { AddPaymentSource, PaymentSourceRow } from '../PaymentSources';

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

Expand DownExpand Up@@ -170,6 +170,7 @@ const CheckoutFormElements = ({
 <Disclosure.Content>
 <Col gap={3}>
 <PaymentSourceMethods
 checkout={checkout}
 paymentSources={paymentSources}
 totalDueNow={checkout.totals.totalDueNow || checkout.totals.grandTotal}
 onPaymentSourceSubmit={onPaymentSourceSubmit}
Expand DownExpand Up@@ -208,19 +209,21 @@ const CheckoutFormElements = ({
};

const PaymentSourceMethods = ({
 checkout,
 totalDueNow,
 paymentSources,
 onPaymentSourceSubmit,
 isSubmitting,
}: {
 checkout: __experimental_CommerceCheckoutResource;
 totalDueNow: __experimental_CommerceMoney;
 paymentSources: __experimental_CommercePaymentSourceResource[];
 onPaymentSourceSubmit: React.FormEventHandler<HTMLFormElement>;
 isSubmitting: boolean;
}) => {
 const [selectedPaymentSource, setSelectedPaymentSource] = useState<
 __experimental_CommercePaymentSourceResource | undefined
 >(paymentSources.length > 0 ? paymentSources[0] : undefined);
 >(checkout.paymentSource || paymentSources.find(p => p.isDefault));

 const options = useMemo(() => {
 return paymentSources.map(source => {
Expand All@@ -241,7 +244,7 @@ const PaymentSourceMethods = ({
 })}
 >
 <Select
 elementId='role'
 elementId='paymentSource'
 options={options}
 value={selectedPaymentSource?.id || null}
 onChange={option => {
Expand All@@ -263,20 +266,7 @@ const PaymentSourceMethods = ({
 backgroundColor: t.colors.$colorBackground,
 })}
 >
 {selectedPaymentSource && (
 <Flex
 gap={3}
 align='center'
 >
 <Icon icon={CreditCard} />
 <Text
 as='span'
 colorScheme='body'
 >
 {capitalize(selectedPaymentSource.cardType)} ⋯ {selectedPaymentSource.last4}
 </Text>
 </Flex>
 )}
 {selectedPaymentSource && <PaymentSourceRow paymentSource={selectedPaymentSource} />}
 </SelectButton>
 <SelectOptionList
 sx={t => ({
Expand Down

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx

View file


Open in desktop

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

import { Badge, descriptors, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { ApplePay, CreditCard } from '../../icons';

export const PaymentSourceRow = ({
 paymentSource,
}: {
 paymentSource: __experimental_CommercePaymentSourceResource;
}) => {
 return (
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 elementDescriptor={descriptors.paymentSourceRow}
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 elementDescriptor={descriptors.paymentSourceRowIcon}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 elementDescriptor={descriptors.paymentSourceRowType}
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 elementDescriptor={descriptors.paymentSourceRowValue}
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('default')}
 localizationKey={localizationKeys('badge__default')}
 />
 )}
 {paymentSource.status === 'expired' && (
 <Badge
 elementDescriptor={descriptors.paymentSourceRowBadge}
 elementId={descriptors.paymentSourceRowBadge.setId('expired')}
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 );
};

35 changes: 3 additions & 32 deletions
packages/clerk-js/src/ui/components/PaymentSources/PaymentSources.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,14 +4,14 @@ import { Fragment, useRef } from 'react';

import { RemoveResourceForm } from '../../common';
import { usePaymentSourcesContext } from '../../contexts';
import { Badge, Flex, Icon, localizationKeys, Text } from '../../customizables';
import { localizationKeys } from '../../customizables';
import { ProfileSection, ThreeDotsMenu, useCardState } from '../../elements';
import { Action } from '../../elements/Action';
import { useActionContext } from '../../elements/Action/ActionRoot';
import { useFetch } from '../../hooks';
import { ApplePay, CreditCard } from '../../icons';
import { handleError } from '../../utils';
import { AddPaymentSource } from './AddPaymentSource';
import { PaymentSourceRow } from './PaymentSourceRow';

const AddScreen = ({ onSuccess }: { onSuccess: () => void }) => {
 const { close } = useActionContext();
Expand DownExpand Up@@ -108,36 +108,7 @@ const PaymentSources = (_: __experimental_PaymentSourcesProps) => {
 {paymentSources.map(paymentSource => (
 <Fragment key={paymentSource.id}>
 <ProfileSection.Item id='paymentSources'>
 <Flex
 sx={{ overflow: 'hidden' }}
 gap={2}
 align='baseline'
 >
 <Icon
 icon={paymentSource.walletType === 'apple_pay' ? ApplePay : CreditCard}
 sx={{ alignSelf: 'center' }}
 />
 <Text
 sx={t => ({ color: t.colors.$colorText, textTransform: 'capitalize' })}
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? paymentSource.cardType : paymentSource.paymentMethod}
 </Text>
 <Text
 sx={t => ({ color: t.colors.$colorTextSecondary })}
 variant='caption'
 truncate
 >
 {paymentSource.paymentMethod === 'card' ? `⋯ ${paymentSource.last4}` : '-'}
 </Text>
 {paymentSource.isDefault && <Badge localizationKey={localizationKeys('badge__default')} />}
 {paymentSource.status === 'expired' && (
 <Badge
 colorScheme='danger'
 localizationKey={localizationKeys('badge__expired')}
 />
 )}
 </Flex>
 <PaymentSourceRow paymentSource={paymentSource} />
 <PaymentSourceMenu
 paymentSource={paymentSource}
 revalidate={revalidate}
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/components/PaymentSources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
export * from './AddPaymentSource';
export * from './PaymentSources';
export * from './PaymentSourceRow';

7 changes: 7 additions & 0 deletions
packages/clerk-js/src/ui/customizables/elementDescriptors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -330,6 +330,13 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
 'selectOptionsContainer',
 'selectOption',

 'paymentSourceRow',
 'paymentSourceRowIcon',
 'paymentSourceRowText',
 'paymentSourceRowType',
 'paymentSourceRowValue',
 'paymentSourceRowBadge',

 'menuButton',
 'menuButtonEllipsis',
 'menuList',
Expand Down

7 changes: 7 additions & 0 deletions
packages/types/src/appearance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -454,6 +454,13 @@ export type ElementsConfig = {
 selectOptionsContainer: WithOptions<SelectId>;
 selectOption: WithOptions<SelectId>;

 paymentSourceRow: WithOptions;
 paymentSourceRowIcon: WithOptions;
 paymentSourceRowText: WithOptions;
 paymentSourceRowType: WithOptions;
 paymentSourceRowValue: WithOptions;
 paymentSourceRowBadge: WithOptions<'default' | 'expired'>;

 menuButton: WithOptions<MenuId>;
 menuButtonEllipsis: WithOptions;
 menuList: WithOptions<MenuId>;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,4 +52,4 @@ export type OrganizationPreviewId =
export type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey' | 'waitlist';

export type MenuId = 'invitation' | 'member' | ProfileSectionId;
export type SelectId = 'countryCode' | 'role';
export type SelectId = 'countryCode' | 'role' | 'paymentSource';