Skip to content

fix(clerk-js): Require label for Switch #5845

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
merged 2 commits into from
May 6, 2025
Merged

fix(clerk-js): Require label for Switch #5845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42c3104
initial
LekoArts May 5, 2025
0872fe4
changeset
LekoArts May 5, 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/upset-ravens-love.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Update internal Switch component to require a label.
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ const CardHeader = React.forwardRef<HTMLDivElement, CardHeaderProps>((props, ref
})}
>
<Switch
checked={planPeriod === 'annual'}
isChecked={planPeriod === 'annual'}
onChange={(checked: boolean) => setPlanPeriod(checked ? 'annual' : 'month')}
label={localizationKeys('commerce.billedAnnually')}
/>
Expand Down
41 changes: 19 additions & 22 deletions packages/clerk-js/src/ui/elements/Switch.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,21 @@ import { descriptors, Flex, Text } from '../customizables';
import { common } from '../styledSystem';

interface SwitchProps {
checked?: boolean;
isChecked?: boolean;
defaultChecked?: boolean;
onChange?: (checked: boolean) => void;
disabled?: boolean;
'aria-label'?: string;
label?: string | LocalizationKey;
isDisabled?: boolean;
label: string | LocalizationKey;
}

export const Switch = forwardRef<HTMLDivElement, SwitchProps>(
({ checked: controlledChecked, defaultChecked, onChange, disabled = false, label }, ref) => {
({ isChecked: controlledChecked, defaultChecked, onChange, isDisabled = false, label }, ref) => {
const [internalChecked, setInternalChecked] = useState(!!defaultChecked);
const isControlled = controlledChecked !== undefined;
const checked = isControlled ? controlledChecked : internalChecked;

const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
if (disabled) return;
if (isDisabled) return;
if (!isControlled) {
setInternalChecked(e.target.checked);
}
Expand All @@ -45,7 +44,7 @@ export const Switch = forwardRef<HTMLDivElement, SwitchProps>(
<input
type='checkbox'
role='switch'
disabled={disabled}
disabled={isDisabled}
defaultChecked={defaultChecked}
checked={checked}
onChange={handleChange}
Expand All @@ -65,8 +64,8 @@ export const Switch = forwardRef<HTMLDivElement, SwitchProps>(
backgroundColor: checked ? t.colors.$primary500 : t.colors.$neutralAlpha150,
borderRadius: 999,
transition: 'background-color 0.2s',
opacity: disabled ? 0.6 : 1,
cursor: disabled ? 'not-allowed' : 'pointer',
opacity: isDisabled ? 0.6 : 1,
cursor: isDisabled ? 'not-allowed' : 'pointer',
outline: 'none',
boxSizing: 'border-box',
boxShadow: '0px 0px 0px 1px rgba(0, 0, 0, 0.06) inset',
Expand All @@ -89,19 +88,17 @@ export const Switch = forwardRef<HTMLDivElement, SwitchProps>(
})}
/>
</Flex>
{label && (
<Text
as='span'
variant='caption'
colorScheme='secondary'
localizationKey={label}
sx={t => ({
paddingInlineStart: t.sizes.$2,
cursor: disabled ? 'not-allowed' : 'pointer',
userSelect: 'none',
})}
/>
)}
<Text
as='span'
variant='caption'
colorScheme='secondary'
localizationKey={label}
sx={t => ({
paddingInlineStart: t.sizes.$2,
cursor: isDisabled ? 'not-allowed' : 'pointer',
userSelect: 'none',
})}
/>
</Flex>
);
},
Expand Down