Docs
更新日志

更新日志

最新更新和公告。

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. 我们还改进了初始化命令。它支持框架检测,甚至可以用一条命令初始化一个全新的 Next.js 应用。npx shadcn init
  5. 我们创建了一个新的模式,您可以用来分发自己的组件注册表。由于它支持 URL,您甚至可以用来分发私有组件。
  6. 还有一些额外的更新,比如更好的错误处理和 monorepo 支持。

今天您可以尝试新的 CLI。

pnpm dlx shadcn init sidebar-01 login-01

更新你的项目

要更新现有项目以使用新的 CLI,请更新您的 components.json 文件,以包含您 组件工具UI钩子 的导入别名。

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

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

2024 年 4 月 - 引入提升模式

我们正在为 Blocks 引入一种新模式,称为 提升模式

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

提升模式查看块库

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

访问 Blocks 页面进行试用。

2024 年 3 月 - 引入块

自上线以来,最受欢迎的特性之一就是布局:带侧边栏的管理仪表板、营销页面部分、卡片等等。

今天,我们推出了 Blocks

管理仪表板查看块库

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

我们从仪表板布局和身份验证页面开始,计划在接下来的几周中添加更多块。

开源

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

AI 游乐场查看块库

请求一个块

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

设置页面查看块库

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

抽屉

哦,抽屉组件 😍。基于 Vaulemilkowalski_ 创建。

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

分页

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

可调整大小

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

One
Two
Three

<Resizable /> 基于 react-resizable-panelsbvaughn 创建。支持鼠标、触摸和键盘。

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 获取。

您希望使用 TypeScript(推荐)吗?否

要退出 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

pnpm dlx shadcn-ui@latest init

当您运行 init 命令时,将会询问您一些问题以配置 components.json

您希望使用什么样式? › 默认
您希望使用什么颜色作为基础颜色? › Slate
您的全局 CSS 文件在哪里? › › app/globals.css
您想对颜色使用 CSS 变量吗? › 否 / 是
您的 tailwind.config.js 位于哪里? › tailwind.config.js
为组件配置导入别名:› @/components
为工具配置导入别名:› @/lib/utils
您正在使用 React 服务器组件吗? › 否 / 是

此文件包含有关您的组件的所有信息:安装位置、导入路径、样式等。

您可以使用此文件更改组件的导入路径,设置基础颜色或更改样式方法。

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

pnpm dlx shadcn-ui@latest add

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

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

diff(实验性)

pnpm dlx shadcn-ui diff

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

您可以使用此命令查看上游存储库中已更改的内容,并相应地更新项目。

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

pnpm dlx shadcn-ui diff
以下组件有可用更新:
- 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] 以查看更改:

pnpm dlx 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
}

样式

我们引入了一个新概念,称为 Style

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

我们将推出两种样式:defaultnew-york(未来将会有更多)。

默认样式与纽约样式

default 样式是您熟悉的。这是我们自该项目开始以来使用的样式。它使用 lucide-react 作为图标和 tailwindcss-animate 作为动画。

new-york 样式是一个新样式。它配备了更小的按钮、带阴影的卡片和一套来自 Radix Icons 的新图标。

当您运行 init 命令时,将会询问您想使用哪种样式。这将保存在您的 components.json 文件中。

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

主题

从样式开始,然后使用 CSS 变量或 Tailwind CSS 工具类进行主题设置,以完全改变组件的外观。

带主题的样式

退出动画

我为所有组件添加了退出动画。点击下面的组合框以查看细腻的退出动画。

可以使用工具类自定义动画。


其他更新

按钮

  • 添加了一种新的按钮大小 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">关闭</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" />

感谢

我想感谢所有使用这个项目、提供反馈和贡献的人。我非常感激。谢谢 🙏