Laravel

需求:


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

使用 HeroUI + Laravel 模板

如果您正在启动一个新项目,您可以运行以下命令之一,来创建一个已预配置好 HeroUI 的 Laravel 项目:

自动安装

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

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

您还可以一次添加多个组件:

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

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

您仍需手动在应用中添加提供者(我们正在努力实现自动化)。

手动安装

添加依赖

在您的 Laravel 项目中,运行以下命令之一以安装 HeroUI:

Hoisted Dependencies Setup

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

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

修改 .npmrc 文件后,需再次执行 pnpm install 以保证依赖正确安装。

Tailwind CSS Setup

HeroUI 建立在 Tailwind CSS 之上,需先安装 Tailwind CSS。可参照官方安装指南安装 Tailwind CSS。随后,请在 tailwind.config.js 文件中添加以下代码:

注意:若使用 pnpm 与 monorepo 架构,请确保指向根 node_modules

提供者设置

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

进入 src 目录,在 app.jsxapp.tsx 中,将 HeroUIProvider 包裹到 App 上: