shadcn/ui 사용기

1. shadcn/ui란

This is NOT a component library. It's a collection of re-usable components that you can copy and paste into your apps

shadcn/ui의 공식 문서에서는 위와 같이 설명하고 있다. 간단하게 tailwind의 스타일링을 곁들인 코드 모음 조각(컴포넌트)라고 생각하면 될 것 같다.

2. 사용방법

일단 create-next-app을 통해 플젝을 만들어 놓은 전제 하에 진행된다.

1. init

npx shadcn-ui@latest init

Would you like to use TypeScript (recommended)? no/yes
Which style would you like to use? › Default
Which color would you like to use as base color? › Slate
Where is your global CSS file? › › app/globals.css
Do you want to use CSS variables for colors? › no / yes
Where is your tailwind.config.js located? › tailwind.config.js
Configure the import alias for components: › @/components
Configure the import alias for utils: › @/lib/utils
Are you using React Server Components? › no / yes

init을 하면 위와 같은 질문들이 나온다.
상황에 따라 선택해주면 init 완.

2. add

이제 필요한 코드 조각(컴포넌트)를 내 플젝에 add 시키면 된다

npx shadcn-ui@latest add button

예를 들어 내가 button 코드를 가져오고 싶다면 위와 같이 add 다음에 가져 오고 싶은 컴포넌트를 넣어주면 된다. 저 컴포넌트 종류는 공식 문서에 정리가 잘 되어있음

이렇게 다운로드 해주면 components/ui 경로에 button.tsx 가 생성된다.
코드는 아래와 같다.

const buttonVariants = cva(
  'inline-flex items-center justify-center whitespace-nowrap rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50',
  {
    variants: {
      variant: {
        default: 'bg-primary text-primary-foreground hover:bg-primary/90',
        destructive:
          'bg-destructive text-destructive-foreground hover:bg-destructive/90',
        outline:
          'border border-input bg-background hover:bg-accent hover:text-accent-foreground',
        secondary:
          'bg-secondary text-secondary-foreground hover:bg-secondary/80',
        ghost: 'hover:bg-accent hover:text-accent-foreground',
        link: 'text-primary underline-offset-4 hover:underline',
      },
      size: {
        default: 'h-10 px-4 py-2',
        sm: 'h-9 rounded-md px-3',
        lg: 'h-11 rounded-md px-8',
        icon: 'size-10',
      },
    },
    defaultVariants: {
      variant: 'default',
      size: 'default',
    },
  }
)

export interface ButtonProps
  extends React.ButtonHTMLAttributes<HTMLButtonElement>,
    VariantProps<typeof buttonVariants> {
  asChild?: boolean
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(
  ({ className, variant, size, asChild = false, ...props }, ref) => {
    const Comp = asChild ? Slot : 'button'
    return (
      <Comp
        className={cn(buttonVariants({ variant, size, className }))}
        ref={ref}
        {...props}
      />
    )
  }
)
Button.displayName = 'Button'

export { Button, buttonVariants }