Vite

Requirements:


要在 Vite 项目中使用 HeroUI,需要按以下步骤操作:

HeroUI CLI(推荐)

如果你正在启动一个新项目,可以使用 HeroUI CLI 来创建一个预配置好的 HeroUI 项目:

使用 HeroUI + Vite 模板

如果你正在启动一个新项目,可以运行以下任一命令来创建一个预配置好的 Vite 项目:

自动安装

你可以使用 CLI 添加单个组件。例如,添加一个按钮组件:

此命令会将 Button 组件添加到项目并管理所有相关依赖。

你也可以一次添加多个组件:

或者,你可以通过运行以下命令来添加主库 @heroui/react

如果你省略了组件名称,CLI 会提示你选择想要添加的组件。

你仍需手动在应用中添加提供者(我们正在尝试自动化此步骤)。

手动安装

添加依赖

在你的 Vite React 项目中,运行以下任一命令以安装 HeroUI:

Hoisted Dependencies Setup

Note: 此步骤仅适用于使用 pnpm 安装的情况。如果使用其他包管理器安装 HeroUI,则可以跳过此步骤。

如果你使用 pnpm,需要在 .npmrc 文件中添加以下行,将我们的包提升到根 node_modules

修改 .npmrc 后,请再次运行 pnpm install 以确保正确安装依赖。

Tailwind CSS Setup

HeroUI 基于 Tailwind CSS 开发,因此请先安装 Tailwind CSS。你可以参考官方 安装指南 进行安装。

Note: 如果你使用 pnpm 并采用 monorepo 架构,请确保你指向的是 ROOT node_modules

接下来,创建 hero.ts 文件

并在主 CSS 文件中添加以下代码:

Provider Setup

安装完 HeroUI 后,你需要在应用的根部设置 HeroUIProvider

进入 src 目录,在 main.jsxmain.tsx 中将 HeroUIProvider 包裹在 App 外层: