113k
New

Next.js

PreviousNext

为 Next.js 安装和配置 shadcn/ui。

选择与您起点相符的设置。

使用 shadcn/create

构建您的预设并生成 Next.js 项目命令。

使用 CLI

直接从终端搭建新的 Next.js 项目。

现有项目

在现有的 Next.js 项目中手动配置 shadcn/ui。

使用 shadcn/create

构建您的预设

打开 shadcn/create 并可视化地构建您的预设。选择您的样式、颜色、字体、图标等。

打开 shadcn/create

创建项目

点击 Create Project，选择您的包管理器，并复制生成的命令。

生成的命令将类似于：

pnpm dlx shadcn@latest init --preset [CODE] --template next

确切命令将包含您选择的选项，例如 --base、--monorepo 或 --rtl。

添加组件

将 Card 组件添加到您的项目：

pnpm dlx shadcn@latest add card

如果您创建了 monorepo，请从 apps/web 运行命令或从仓库根目录指定工作区：

pnpm dlx shadcn@latest add card -c apps/web

上述命令会将 Card 组件添加到您的项目。然后您可以像这样导入它：

app/page.tsx
import {
  Card,
  CardContent,
  CardDescription,
  CardHeader,
  CardTitle,
} from "@/components/ui/card"
 
export default function Home() {
  return (
    <Card className="max-w-sm">
      <CardHeader>
        <CardTitle>Project Overview</CardTitle>
        <CardDescription>
          Track progress and recent activity for your Next.js app.
        </CardDescription>
      </CardHeader>
      <CardContent>
        Your design system is ready. Start building your next component.
      </CardContent>
    </Card>
  )
}

如果您创建了 monorepo，请更新 apps/web/app/page.tsx 并改为从 @workspace/ui/components/card 导入。

使用 CLI

创建项目

运行 init 命令来搭建新的 Next.js 项目。按照提示配置您的项目：base、preset、monorepo 等。

pnpm dlx shadcn@latest init -t next

对于 monorepo 项目，使用 --monorepo 标志：

pnpm dlx shadcn@latest init -t next --monorepo

添加组件

将 Card 组件添加到您的项目：

pnpm dlx shadcn@latest add card

如果您创建了 monorepo，请从 apps/web 运行命令或从仓库根目录指定工作区：

pnpm dlx shadcn@latest add card -c apps/web

上述命令会将 Card 组件添加到您的项目。然后您可以像这样导入它：

app/page.tsx
import {
  Card,
  CardContent,
  CardDescription,
  CardHeader,
  CardTitle,
} from "@/components/ui/card"
 
export default function Home() {
  return (
    <Card className="max-w-sm">
      <CardHeader>
        <CardTitle>Project Overview</CardTitle>
        <CardDescription>
          Track progress and recent activity for your Next.js app.
        </CardDescription>
      </CardHeader>
      <CardContent>
        Your design system is ready. Start building your next component.
      </CardContent>
    </Card>
  )
}

如果您创建了 monorepo，请更新 apps/web/app/page.tsx 并改为从 @workspace/ui/components/card 导入。

现有项目

创建项目

如果您需要新的 Next.js 项目，请使用 create-next-app 创建一个。否则，跳过此步骤。

pnpm create next-app@latest

选择推荐的默认值，以便为您配置 Tailwind CSS、App Router 和默认的 @/* 导入别名。

如果您更喜欢 src/ 目录，请使用 --src-dir 或在提示时选择 Yes：

pnpm create next-app@latest --src-dir

使用 --src-dir 时，Next.js 会将您的应用放在 src/app 中，并将 @/* 别名配置为指向 ./src/*。

配置 Tailwind CSS 和导入别名

如果您使用推荐的 create-next-app 默认值创建了项目，可以跳过此步骤。

如果您要将 shadcn/ui 添加到较旧或自定义的 Next.js 应用，请确保先安装了 Tailwind CSS。您可以参考官方 Next.js 安装指南。

然后确保您的 tsconfig.json 包含 @/* 导入别名：

tsconfig.json
{
  "compilerOptions": {
    "paths": {
      "@/*": ["./*"]
    }
  }
}

如果您使用了 --src-dir，请将别名指向 ./src/*。

运行 CLI

运行 shadcn init 命令以在项目中设置 shadcn/ui。

pnpm dlx shadcn@latest init

添加组件

您现在可以开始向项目添加组件了。

pnpm dlx shadcn@latest add button

上述命令会将 Button 组件添加到项目中。然后可以像这样导入它：

app/page.tsx
import { Button } from "@/components/ui/button"
 
export default function Home() {
  return (
    <div className="flex min-h-svh items-center justify-center">
      <Button>Click me</Button>
    </div>
  )
}

如果您使用了 --src-dir，请改为将组件添加到 src/app/page.tsx。