Skip to content

feat(clerk-js): Add transition animations into checkout complete state #5802

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

feat(clerk-js): Add transition animations into checkout complete state #5802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e68c22b
init
alexcarpenter May 2, 2025
59f2040
removes spaces
alexcarpenter May 2, 2025
c31ca55
reduced motion
alexcarpenter May 2, 2025
01ab9fd
add changeset
alexcarpenter May 2, 2025
5de4791
Merge branch 'main' into alexcarpenter/checkout-success-animations
alexcarpenter May 2, 2025
44db414
bump bundle size
alexcarpenter May 2, 2025
6bf454d
bump
alexcarpenter May 2, 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/purple-cities-study.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Add entry animations to CheckoutComplete component to smooth our the transition between checking out to successful state.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
{ "path": "./dist/waitlist*.js", "maxSize": "1.3KB" },
{ "path": "./dist/keylessPrompt*.js", "maxSize": "6.5KB" },
{ "path": "./dist/pricingTable*.js", "maxSize": "4.02KB" },
{ "path": "./dist/checkout*.js", "maxSize": "5.3KB" },
{ "path": "./dist/checkout*.js", "maxSize": "5.75KB" },
{ "path": "./dist/paymentSources*.js", "maxSize": "8.9KB" },
{ "path": "./dist/up-billing-page*.js", "maxSize": "2.4KB" },
{ "path": "./dist/op-billing-page*.js", "maxSize": "2.4KB" },
Expand Down
174 changes: 159 additions & 15 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
@@ -1,13 +1,19 @@
import type { __experimental_CommerceCheckoutResource } from '@clerk/types';

import { Box, Button, descriptors, Heading, Icon, localizationKeys, Span, Text } from '../../customizables';
import { Box, Button, descriptors, Heading, localizationKeys, Span, Text } from '../../customizables';
import { Drawer, LineItems, useDrawerContext } from '../../elements';
import { Check } from '../../icons';
import { transitionDurationValues, transitionTiming } from '../../foundations/transitions';
import { animations } from '../../styledSystem';
import { formatDate } from '../../utils';

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

