如果您是一名 web 开发人员，您很可能听说过 shadcn/ui，它是基于 radix ui 的最流行的组件库之一。在这篇文章中，我们将探讨如何将 shadcn 添加到现有项目中。
根据您的项目设置方式以及您使用的框架，将 shadcn 添加到现有项目将会有所不同。当使用 shadcn 使用此库时建议使用 typescript。不过，javascript 版本也可用。
要首先将 shadcn 添加到您的项目中，如果您的项目没有使用 tailwind css，则必须安装它，因为 shadcn 组件是用它来设计样式的。
要设置 tailwind css，请按照其网站上的安装说明进行操作。
如果您使用 next.js、vite、remix、astro 或 laravel，请运行 shadcn-ui 使用以下命令设置您的项目：
npx shadcn-ui@latest init
根据您的项目，您必须回答几个问题才能完成设置，例如选择 typescript 或 javascript，无论您的项目使用什么。
之后你就可以安装任何你想要的 shadcn 组件，例如添加按钮：
npx shadcn-ui@latest add button
然后只需从 components/ui 导入它即可在您的项目中使用它。
要再次在 react 项目中手动安装 shadcn，请确保正确安装 tailwind css。
然后添加依赖：
npm install tailwindcss-animate class-variance-authority clsx tailwind-merge
添加图标库：
npm install lucide-react
配置路径别名：
tsconfig.json
{
"compileroptions": {
"baseurl": ".",
"paths": {
"@/*": ["./*"]
}
}
}
配置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")],
}
使用以下内容更新 globals.css 文件：
@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;
}
}
最后将 cn helper 添加到你的 lib/utils.ts
import { clsx, type ClassValue } from "clsx"
import { twMerge } from "tailwind-merge"
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs))
}
然后只需从此处安装所需的组件并按照每个组件的说明进行操作即可。
就这样，我现在几乎在所有的 web 项目中都使用 shadcn，它已经变得非常流行，因为它非常易于使用和自定义，请在此处查看我如何从 select 和 scrollarea 组件创建自定义 shadcn-date-picker 组件。
如果您在将此库添加到项目中时遇到任何问题，请告诉我。
让我们在 x.com 上联系吧