Skip to content

fix(clerk-js): Reduce unnecessary re-renders on CheckoutComplete #6765

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 1 commit into from
Sep 14, 2025
+151 −133
Merged

fix(clerk-js): Reduce unnecessary re-renders on CheckoutComplete #6765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/tangy-snails-poke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Performance improvements for `<Checkout />`.
279 changes: 146 additions & 133 deletions packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,160 @@ import { useRouter } from '../../router';
const capitalize = (name: string) => name[0].toUpperCase() + name.slice(1);
const lerp = (start: number, end: number, amt: number) => start + (end - start) * amt;

const SuccessRing = ({ positionX, positionY }: { positionX: number; positionY: number }) => {
const animationRef = useRef<number | null>(null);
const [currentPosition, setCurrentPosition] = useState({ x: 256, y: 256 });

const canHover =
typeof window === 'undefined' ? true : window.matchMedia('(hover: hover) and (pointer: fine)').matches;

useEffect(() => {
if (!canHover) {
return;
}
Comment on lines +21 to +27
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Honor reduced-motion and gate the animation accordingly.

SuccessRing ignores prefers-reduced-motion and still runs rAF. Gate both the effect and highlight.

Apply this diff:

@@
-  const canHover =
-    typeof window === 'undefined' ? true : window.matchMedia('(hover: hover) and (pointer: fine)').matches;
+  const canHover =
+    typeof window === 'undefined' ? false : window.matchMedia('(hover: hover) and (pointer: fine)').matches;
+  const prefersReducedMotion = usePrefersReducedMotion();
+  const isMotionSafe = !prefersReducedMotion;
@@
-  useEffect(() => {
-    if (!canHover) {
+  useEffect(() => {
+    if (!canHover || !isMotionSafe) {
       return;
     }
@@
-  }, [positionX, positionY, canHover]);
+  }, [positionX, positionY, canHover, isMotionSafe]);
@@
-        {canHover && (
+        {canHover && isMotionSafe && (

Also applies to: 24-44, 143-153

🤖 Prompt for AI Agents 
In packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx around
lines 21-27 (and similarly for ranges 24-44 and 143-153), the component
currently checks only for hover capability but ignores the user's
prefers-reduced-motion setting; update the logic to also detect
prefers-reduced-motion via window.matchMedia('(prefers-reduced-motion:
reduce)').matches and gate both the useEffect that runs requestAnimationFrame
and any highlight/animation rendering by returning early when
prefersReducedMotion is true (i.e., treat either !canHover or
prefersReducedMotion as reasons to skip the effect), and ensure any
highlight/animated class or element is not applied/rendered when reduced motion
is requested.

const animate = () => {
setCurrentPosition(prev => {
const amt = 0.15;
const x = lerp(prev.x, positionX, amt);
const y = lerp(prev.y, positionY, amt);
return { x, y };
});
animationRef.current = requestAnimationFrame(animate);
};
animationRef.current = requestAnimationFrame(animate);
Comment on lines +28 to +37
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Stop the rAF loop when the target is reached to avoid perpetual re-renders.

The loop runs forever even when the point stabilizes. Add an epsilon and stop scheduling.

Apply this diff:

-    const animate = () => {
-      setCurrentPosition(prev => {
-        const amt = 0.15;
-        const x = lerp(prev.x, positionX, amt);
-        const y = lerp(prev.y, positionY, amt);
-        return { x, y };
-      });
-      animationRef.current = requestAnimationFrame(animate);
-    };
+    const animate = () => {
+      let continueAnim = false;
+      setCurrentPosition(prev => {
+        const amt = 0.15;
+        const x = lerp(prev.x, positionX, amt);
+        const y = lerp(prev.y, positionY, amt);
+        continueAnim = Math.hypot(x - prev.x, y - prev.y) > 0.5;
+        return { x, y };
+      });
+      if (continueAnim) {
+        animationRef.current = requestAnimationFrame(animate);
+      } else {
+        animationRef.current = null;
+      }
+    };

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents 
In packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx around
lines 28–37, the requestAnimationFrame loop never stops once the point
stabilizes; add a small epsilon threshold (e.g., 0.5 pixels or a small
squared-distance) to detect when lerp has effectively reached the target, and
stop scheduling further frames by calling
cancelAnimationFrame(animationRef.current) and clearing animationRef.current
when within that threshold; only call requestAnimationFrame(animate) if the
distance is above epsilon, and ensure any existing animation is cancelled before
starting a new loop.

return () => {
if (animationRef.current) {
cancelAnimationFrame(animationRef.current);
}
};
}, [positionX, positionY, canHover]);

// Generate unique IDs for SVG elements to avoid conflicts with multiple component instances
const maskId1 = useId();
const maskId2 = useId();
const maskId3 = useId();

Comment on lines +45 to +49
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Make all SVG IDs unique to prevent collisions when multiple instances render.

Static IDs for the radialGradient, filter, and mask can collide. Generate unique IDs and update references.

Apply this diff:

@@
-  // Generate unique IDs for SVG elements to avoid conflicts with multiple component instances
-  const maskId1 = useId();
-  const maskId2 = useId();
-  const maskId3 = useId();
+  // Generate unique IDs per instance to avoid <defs> collisions
+  const maskId1 = useId();
+  const maskId2 = useId();
+  const maskId3 = useId();
+  const uid = useId();
+  const mainMaskId = `clerk-checkout-success-mask-${uid}`;
+  const radialGradientId = `clerk-checkout-success-gradient-${uid}`;
+  const blurFilterId = `clerk-checkout-success-blur-effect-${uid}`;
@@
-        <radialGradient id='clerk-checkout-success-gradient'>
+        <radialGradient id={radialGradientId}>
@@
-        <filter id='clerk-checkout-success-blur-effect'>
+        <filter id={blurFilterId}>
@@
-        <mask id='clerk-checkout-success-mask'>
+        <mask id={mainMaskId}>
@@
-      <g mask='url(#clerk-checkout-success-mask)'>
+      <g mask={`url(#${mainMaskId})`}>
@@
-            fill='url(#clerk-checkout-success-gradient)'
-            filter='url(#clerk-checkout-success-blur-effect)'
+            fill={`url(#${radialGradientId})`}
+            filter={`url(#${blurFilterId})`}

Also applies to: 64-82, 117-117, 135-135, 150-151

🤖 Prompt for AI Agents 
In packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx around
lines 45-49, 64-82, 117, 135, and 150-151, the SVG IDs (for radialGradient,
filter, mask, etc.) are currently static and can collide across multiple
component instances; replace each static ID with a unique ID generated via useId
(or similar) at the top of the component and update every SVG attribute
reference (id, href/xlink:href, mask, filter, clipPath, etc.) to use those
generated IDs so each instance uses distinct identifiers and avoids collisions.

return (
<Box
elementDescriptor={descriptors.checkoutSuccessRings}
as='svg'
// @ts-ignore - viewBox is a valid prop for svg
viewBox='0 0 512 512'
sx={{
position: 'absolute',
inset: 0,
pointerEvents: 'none',
}}
aria-hidden
>
<defs>
<radialGradient id='clerk-checkout-success-gradient'>
<stop
offset='0%'
style={{
stopColor: 'var(--ring-highlight)',
}}
/>
<stop
offset='100%'
stopOpacity='0'
style={{
stopColor: 'var(--ring-highlight)',
}}
/>
</radialGradient>
<filter id='clerk-checkout-success-blur-effect'>
<feGaussianBlur stdDeviation='10' />
</filter>
{[
{ r: 225, maskStart: 10, maskEnd: 90, id: maskId1 },
{ r: 162.5, maskStart: 15, maskEnd: 85, id: maskId2 },
{ r: 100, maskStart: 20, maskEnd: 80, id: maskId3 },
].map(({ maskStart, maskEnd, id }) => (
<linearGradient
key={id}
id={`gradient-${id}`}
x1='0%'
y1='0%'
x2='0%'
y2='100%'
>
<stop
offset={`${maskStart + 5}%`}
stopColor='white'
stopOpacity='0'
/>
<stop
offset={`${maskStart + 35}%`}
stopColor='white'
stopOpacity='1'
/>
<stop
offset={`${maskEnd - 35}%`}
stopColor='white'
stopOpacity='1'
/>
<stop
offset={`${maskEnd - 5}%`}
stopColor='white'
stopOpacity='0'
/>
</linearGradient>
))}
<mask id='clerk-checkout-success-mask'>
{[
{ r: 225, id: maskId1 },
{ r: 162.5, id: maskId2 },
{ r: 100, id: maskId3 },
].map(({ r, id }) => (
<circle
key={id}
cx='256'
cy='256'
r={r}
stroke={`url(#gradient-${id})`}
fill='none'
strokeWidth='1'
/>
))}
</mask>
</defs>
<g mask='url(#clerk-checkout-success-mask)'>
<rect
width='512'
height='512'
style={{
fill: 'var(--ring-fill)',
}}
/>
{canHover && (
<rect
id='movingGradientHighlight'
width='256'
height='256'
x={currentPosition.x - 128}
y={currentPosition.y - 128}
fill='url(#clerk-checkout-success-gradient)'
filter='url(#clerk-checkout-success-blur-effect)'
/>
)}
</g>
</Box>
);
};

export const CheckoutComplete = () => {
const router = useRouter();
const { setIsOpen } = useDrawerContext();
const { newSubscriptionRedirectUrl } = useCheckoutContext();
const { checkout } = useCheckout();
const { totals, paymentSource, planPeriodStart, freeTrialEndsAt } = checkout;
const [mousePosition, setMousePosition] = useState({ x: 256, y: 256 });
const [currentPosition, setCurrentPosition] = useState({ x: 256, y: 256 });

// Generate unique IDs for SVG elements to avoid conflicts with multiple component instances
const maskId1 = useId();
const maskId2 = useId();
const maskId3 = useId();

const prefersReducedMotion = usePrefersReducedMotion();
const { animations: layoutAnimations } = useAppearance().parsedLayout;
const isMotionSafe = !prefersReducedMotion && layoutAnimations === true;

const animationRef = useRef<number | null>(null);
const checkoutSuccessRootRef = useRef<HTMLSpanElement>(null);
const canHover =
typeof window === 'undefined' ? true : window.matchMedia('(hover: hover) and (pointer: fine)').matches;
Expand All @@ -59,27 +194,6 @@ export const CheckoutComplete = () => {
}
};

useEffect(() => {
if (!canHover) {
return;
}
const animate = () => {
setCurrentPosition(prev => {
const amt = 0.15;
const x = lerp(prev.x, mousePosition.x, amt);
const y = lerp(prev.y, mousePosition.y, amt);
return { x, y };
});
animationRef.current = requestAnimationFrame(animate);
};
animationRef.current = requestAnimationFrame(animate);
return () => {
if (animationRef.current) {
cancelAnimationFrame(animationRef.current);
}
};
}, [mousePosition, canHover]);

const handleClose = () => {
if (newSubscriptionRedirectUrl) {
void router.navigate(newSubscriptionRedirectUrl);
Expand Down Expand Up @@ -135,111 +249,10 @@ export const CheckoutComplete = () => {
ref={checkoutSuccessRootRef}
onMouseMove={handleMouseMove}
>
<Box
elementDescriptor={descriptors.checkoutSuccessRings}
as='svg'
// @ts-ignore - viewBox is a valid prop for svg
viewBox='0 0 512 512'
sx={{
position: 'absolute',
inset: 0,
pointerEvents: 'none',
}}
aria-hidden
>
<defs>
<radialGradient id='clerk-checkout-success-gradient'>
<stop
offset='0%'
style={{
stopColor: 'var(--ring-highlight)',
}}
/>
<stop
offset='100%'
stopOpacity='0'
style={{
stopColor: 'var(--ring-highlight)',
}}
/>
</radialGradient>
<filter id='clerk-checkout-success-blur-effect'>
<feGaussianBlur stdDeviation='10' />
</filter>
{[
{ r: 225, maskStart: 10, maskEnd: 90, id: maskId1 },
{ r: 162.5, maskStart: 15, maskEnd: 85, id: maskId2 },
{ r: 100, maskStart: 20, maskEnd: 80, id: maskId3 },
].map(({ maskStart, maskEnd, id }) => (
<linearGradient
key={id}
id={`gradient-${id}`}
x1='0%'
y1='0%'
x2='0%'
y2='100%'
>
<stop
offset={`${maskStart + 5}%`}
stopColor='white'
stopOpacity='0'
/>
<stop
offset={`${maskStart + 35}%`}
stopColor='white'
stopOpacity='1'
/>
<stop
offset={`${maskEnd - 35}%`}
stopColor='white'
stopOpacity='1'
/>
<stop
offset={`${maskEnd - 5}%`}
stopColor='white'
stopOpacity='0'
/>
</linearGradient>
))}
<mask id='clerk-checkout-success-mask'>
{[
{ r: 225, id: maskId1 },
{ r: 162.5, id: maskId2 },
{ r: 100, id: maskId3 },
].map(({ r, id }) => (
<circle
key={id}
cx='256'
cy='256'
r={r}
stroke={`url(#gradient-${id})`}
fill='none'
strokeWidth='1'
/>
))}
</mask>
</defs>
<g mask='url(#clerk-checkout-success-mask)'>
<rect
width='512'
height='512'
style={{
fill: 'var(--ring-fill)',
}}
/>
{canHover && (
<rect
id='movingGradientHighlight'
width='256'
height='256'
x={currentPosition.x - 128}
y={currentPosition.y - 128}
fill='url(#clerk-checkout-success-gradient)'
filter='url(#clerk-checkout-success-blur-effect)'
/>
)}
</g>
</Box>
<SuccessRing
positionX={mousePosition.x}
positionY={mousePosition.y}
/>
<Box
elementDescriptor={descriptors.checkoutSuccessBadge}
sx={t => ({
Expand Down