文档
变更日志

变更日志

最新更新和公告。

2024 年 8 月 - npx shadcn init

新的 CLI 现已推出。它进行了全面重写,并添加了许多新功能和改进。现在可以使用 npx shadcn add 安装组件、主题、钩子、实用程序等。

这是朝着分发你和你的 LLM 可以访问和使用的代码迈出的重要一步。

  1. 首先,cli 现在开箱即用地支持所有主要的 React 框架。Next.js、Remix、Vite 和 Laravel。当你在一个新应用程序中初始化时,我们会更新你现有的 Tailwind 文件,而不是覆盖它们。
  2. 组件现在自带其依赖项。例如,手风琴可以定义其 Tailwind 关键帧。当您将其添加到项目中时,我们会相应地更新您的 tailwind.config.ts 文件。
  3. 您还可以使用 url 安装远程组件。 npx shadcn add https://acme.com/registry/navbar.json
  4. 我们还改进了 init 命令。它执行框架检测,甚至可以在一条命令中初始化一个全新的 Next.js 应用程序。 npx shadcn init
  5. 我们创建了一个新的模式,你可以使用它来发布你自己的组件注册表。由于它支持 url,你甚至可以使用它来分发私有组件。
  6. 还有一些其他更新,比如更好的错误处理和 monorepo 支持。

你今天就可以尝试新的 cli。

npx shadcn init sidebar-01 login-01

更新您的项目

要将现有项目更新为使用新的 CLI,请更新您的 components.json 文件以包括您的 **组件**、**实用程序**、**ui**、**lib** 和 **钩子** 的导入别名。

components.json
{
  "$schema": "https://ui.shadcn.org.cn/schema.json",
  "style": "new-york",
  "tailwind": {
    // ...
  },
  "aliases": {
    "components": "@/components",
    "utils": "@/lib/utils",
    "ui": "@/components/ui",
    "lib": "@/lib",
    "hooks": "@/hooks"
  }
}

如果您使用的是不同的导入别名前缀,例如 ~,请将 @ 替换为您的前缀。

2024 年 4 月 - 引入提升模式

我们正在为 引入一种名为 **提升模式** 的新模式。

启用提升模式以自动“提升”块模板中较小的组件,以便进行复制和粘贴。

提升模式查看块库

使用提升模式,您可以复制构成块模板的较小组件(如卡片、按钮和表单),并将它们直接粘贴到您的项目中。

访问 页面以试用。

2024 年 3 月 - 引入块

自发布以来,最受请求的功能之一就是布局:带有侧边栏的管理仪表板、营销页面部分、卡片等等。

今天,我们正在推出 .

管理仪表板查看块库

块是您可以用来构建应用程序的现成组件。它们完全响应式、无障碍且可组合,这意味着它们使用与 shadcn/ui 中其他组件相同的原则构建。

我们从仪表盘布局和身份验证页面开始,计划在未来几周内添加更多区块。

开源

区块是开源的。你可以在GitHub上找到源代码。在你的项目中使用它们,自定义它们并回馈贡献。

AI Playground查看区块库

请求区块

我们还引入了“请求区块”功能。如果你想看到一个特定的区块,只需在GitHub上创建一个请求,社区可以投票并构建它。

Settings Page查看区块库

v0

如果你有 v0 帐户,你可以使用 在 v0 中编辑 功能在 v0 上打开代码以进行提示和进一步生成。

就这样。期待看到你用区块构建的东西。

2024 年 3 月 - 面包屑和输入 OTP

我们添加了一个新的面包屑组件和一个输入 OTP 组件。

一个可访问且灵活的面包屑组件。它支持折叠项、自定义分隔符、自带路由 <Link /> 以及与其他 shadcn/ui 组件组合使用。

查看更多示例

输入 OTP

一个功能齐全的输入 OTP 组件。它支持数字和字母数字代码、自定义长度、复制粘贴以及可访问性。输入 OTP 建立在 input-otp 之上,由 @guilherme_rodz 创建。

阅读文档

如果你有 v0,新的组件可供生成。

2023 年 12 月 - 新组件、CLI 和更多

我们在 shadcn/ui 中添加了新的组件,并对 CLI 进行了许多改进。

以下是新功能的简要概述

  • 轮播 - 带有运动、滑动手势和键盘支持的轮播组件。
  • 抽屉 - 在移动设备上看起来很棒的抽屉组件。
  • 分页 - 带有页面导航、上一个和下一个按钮的分页组件。
  • 可调整大小 - 用于构建可调整大小的面板组和布局的可调整大小组件。
  • Sonner - 你永远需要的最后一个吐司组件。
  • CLI 更新 - 支持自定义 Tailwind 前缀tailwind.config.ts

