Remix

要求


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

使用 NextUI + Remix 模板

如果您要开始一个新项目,可以运行以下命令之一来创建一个预配置了 NextUI 的 Remix 项目

自动安装

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

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

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

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

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

您仍然需要手动将提供程序添加到您的应用程序中(我们正在努力实现此步骤的自动化)。

手动安装

添加依赖项

在您的 Remix 项目中,运行以下命令之一来安装 NextUI

提升的依赖项设置

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

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

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

Tailwind CSS 设置

NextUI 基于 Tailwind CSS 构建,因此您需要首先安装 Tailwind CSS。您可以按照官方安装指南来安装 Tailwind CSS。然后,您需要在 tailwind.config.js 文件中添加以下代码

注意:如果您使用 pnpm 和 monorepo 架构,请确保您指向的是根 node_modules

提供程序设置

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

转到 src 目录,在 root.tsx 中,将 NextUIProvider 包裹在 App 周围

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