export const CheckoutComplete = ({ checkout }: { checkout: __experimental_CommerceCheckoutResource }) => {
export const CheckoutComplete = ({
checkout,
isMotionSafe,
}: {
checkout: __experimental_CommerceCheckoutResource;
isMotionSafe: boolean;
}) => {
const { setIsOpen } = useDrawerContext();

const handleClose = () => {
Expand All @@ -29,11 +35,40 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
width: '100%',
padding: t.space.$4,
flexShrink: 0,
transformOrigin: 'bottom center',
animationName: 'scaleIn',
animationDuration: `${transitionDurationValues.slowest}ms`,
animationTimingFunction: transitionTiming.bezier,
animationFillMode: 'forwards',
opacity: 0,
'@keyframes scaleIn': {
'0%': {
filter: 'blur(10px)',
transform: 'scale(0.85)',
opacity: 0,
},
'100%': {
filter: 'blur(0px)',
transform: 'scale(1)',
opacity: 1,
},
},
...(!isMotionSafe && {
animation: 'none',
opacity: 1,
}),
})}
>
<Ring scale={1} />
<Ring scale={0.75} />
<Ring scale={0.5} />
{[1, 0.75, 0.5].map((scale, index, array) => {
return (
<Ring
key={scale}
scale={scale}
index={array.length - 1 - index}
isMotionSafe={isMotionSafe}
/>
);
})}
<Box
elementDescriptor={descriptors.checkoutSuccessBadge}
sx={t => ({
Expand All @@ -55,15 +90,48 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
},
})}
>
<Icon
icon={Check}
colorScheme='neutral'
sx={{
<svg
fill='none'
viewBox='0 0 10 10'
aria-hidden='true'
style={{
position: 'relative',
margin: 'auto',
width: '1rem',
height: '1rem',
}}
aria-hidden
/>
>
<path
d='m1 6 3 3 5-8'
stroke='currentColor'
strokeWidth='1.25'
strokeLinecap='round'
strokeLinejoin='round'
strokeDasharray='1'
pathLength='1'
style={{
strokeDashoffset: '1',
animationName: 'check',
animationDuration: `${transitionDurationValues.drawer}ms`,
animationTimingFunction: transitionTiming.bezier,
animationFillMode: 'forwards',
animationDelay: `${transitionDurationValues.slow}ms`,
...(!isMotionSafe && {
strokeDashoffset: '0',
animation: 'none',
}),
}}
/>
</svg>
<style>{`
@keyframes check {
0% {
stroke-dashoffset: 1;
}
100% {
stroke-dashoffset: 0;
}
`}</style>
</Box>
<Span
sx={t => ({
Expand All @@ -83,11 +151,55 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
? localizationKeys('__experimental_commerce.checkout.title__paymentSuccessful')
: localizationKeys('__experimental_commerce.checkout.title__subscriptionSuccessful')
}
sx={{
opacity: 0,
animationName: 'slideUp',
animationDuration: `${transitionDurationValues.slowest}ms`,
animationTimingFunction: transitionTiming.bezier,
animationFillMode: 'forwards',
'@keyframes slideUp': {
'0%': {
transform: 'translateY(30px)',
opacity: 0,
},
'100%': {
transform: 'translateY(0)',
opacity: 1,
},
},
...(!isMotionSafe && {
opacity: 1,
animation: 'none',
}),
}}
/>
<Text
elementDescriptor={descriptors.checkoutSuccessDescription}
colorScheme='secondary'
sx={t => ({ textAlign: 'center', paddingInline: t.space.$8, marginBlockStart: t.space.$2 })}
sx={t => ({
textAlign: 'center',
paddingInline: t.space.$8,
marginBlockStart: t.space.$2,
opacity: 0,
animationName: 'slideUp',
animationDuration: `${transitionDurationValues.slowest * 1.5}ms`,
animationTimingFunction: transitionTiming.bezier,
animationFillMode: 'forwards',
'@keyframes slideUp': {
'0%': {
transform: 'translateY(30px)',
opacity: 0,
},
'100%': {
transform: 'translateY(0)',
opacity: 1,
},
},
...(!isMotionSafe && {
opacity: 1,
animation: 'none',
}),
})}
localizationKey={
checkout.subscription?.status === 'active'
? localizationKeys('__experimental_commerce.checkout.description__paymentSuccessful')
Expand All @@ -97,10 +209,25 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer
</Span>
</Span>
</Drawer.Body>

<Drawer.Footer
sx={t => ({
rowGap: t.space.$4,
animationName: 'footerSlideInUp',
animationDuration: `${transitionDurationValues.drawer}ms`,
animationTimingFunction: transitionTiming.bezier,
'@keyframes footerSlideInUp': {
'0%': {
transform: 'translateY(100%)',
opacity: 0,
},
'100%': {
transform: 'translateY(0)',
opacity: 1,
},
},
...(!isMotionSafe && {
animation: 'none',
}),
})}
>
<LineItems.Root>
Expand Down Expand Up @@ -142,11 +269,18 @@ export const CheckoutComplete = ({ checkout }: { checkout: __experimental_Commer

function Ring({
scale,
index,
isMotionSafe,
}: {
/**
* Number between 0-1
*/
scale: number;
/**
* Index of the ring (0-2)
*/
index: number;
isMotionSafe: boolean;
}) {
return (
<Span
Expand All @@ -161,6 +295,16 @@ function Ring({
borderColor: t.colors.$neutralAlpha200,
borderRadius: t.radii.$circle,
maskImage: `linear-gradient(to bottom, transparent 15%, black, transparent 85%)`,
opacity: 0,
animationName: animations.fadeIn,
animationDuration: `${transitionDurationValues.slow}ms`,
animationTimingFunction: transitionTiming.bezier,
animationFillMode: 'forwards',
animationDelay: `${index * transitionDurationValues.slow}ms`,
...(!isMotionSafe && {
animation: 'none',
opacity: 1,
}),
})}
/>
);
Expand Down
14 changes: 11 additions & 3 deletions packages/clerk-js/src/ui/components/Checkout/CheckoutPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import type {
} from '@clerk/types';
import { useEffect } from 'react';

import { Alert, Box, Flex, localizationKeys, Spinner, useLocalizations } from '../../customizables';
import { Alert, Box, Flex, localizationKeys, Spinner, useAppearance, useLocalizations } from '../../customizables';
import { Drawer, useDrawerContext } from '../../elements';
import { useCheckout } from '../../hooks';
import { useCheckout, usePrefersReducedMotion } from '../../hooks';
import { EmailForm } from '../UserProfile/EmailForm';
import { CheckoutComplete } from './CheckoutComplete';
import { CheckoutForm } from './CheckoutForm';
Expand All @@ -16,6 +16,9 @@ export const CheckoutPage = (props: __experimental_CheckoutProps) => {
const { translateError } = useLocalizations();
const { planId, planPeriod, subscriberType, onSubscriptionComplete } = props;
const { setIsOpen, isOpen } = useDrawerContext();
const prefersReducedMotion = usePrefersReducedMotion();
const { animations: layoutAnimations } = useAppearance().parsedLayout;
const isMotionSafe = !prefersReducedMotion && layoutAnimations === true;

const { checkout, isLoading, invalidate, revalidate, updateCheckout, errors } = useCheckout({
planId,
Expand Down Expand Up @@ -49,7 +52,12 @@ export const CheckoutPage = (props: __experimental_CheckoutProps) => {

if (checkout) {
if (checkout?.status === 'completed') {
return <CheckoutComplete checkout={checkout} />;
return (
<CheckoutComplete
checkout={checkout}
isMotionSafe={isMotionSafe}
/>
);
}

return (
Expand Down
10 changes: 6 additions & 4 deletions packages/clerk-js/src/ui/elements/Drawer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,11 +313,11 @@ const Header = React.forwardRef<HTMLDivElement, HeaderProps>(({ title, children,
* Drawer.Body
* -----------------------------------------------------------------------------------------------*/

interface BodyProps {
interface BodyProps extends React.HTMLAttributes<HTMLDivElement> {
children: React.ReactNode;
}

const Body = React.forwardRef<HTMLDivElement, BodyProps>(({ children }, ref) => {
const Body = React.forwardRef<HTMLDivElement, BodyProps>(({ children, ...props }, ref) => {
return (
<Box
ref={ref}
Expand All @@ -329,6 +329,7 @@ const Body = React.forwardRef<HTMLDivElement, BodyProps>(({ children }, ref) =>
overflowY: 'auto',
overflowX: 'hidden',
}}
{...props}
>
{children}
</Box>
Expand All @@ -339,12 +340,12 @@ const Body = React.forwardRef<HTMLDivElement, BodyProps>(({ children }, ref) =>
* Drawer.Footer
* -----------------------------------------------------------------------------------------------*/

interface FooterProps {
interface FooterProps extends React.HTMLAttributes<HTMLDivElement> {
children?: React.ReactNode;
sx?: ThemableCssProp;
}

const Footer = React.forwardRef<HTMLDivElement, FooterProps>(({ children, sx }, ref) => {
const Footer = React.forwardRef<HTMLDivElement, FooterProps>(({ children, sx, ...props }, ref) => {
return (
<Box
ref={ref}
Expand All @@ -367,6 +368,7 @@ const Footer = React.forwardRef<HTMLDivElement, FooterProps>(({ children, sx },
}),
sx,
]}
{...props}
>
{children}
</Box>
Expand Down