我们添加了一个功能齐全的轮播组件,带有运动、滑动手势和键盘支持。建立在 Embla Carousel 之上。

它支持无限循环、自动播放、垂直方向等等。

1
2
3
4
5

抽屉

哦,抽屉组件 😍。建立在 Vaul 之上,由 emilkowalski_ 创建。

尝试在移动设备上打开以下抽屉。它看起来很棒!

分页

我们添加了一个分页组件,带有页面导航、上一个和下一个按钮。简单、灵活,适用于你框架的 <Link /> 组件。

可调整大小

使用此 <Resizable /> 组件构建可调整大小的面板组和布局。

一个
两个
三个

<Resizable /> 是使用 react-resizable-panels 构建的,由 bvaughn 创建。它支持鼠标、触摸和键盘。

Sonner

另一个由 emilkowalski_ 创建的。你永远需要的最后一个吐司组件。Sonner 现在可以在 shadcn/ui 中使用。

CLI 更新

这是最受欢迎的功能之一。你现在可以配置自定义 Tailwind 前缀,CLI 在添加组件时会自动为你的实用程序类添加前缀。

这意味着你现在可以轻松地将 shadcn/ui 组件添加到现有项目中,例如 Docusaurus、Nextra...等等。它可以无缝地融入你的现有设计系统,不会产生冲突。🔥

<AlertDialog className="tw-grid tw-gap-4 tw-border tw-bg-background tw-shadow-lg" />

它适用于 cncva 和 CSS 变量。

CLI 现在还可以检测 tailwind.config.ts 并为你添加配置的 TypeScript 版本。

就这样。节日快乐。

2023 年 7 月 - JavaScript

此项目和组件是用 TypeScript 编写的。我们建议你也为你的项目使用 TypeScript。

但是,我们提供组件的 JavaScript 版本,可以通过 cli 获取。

Would you like to use TypeScript (recommended)? no

要选择不使用 TypeScript,你可以在 components.json 文件中使用 tsx 标志。

components.json
{
  "style": "default",
  "tailwind": {
    "config": "tailwind.config.js",
    "css": "src/app/globals.css",
    "baseColor": "zinc",
    "cssVariables": true
  },
  "rsc": false,
  "tsx": false,
  "aliases": {
    "utils": "~/lib/utils",
    "components": "~/components"
  }
}

要配置导入别名,可以使用以下 jsconfig.json

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

2023 年 6 月 - 新的 CLI、样式等等

我今天有很多更新要与你分享

  • 新的 CLI - 从头开始重写 CLI。你现在可以添加组件、依赖项并配置导入路径。
  • 主题 - 选择使用 CSS 变量或 Tailwind CSS 实用程序类进行主题设置。
  • 基础颜色 - 配置项目的基准颜色。这将用于为你的组件生成默认的颜色调色板。
  • React 服务器组件 - 选择不使用 React 服务器组件。CLI 会自动添加或删除 use client 指令。
  • 样式 - 引入一个名为 Style 的新概念。样式自带一组组件、动画、图标等等。
  • 退出动画 - 为所有组件添加了退出动画。
  • 其他更新 - 新的 icon 按钮大小、更新的 sheet 组件等等。
  • 更新你的项目 - 如何更新你的项目以获得最新的更改。

新的 CLI

在过去几周里,我一直致力于一个新的 CLI。它是完全重写的。它带有许多新功能和改进。

init

npx shadcn-ui@latest init

当你运行 init 命令时,系统会要求你回答一些问题来配置 components.json

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

此文件包含有关你的组件的所有信息:在何处安装它们、导入路径、如何设置样式...等等。

你可以使用此文件更改组件的导入路径,设置 baseColor 或更改样式方法。

components.json
{
  "style": "default",
  "tailwind": {
    "config": "tailwind.config.ts",
    "css": "src/app/globals.css",
    "baseColor": "zinc",
    "cssVariables": true
  },
  "rsc": false,
  "aliases": {
    "utils": "~/lib/utils",
    "components": "~/components"
  }
}

这意味着你现在可以将 CLI 与任何目录结构一起使用,包括 srcapp 目录。

add

npx shadcn-ui@latest add

现在 add 命令功能更强大。你现在可以添加 UI 组件,还可以导入更复杂的组件(即将推出)。

CLI 将自动解析所有组件和依赖项,根据您的自定义配置对其进行格式化并将其添加到您的项目中。

diff(实验性)

npx shadcn-ui diff

我们还引入了一个新的 diff 命令来帮助您跟踪上游更新。

您可以使用此命令查看上游存储库中发生了哪些更改,并相应地更新您的项目。

运行 diff 命令以获取具有可用更新的组件列表

npx shadcn-ui diff
The following components have updates available:
- button
  - /path/to/my-app/components/ui/button.tsx
