Remix

需求


若要在您的 Remix 專案中使用 NextUI,您需要遵循以下步驟

使用 NextUI + Remix 範本

如果您要開始一個新專案,您可以執行以下其中一個命令來建立一個預先配置 NextUI 的 Remix 專案

自動安裝

您可以使用 CLI 新增個別元件。例如,新增按鈕元件

此命令會將按鈕元件新增到您的專案,並管理所有相關的依賴項。

您也可以一次新增多個元件

或者,您可以執行以下命令新增主要的函式庫 @nextui-org/react

如果您省略元件名稱,CLI 會提示您選取要新增的元件。

您仍然需要手動將 provider 新增到您的應用程式中(我們正在努力自動化這個步驟)。

手動安裝

新增依賴項

在您的 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

Provider 設定

安裝 NextUI 後,您需要在應用程式的 根目錄 設定 NextUIProvider

前往 src 目錄,在 root.tsx 中,將 NextUIProvider 包裹在 App 周圍

版本 2 僅與 React 18 或更新版本相容。如果您使用的是 React 17 或更早版本,請使用 NextUI 的版本 1