Skip to content

refactor(clerk-js): SocialButtons layout logic #6379

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

refactor(clerk-js): SocialButtons layout logic #6379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e8175a
refactor(clerk-js): SocialButtons layout logic
alexcarpenter Jul 23, 2025
61bf98a
add changeset
alexcarpenter Jul 23, 2025
f3bd484
Remove marginBottom from SocialButtons container
alexcarpenter Jul 23, 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/salty-jokes-hide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
Copy link
Member Author

Choose a reason for hiding this comment

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

maybe a minor?

---

Update SocialButtons layout logic to live within a single flex container to enable moving SocialButtons between rows using CSS order property.
140 changes: 68 additions & 72 deletions packages/clerk-js/src/ui/elements/SocialButtons.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import {
Button,
descriptors,
Flex,
Grid,
Icon,
Image,
localizationKeys,
Expand All @@ -22,11 +21,9 @@ import { useEnabledThirdPartyProviders } from '../hooks';
import { mqu, type PropsOfComponent } from '../styledSystem';
import { sleep } from '../utils/sleep';
import { useCardState } from './contexts';
import { distributeStrategiesIntoRows } from './utils';

const SOCIAL_BUTTON_BLOCK_THRESHOLD = 2;
const SOCIAL_BUTTON_PRE_TEXT_THRESHOLD = 1;
const MAX_STRATEGIES_PER_ROW = 6;

export type SocialButtonsProps = React.PropsWithChildren<{
enableOAuthProviders: boolean;
Expand All @@ -49,6 +46,11 @@ const isPhoneCodeChannel = (val: string): val is PhoneCodeChannel => {
return !!getAlternativePhoneCodeProviderData(val);
};

function getColumnCount(itemsLength: number, maxCols: number = 6): number {
const numRows = Math.ceil(itemsLength / maxCols);
return Math.ceil(itemsLength / numRows);
}

export const SocialButtons = React.memo((props: SocialButtonsRootProps) => {
const {
oauthCallback,
Expand All @@ -70,13 +72,12 @@ export const SocialButtons = React.memo((props: SocialButtonsRootProps) => {
...(enableAlternativePhoneCodeProviders ? alternativePhoneCodeChannels : []),
];

const columns = React.useMemo(() => getColumnCount(strategies.length), [strategies.length]);

if (!strategies.length) {
return null;
}

const strategyRows = distributeStrategiesIntoRows([...strategies], MAX_STRATEGIES_PER_ROW);
const strategyRowOneLength = strategyRows.at(0)?.length ?? 0;

const preferBlockButtons =
socialButtonsVariant === 'blockButton'
? true
Expand Down Expand Up @@ -118,77 +119,72 @@ export const SocialButtons = React.memo((props: SocialButtonsRootProps) => {
gap={2}
elementDescriptor={descriptors.socialButtonsRoot}
>
{strategyRows.map((row, rowIndex) => (
<Grid
key={row.join('-')}
elementDescriptor={descriptors.socialButtons}
gap={2}
sx={t => ({
justifyContent: 'center',
<Flex
sx={t => ({
'--columns': columns,
'--gap': t.space.$2,
'--item-width': `calc(100% / var(--columns) - var(--gap) / var(--columns) * (var(--columns) - 1))`,
flexDirection: 'row',
width: '100%',
justifyContent: 'center',
flexWrap: 'wrap',
gap: 'var(--gap)',
'& > *': {
flex: '0 0 var(--item-width)',
[mqu.sm]: {
gridTemplateColumns: 'repeat(1, 1fr)',
flex: '0 0 100%',
},
gridTemplateColumns:
strategies.length < 1
? `repeat(1, 1fr)`
: `repeat(${row.length}, ${
rowIndex === 0
? `1fr`
: // Calculate the width of each button based on the width of the buttons within the first row.
// t.sizes.$2 is used here to represent the gap defined on the Grid component.
`calc((100% - (${strategyRowOneLength} - 1) * ${t.sizes.$2}) / ${strategyRowOneLength})`
})`,
})}
>
{row.map(strategy => {
const label =
strategies.length === SOCIAL_BUTTON_PRE_TEXT_THRESHOLD
? `Continue with ${strategyToDisplayData[strategy].name}`
: strategyToDisplayData[strategy].name;
},
})}
>
{strategies.map(strategy => {
const label =
strategies.length === SOCIAL_BUTTON_PRE_TEXT_THRESHOLD
? `Continue with ${strategyToDisplayData[strategy].name}`
: strategyToDisplayData[strategy].name;

const localizedText =
strategies.length === SOCIAL_BUTTON_PRE_TEXT_THRESHOLD
? localizationKeys('socialButtonsBlockButton', {
provider: strategyToDisplayData[strategy].name,
})
: localizationKeys('socialButtonsBlockButtonManyInView', {
provider: strategyToDisplayData[strategy].name,
});
const localizedText =
strategies.length === SOCIAL_BUTTON_PRE_TEXT_THRESHOLD
? localizationKeys('socialButtonsBlockButton', {
provider: strategyToDisplayData[strategy].name,
})
: localizationKeys('socialButtonsBlockButtonManyInView', {
provider: strategyToDisplayData[strategy].name,
});

const imageOrInitial = strategyToDisplayData[strategy].iconUrl ? (
<Image
elementDescriptor={[descriptors.providerIcon, descriptors.socialButtonsProviderIcon]}
elementId={descriptors.socialButtonsProviderIcon.setId(strategyToDisplayData[strategy].id)}
isLoading={card.loadingMetadata === strategy}
isDisabled={card.isLoading}
src={strategyToDisplayData[strategy].iconUrl}
alt={`Sign in with ${strategyToDisplayData[strategy].name}`}
sx={theme => ({ width: theme.sizes.$4, height: 'auto', maxWidth: '100%' })}
/>
) : (
<ProviderInitialIcon
id={strategyToDisplayData[strategy].id}
value={strategyToDisplayData[strategy].name}
isLoading={card.loadingMetadata === strategy}
isDisabled={card.isLoading}
/>
);
const imageOrInitial = strategyToDisplayData[strategy].iconUrl ? (
<Image
elementDescriptor={[descriptors.providerIcon, descriptors.socialButtonsProviderIcon]}
elementId={descriptors.socialButtonsProviderIcon.setId(strategyToDisplayData[strategy].id)}
isLoading={card.loadingMetadata === strategy}
isDisabled={card.isLoading}
src={strategyToDisplayData[strategy].iconUrl}
alt={`Sign in with ${strategyToDisplayData[strategy].name}`}
sx={theme => ({ width: theme.sizes.$4, height: 'auto', maxWidth: '100%' })}
/>
) : (
<ProviderInitialIcon
id={strategyToDisplayData[strategy].id}
value={strategyToDisplayData[strategy].name}
isLoading={card.loadingMetadata === strategy}
isDisabled={card.isLoading}
/>
);

return (
<ButtonElement
key={strategy}
id={strategyToDisplayData[strategy].id}
onClick={onSocialButtonClick(strategy)}
isLoading={card.loadingMetadata === strategy}
isDisabled={card.isLoading}
label={label}
textLocalizationKey={localizedText}
icon={imageOrInitial}
/>
);
})}
</Grid>
))}
return (
<ButtonElement
key={strategy}
id={strategyToDisplayData[strategy].id}
onClick={onSocialButtonClick(strategy)}
isLoading={card.loadingMetadata === strategy}
isDisabled={card.isLoading}
label={label}
textLocalizationKey={localizedText}
icon={imageOrInitial}
/>
);
})}
</Flex>
</Flex>
);
});
Expand Down
24 changes: 0 additions & 24 deletions packages/clerk-js/src/ui/elements/utils.ts
View file
Open in desktop

This file was deleted.

Loading