- toast
  - /path/to/my-app/components/ui/use-toast.ts
  - /path/to/my-app/components/ui/toaster.tsx

然后运行 diff [component] 以查看更改

npx shadcn-ui diff alert
const alertVariants = cva(
- "relative w-full rounded-lg border",
+ "relative w-full pl-12 rounded-lg border"
)

使用 CSS 变量或 Tailwind 颜色进行主题设置

您可以选择使用 CSS 变量或 Tailwind CSS 实用程序类进行主题设置。

当您添加新组件时,CLI 将根据您的 components.json 配置自动使用正确的主题设置方法。

实用程序类

<div className="bg-zinc-950 dark:bg-white" />

要使用实用程序类进行主题设置,请在您的 components.json 文件中将 tailwind.cssVariables 设置为 false

components.json
{
  "tailwind": {
    "config": "tailwind.config.js",
    "css": "app/globals.css",
    "baseColor": "slate",
    "cssVariables": false
  }
}

CSS 变量

<div className="bg-background text-foreground" />

要使用 CSS 变量类进行主题设置,请在您的 components.json 文件中将 tailwind.cssVariables 设置为 true

components.json
{
  "tailwind": {
    "config": "tailwind.config.js",
    "css": "app/globals.css",
    "baseColor": "slate",
    "cssVariables": true
  }
}

基础颜色

您现在可以配置项目的基准颜色。这将用于为您的组件生成默认颜色调色板。

components.json
{
  "tailwind": {
    "config": "tailwind.config.js",
    "css": "app/globals.css",
    "baseColor": "zinc",
    "cssVariables": false
  }
}

选择 grayneutralslatestonezinc

如果您将 cssVariables 设置为 true,我们将在您的 globals.css 文件中将基准颜色设置为 CSS 变量。如果您将 cssVariables 设置为 false,我们将内联您的组件中的 Tailwind CSS 实用程序类。


React 服务器组件

如果您使用的是不支持 React 服务器组件的框架,则现在可以通过将 rsc 设置为 false 来选择退出。在添加组件时,我们将自动追加或删除 use client 指令。

components.json
{
  "rsc": false
}

样式

我们正在引入一个名为“样式”的新概念。

您可以将样式视为视觉基础:形状、图标、动画和排版。 样式自带一组组件、动画、图标等。

我们正在发布两种样式:defaultnew-york(很快将推出更多样式)。

Default vs New York style

default 样式是您所熟悉的样式。它是我们自项目开始以来一直使用的样式。它使用 lucide-react 用于图标,并使用 tailwindcss-animate 用于动画。

new-york 样式是一种新样式。它附带较小的按钮、带有阴影的卡片以及来自 Radix Icons 的一组新图标。

当您运行 init 命令时,系统会询问您要使用哪种样式。此信息将保存在您的 components.json 文件中。

components.json
{
  "style": "new-york"
}

主题设置

以样式为基础,然后使用 CSS 变量或 Tailwind CSS 实用程序类进行主题设置,以完全改变组件的外观。

Style with theming

退出动画

我在所有组件中添加了退出动画。单击下面的组合框以查看微妙的退出动画。

可以使用实用程序类自定义动画。


其他更新

按钮

  • 添加了一个新的按钮大小 icon

面板

  • position 重命名为 side 以匹配其他元素。
  • 已删除 size 属性。使用 className="w-[200px] md:w-[450px]" 进行响应式大小调整。

更新您的项目

由于我们采用的是复制粘贴方法,因此您需要手动更新您的项目以获取最新更改。

添加 components.json

在根目录中创建 components.json 文件

components.json
{
  "style": "default",
  "rsc": true,
  "tailwind": {
    "config": "tailwind.config.js",
    "css": "app/globals.css",
    "baseColor": "slate",
    "cssVariables": true
  },
  "aliases": {
    "components": "@/components",
    "utils": "@/lib/utils"
  }
}

更新 tailwind.cssaliases 的值以匹配您的项目结构。

按钮

icon 大小添加到 buttonVariants

components/ui/button.tsx
const buttonVariants = cva({
  variants: {
    size: {
      default: "h-10 px-4 py-2",
      sm: "h-9 rounded-md px-3",
      lg: "h-11 rounded-md px-8",
      icon: "h-10 w-10",
    },
  },
})

面板

  1. sheet.tsx 的内容替换为以下内容
components/ui/sheet.tsx
"use client"
 
import * as React from "react"
import * as SheetPrimitive from "@radix-ui/react-dialog"
import { cva, type VariantProps } from "class-variance-authority"
import { X } from "lucide-react"
 
import { cn } from "@/lib/utils"
 
const Sheet = SheetPrimitive.Root
 
const SheetTrigger = SheetPrimitive.Trigger
 
const SheetClose = SheetPrimitive.Close
 
