Skip to content

refactor(skeleton): apply vanilla-extract #165

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.

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 10 commits into
base: release/v1
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion packages/skeleton/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@
"prepack": "pnpm run build"
},
"dependencies": {
"@radix-ui/react-slot": "^1.1.0"
"@sipe-team/tokens": "workspace:*",
"@radix-ui/react-slot": "^1.1.0",
"@vanilla-extract/recipes": "^0.5.5",
"clsx": "^2.1.1"
},
"devDependencies": {
"@faker-js/faker": "^9.2.0",
Expand All @@ -36,6 +39,7 @@
"@testing-library/jest-dom": "^6.6.3",
"@testing-library/react": "^16.0.1",
"@types/react": "^18.3.12",
"@vanilla-extract/css": "catalog:",
"happy-dom": "catalog:",
"react": "^18.3.1",
"react-dom": "^18.3.1",
Expand Down
113 changes: 113 additions & 0 deletions packages/skeleton/src/Skeleton.css.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
import { color, radius } from '@sipe-team/tokens';
import { keyframes, style } from '@vanilla-extract/css';
import { recipe } from '@vanilla-extract/recipes';

//FIXME : background color 바꿔야함. 지금 x-lay 같음...

const fadeInOut = keyframes({
'0%': { opacity: 1 },
'50%': { opacity: 0.8 },
'100%': { opacity: 1 },
});

export const SkeletonVariant = {
rectangular: 'rectangular',
circle: 'circle',
text: 'text',
rounded: 'rounded',
} as const;

export type SkeletonVariant = (typeof SkeletonVariant)[keyof typeof SkeletonVariant];

const baseSkeletonStyle = style({
backgroundColor: color.gray200,
backgroundImage: 'none',
backgroundClip: 'border-box',
border: 'none',
boxShadow: 'none',
color: 'transparent',
outline: 'none',
pointerEvents: 'none',
userSelect: 'none',
cursor: 'default',
overflow: 'hidden',
position: 'relative',

'::before': {
content: '""',
position: 'absolute',
top: 0,
left: 0,
right: 0,
bottom: 0,
background: `linear-gradient(90deg, transparent, ${color.gray200}, transparent)`,
animation: `${fadeInOut} 1.5s ease-in-out infinite`,
},
});

export const skeleton = recipe({
base: baseSkeletonStyle,

variants: {
variant: {
[SkeletonVariant.rectangular]: {
borderRadius: radius.sm,
},
[SkeletonVariant.circle]: {
borderRadius: radius.full,
aspectRatio: '1',
},
[SkeletonVariant.text]: {
borderRadius: radius.sm,
height: '1em',
width: '100%',
},
[SkeletonVariant.rounded]: {
borderRadius: radius.md,
},
},

loading: {
true: {},
false: {
animation: 'none',
backgroundColor: 'transparent',

'::before': {
display: 'none',
},
},
},

pulse: {
Copy link
Contributor

@froggy1014 froggy1014 Jun 8, 2025

Choose a reason for hiding this comment

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

제가 Pulse 애니메이션 효과를 봤을때는 현재 가운데 Y축을 기준으로 X축으로 gradient를 퍼지는것 같은데 색상때문이지는 모르겠는데 잘 안보여서요.

일반적인 스켈레톤 pulse는 전체 UI색상을 제어하지 않나싶은데.. 어떻게 생각하시나요 ?

Screen Recording 2025-06-08 at 16 11 57

Reference

true: {
'::before': {
animation: `${fadeInOut} 1.2s ease-in-out infinite`,
},
},
false: {
'::before': {
animation: `${fadeInOut} 2s ease-in-out infinite`,
},
},
},
},

defaultVariants: {
variant: SkeletonVariant.rectangular,
loading: true,
pulse: false,
},
});

export const shimmer = keyframes({
'0%': { transform: 'translateX(-100%)' },
'100%': { transform: 'translateX(100%)' },
});

export const shimmerEffect = style({
'::before': {
background: `linear-gradient(90deg, transparent, ${color.white}, transparent)`,
animation: `${shimmer} 2s infinite`,
},
});
30 changes: 0 additions & 30 deletions packages/skeleton/src/Skeleton.module.css

This file was deleted.

64 changes: 48 additions & 16 deletions packages/skeleton/src/Skeleton.stories.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import { faker } from '@faker-js/faker';
// Skeleton.stories.tsx
import type { Meta, StoryObj } from '@storybook/react';
import { Skeleton } from './Skeleton';

Expand All @@ -12,19 +10,42 @@ const meta = {
argTypes: {
variant: {
control: 'select',
options: ['circle', 'rectangular'],
options: ['rectangular', 'circle', 'text', 'rounded'],
description: 'Visual variant of the skeleton',
defaultValue: 'rectangular',
},
width: {
control: { type: 'number', min: 20, max: 200, step: 10 },
control: { type: 'number', min: 20, max: 500, step: 10 },
description: 'Width of the skeleton in pixels',
},
height: {
control: { type: 'number', min: 20, max: 200, step: 10 },
description: 'Height of the skeleton in pixels',
},
loading: {
control: 'boolean',
description: 'Whether to show skeleton or content',
defaultValue: true,
},
asChild: {
control: 'boolean',
description: 'Whether to use as a wrapper',
defaultValue: false,
},
pulse: {
control: 'boolean',
description: 'Enable faster pulse animation',
defaultValue: false,
},
shimmer: {
control: 'boolean',
description: 'Enable shimmer effect',
defaultValue: false,
},
lines: {
control: { type: 'number', min: 1, max: 10, step: 1 },
description: 'Number of lines for text variant',
defaultValue: 1,
},
},
} satisfies Meta<typeof Skeleton>;
Expand All @@ -37,12 +58,12 @@ export const Basic: Story = {
args: {
loading: true,
variant: 'rectangular',
width: 100,
width: 200,
height: 100,
},
};

export const CircleSkeleton: Story = {
export const Circle: Story = {
args: {
loading: true,
variant: 'circle',
Expand All @@ -51,29 +72,40 @@ export const CircleSkeleton: Story = {
},
};

export const RectangularSkeleton: Story = {
export const Text: Story = {
args: {
loading: true,
variant: 'rectangular',
width: 80,
height: 30,
variant: 'text',
width: 300,
lines: 3,
},
};

export const SkeletonWithChildren: Story = {
export const Rounded: Story = {
args: {
loading: true,
variant: 'rounded',
width: 200,
height: 60,
},
};

export const WithShimmer: Story = {
args: {
loading: true,
asChild: true,
children: <button type="button">Loading...</button>,
variant: 'rectangular',
width: 200,
height: 100,
shimmer: true,
},
};

export const SkeletonWithText: Story = {
export const WithPulse: Story = {
args: {
loading: true,
asChild: true,
children: <span>{faker.lorem.lines(2)}</span>,
variant: 'rectangular',
width: 200,
height: 100,
pulse: true,
},
};
Loading