Se você é um desenvolvedor web, provavelmente já ouviu falar do shadcn/ui, uma das bibliotecas de componentes mais populares baseadas no Radix UI. Nesta postagem, exploraremos como adicionar shadcn a um projeto existente.

Dependendo de como seu projeto está configurado e qual estrutura você está usando, adicionar shadcn ao seu projeto existente irá variar. Ao usar shadcn Typescript é recomendado ao usar esta biblioteca. No entanto, a versão JavaScript também está disponível.

Para adicionar shadcn ao seu projeto primeiro você terá que instalar o Tailwind CSS se o seu projeto não o estiver usando, já que os componentes shadcn são estilizados com ele.

Para configurar o Tailwind CSS, siga as instruções de instalação do site.

Shadcn e Estruturas

Se você estiver usando Next.js, Vite, Remix, Astro ou Laravel, execute shadcn-ui para configurar seu projeto com este comando:

npx shadcn-ui@latest init

Você terá que responder algumas perguntas para finalizar a configuração dependendo do seu projeto, como escolher Typescript ou Javascript, seja qual for o seu projeto.

Depois você poderá instalar qualquer componente shadcn que desejar, por exemplo, para adicionar o botão:

npx shadcn-ui@latest add button

Depois basta importá-lo de componentes/ui para usá-lo em seu projeto.

Instalação manual do Shadcn

Para instalar o shadcn manualmente, por exemplo, em um projeto React novamente, certifique-se de que o CSS do Tailwind esteja instalado corretamente.

Em seguida, adicione dependências:

npm install tailwindcss-animate class-variance-authority clsx tailwind-merge

Adicionar biblioteca de ícones:

npm install lucide-react

Configurar aliases de caminho:

tsconfig.json

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["./*"]
    }
  }
}

Configurar tailwind.config.js

const { fontFamily } = require("tailwindcss/defaultTheme")

/** @type {import('tailwindcss').Config} */
module.exports = {
  darkMode: ["class"],
  content: ["app/**/*.{ts,tsx}", "components/**/*.{ts,tsx}"],
  theme: {
    container: {
      center: true,
      padding: "2rem",
      screens: {
        "2xl": "1400px",
      },
    },
    extend: {
      colors: {
        border: "hsl(var(--border))",
        input: "hsl(var(--input))",
        ring: "hsl(var(--ring))",
        background: "hsl(var(--background))",
        foreground: "hsl(var(--foreground))",
        primary: {
          DEFAULT: "hsl(var(--primary))",
          foreground: "hsl(var(--primary-foreground))",
        },
        secondary: {
          DEFAULT: "hsl(var(--secondary))",
          foreground: "hsl(var(--secondary-foreground))",
        },
        destructive: {
          DEFAULT: "hsl(var(--destructive))",
          foreground: "hsl(var(--destructive-foreground))",
        },
        muted: {
          DEFAULT: "hsl(var(--muted))",
          foreground: "hsl(var(--muted-foreground))",
        },
        accent: {
          DEFAULT: "hsl(var(--accent))",
          foreground: "hsl(var(--accent-foreground))",
        },
        popover: {
          DEFAULT: "hsl(var(--popover))",
          foreground: "hsl(var(--popover-foreground))",
        },
        card: {
          DEFAULT: "hsl(var(--card))",
          foreground: "hsl(var(--card-foreground))",
        },
      },
      borderRadius: {
        lg: `var(--radius)`,
        md: `calc(var(--radius) - 2px)`,
        sm: "calc(var(--radius) - 4px)",
      },
      fontFamily: {
        sans: ["var(--font-sans)", ...fontFamily.sans],
      },
      keyframes: {
        "accordion-down": {
          from: { height: "0" },
          to: { height: "var(--radix-accordion-content-height)" },
        },
        "accordion-up": {
          from: { height: "var(--radix-accordion-content-height)" },
          to: { height: "0" },
        },
      },
      animation: {
        "accordion-down": "accordion-down 0.2s ease-out",
        "accordion-up": "accordion-up 0.2s ease-out",
      },
    },
  },
  plugins: [require("tailwindcss-animate")],
}

Atualize o arquivo globals.css com o seguinte:

@tailwind base;
@tailwind components;
@tailwind utilities;

@layer base {
  :root {
    --background: 0 0% 100%;
    --foreground: 222.2 47.4% 11.2%;

    --muted: 210 40% 96.1%;
    --muted-foreground: 215.4 16.3% 46.9%;

    --popover: 0 0% 100%;
    --popover-foreground: 222.2 47.4% 11.2%;

    --border: 214.3 31.8% 91.4%;
    --input: 214.3 31.8% 91.4%;

    --card: 0 0% 100%;
    --card-foreground: 222.2 47.4% 11.2%;

    --primary: 222.2 47.4% 11.2%;
    --primary-foreground: 210 40% 98%;

    --secondary: 210 40% 96.1%;
    --secondary-foreground: 222.2 47.4% 11.2%;

    --accent: 210 40% 96.1%;
    --accent-foreground: 222.2 47.4% 11.2%;

    --destructive: 0 100% 50%;
    --destructive-foreground: 210 40% 98%;

    --ring: 215 20.2% 65.1%;

    --radius: 0.5rem;
  }

  .dark {
    --background: 224 71% 4%;
    --foreground: 213 31% 91%;

    --muted: 223 47% 11%;
    --muted-foreground: 215.4 16.3% 56.9%;

    --accent: 216 34% 17%;
    --accent-foreground: 210 40% 98%;

    --popover: 224 71% 4%;
    --popover-foreground: 215 20.2% 65.1%;

    --border: 216 34% 17%;
    --input: 216 34% 17%;

    --card: 224 71% 4%;
    --card-foreground: 213 31% 91%;

    --primary: 210 40% 98%;
    --primary-foreground: 222.2 47.4% 1.2%;

    --secondary: 222.2 47.4% 11.2%;
    --secondary-foreground: 210 40% 98%;

    --destructive: 0 63% 31%;
    --destructive-foreground: 210 40% 98%;

    --ring: 216 34% 17%;

    --radius: 0.5rem;
  }
}

@layer base {
  * {
    @apply border-border;
  }
  body {
    @apply bg-background text-foreground;
    font-feature-settings: "rlig" 1, "calt" 1;
  }
}

Finalmente adicione cn helper ao seu lib/utils.ts

import { clsx, type ClassValue } from "clsx"
import { twMerge } from "tailwind-merge"

export function cn(...inputs: ClassValue[]) {
  return twMerge(clsx(inputs))
}

Depois basta instalar o componente desejado aqui e seguir as instruções para cada componente.

Isso é tudo, eu uso o shadcn em quase todos os meus projetos da web agora, ele se tornou muito popular devido à facilidade de uso e personalização, veja como criei um componente shadcn-date-picker personalizado do componente Select e Scrollarea aqui.

Informe-me se você teve algum problema ao adicionar esta biblioteca ao seu projeto.

Vamos nos conectar em x.com