Vite

要求


要在你的 Vite 项目中使用 NextUI,你需要按照以下步骤操作

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

或者

使用 NextUI + Vite 模板

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

自动安装

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

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

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

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

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

你仍然需要手动将 provider 添加到你的应用程序中(我们正在努力自动化这一步骤)。

手动安装

添加依赖项

在你的 Vite React 项目中,运行以下命令之一来安装 NextUI

提升的依赖项设置

注意:此步骤仅适用于使用 pnpm 安装的用户。如果你使用其他包管理器安装 NextUI,可以跳过此步骤。

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

修改 .npmrc 文件后,你需要再次运行 pnpm install,以确保正确安装依赖项。

Tailwind CSS 设置

NextUI 构建于 Tailwind CSS 之上,因此你需要先安装 Tailwind CSS。你可以按照官方的安装指南安装 Tailwind CSS。然后,你需要将以下代码添加到你的 tailwind.config.js 文件中

注意:如果你正在使用 pnpm 和 monorepo 架构,请确保你指向 ROOT node_modules

Provider 设置

安装 NextUI 后,您需要在应用程序的 root 处设置 NextUIProvider

前往 src 目录,在 main.jsxmain.tsx 文件中,将 NextUIProvider 包裹在 App 组件周围。

版本 2 仅与 React 18 或更高版本兼容。如果您使用的是 React 17 或更早版本,请使用 NextUI 的版本 1