const SheetPortal = ({
  className,
  ...props
}: SheetPrimitive.DialogPortalProps) => (
  <SheetPrimitive.Portal className={cn(className)} {...props} />
)
SheetPortal.displayName = SheetPrimitive.Portal.displayName
 
const SheetOverlay = React.forwardRef<
  React.ElementRef<typeof SheetPrimitive.Overlay>,
  React.ComponentPropsWithoutRef<typeof SheetPrimitive.Overlay>
>(({ className, ...props }, ref) => (
  <SheetPrimitive.Overlay
    className={cn(
      "fixed inset-0 z-50 bg-background/80 backdrop-blur-sm data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0",
      className
    )}
    {...props}
    ref={ref}
  />
))
SheetOverlay.displayName = SheetPrimitive.Overlay.displayName
 
const sheetVariants = cva(
  "fixed z-50 gap-4 bg-background p-6 shadow-lg transition ease-in-out data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:duration-300 data-[state=open]:duration-500",
  {
    variants: {
      side: {
        top: "inset-x-0 top-0 border-b data-[state=closed]:slide-out-to-top data-[state=open]:slide-in-from-top",
        bottom:
          "inset-x-0 bottom-0 border-t data-[state=closed]:slide-out-to-bottom data-[state=open]:slide-in-from-bottom",
        left: "inset-y-0 left-0 h-full w-3/4 border-r data-[state=closed]:slide-out-to-left data-[state=open]:slide-in-from-left sm:max-w-sm",
        right:
          "inset-y-0 right-0 h-full w-3/4  border-l data-[state=closed]:slide-out-to-right data-[state=open]:slide-in-from-right sm:max-w-sm",
      },
    },
    defaultVariants: {
      side: "right",
    },
  }
)
 
interface SheetContentProps
  extends React.ComponentPropsWithoutRef<typeof SheetPrimitive.Content>,
    VariantProps<typeof sheetVariants> {}
 
const SheetContent = React.forwardRef<
  React.ElementRef<typeof SheetPrimitive.Content>,
  SheetContentProps
>(({ side = "right", className, children, ...props }, ref) => (
  <SheetPortal>
    <SheetOverlay />
    <SheetPrimitive.Content
      ref={ref}
      className={cn(sheetVariants({ side }), className)}
      {...props}
    >
      {children}
      <SheetPrimitive.Close className="absolute right-4 top-4 rounded-sm opacity-70 ring-offset-background transition-opacity hover:opacity-100 focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 disabled:pointer-events-none data-[state=open]:bg-secondary">
        <X className="h-4 w-4" />
        <span className="sr-only">Close</span>
      </SheetPrimitive.Close>
    </SheetPrimitive.Content>
  </SheetPortal>
))
SheetContent.displayName = SheetPrimitive.Content.displayName
 
const SheetHeader = ({
  className,
  ...props
}: React.HTMLAttributes<HTMLDivElement>) => (
  <div
    className={cn(
      "flex flex-col space-y-2 text-center sm:text-left",
      className
    )}
    {...props}
  />
)
SheetHeader.displayName = "SheetHeader"
 
const SheetFooter = ({
  className,
  ...props
}: React.HTMLAttributes<HTMLDivElement>) => (
  <div
    className={cn(
      "flex flex-col-reverse sm:flex-row sm:justify-end sm:space-x-2",
      className
    )}
    {...props}
  />
)
SheetFooter.displayName = "SheetFooter"
 
const SheetTitle = React.forwardRef<
  React.ElementRef<typeof SheetPrimitive.Title>,
  React.ComponentPropsWithoutRef<typeof SheetPrimitive.Title>
>(({ className, ...props }, ref) => (
  <SheetPrimitive.Title
    ref={ref}
    className={cn("text-lg font-semibold text-foreground", className)}
    {...props}
  />
))
SheetTitle.displayName = SheetPrimitive.Title.displayName
 
const SheetDescription = React.forwardRef<
  React.ElementRef<typeof SheetPrimitive.Description>,
  React.ComponentPropsWithoutRef<typeof SheetPrimitive.Description>
>(({ className, ...props }, ref) => (
  <SheetPrimitive.Description
    ref={ref}
    className={cn("text-sm text-muted-foreground", className)}
    {...props}
  />
))
SheetDescription.displayName = SheetPrimitive.Description.displayName
 
export {
  Sheet,
  SheetTrigger,
  SheetClose,
  SheetContent,
  SheetHeader,
  SheetFooter,
  SheetTitle,
  SheetDescription,
}
  1. position 重命名为 side
- <Sheet position="right" />
+ <Sheet side="right" />

感谢

我要感谢所有使用过此项目、提供过反馈和为其做出贡献的人。我真的很感激。感谢您 🙏