owenvoke / blade-fontawesome
一个用于在 Laravel Blade 视图中轻松使用 Font Awesome 的包
Requires
- php: ^8.1
- blade-ui-kit/blade-icons: ^1.5
- illuminate/support: ^10.34|^11.0
- thecodingmachine/safe: ^2.5
Requires (Dev)
- laravel/pint: ^1.13
- orchestra/testbench: ^8.12|^9.0
- pestphp/pest: ^2.26
- phpstan/phpstan: ^1.10
- symfony/var-dumper: ^6.3
- thecodingmachine/phpstan-safe-rule: ^1.2
README
一个用于在您的 Laravel Blade 视图中轻松使用 Font Awesome 的包。
有关可用图标的全列表,请参阅 SVG 目录。
旧版本文档
您正在阅读 2.x
版本的文档。
如果您正在使用 Laravel 8 或以下版本,请参阅 1.x 版本的文档。
有关升级到最新版本的说明,请参阅 升级指南。
要求
- PHP 8.1 或更高版本
- Laravel 10.x 或更高版本
安装
通过 Composer
composer require owenvoke/blade-fontawesome
配置
Blade Font Awesome 还提供了使用 Blade Icons 的功能,如默认类、默认属性等。如果您想配置这些,请发布 blade-fontawesome.php
配置文件
php artisan vendor:publish --tag=blade-fontawesome-config
使用方法
图标可以作为自闭合的 Blade 组件使用,这些组件将被编译为 SVG 图标
<x-fas-cloud/>
您还可以向图标组件传递类
<x-fas-cloud class="w-6 h-6 text-gray-500"/>
甚至可以使用内联样式
<x-fas-cloud style="color: #555"/>
图标集
注意:这些是指定图标集的默认前缀,所有这些都可以在
config/blade-fontawesome.php
文件 中进行配置。
免费图标集
- 品牌 (
fab
) - 常规 (
far
) - 实心 (
fas
)
专业图标集
- 双色 (
fad
) - 浅色 (
fal
) - 细 (
fat
) - 锐化常规 (
far-sharp
) - 锐化浅色 (
fal-sharp
) - 锐化实心 (
fas-sharp
) - 自定义图标集 (
fak
)
原始 SVG 图标
如果您想将原始 SVG 图标作为资产使用,您可以使用以下命令发布它们
php artisan vendor:publish --tag=blade-fontawesome --force
然后在您的视图中使用它们,如下所示
<img src="{{ asset('vendor/blade-fontawesome/solid/cloud.svg') }}" width="10" height="10"/>
Font Awesome Pro
Blade Font Awesome 支持使用 npm 下载的专业图标。
要使用此功能,请使用 npm i --save @fortawesome/fontawesome-pro
安装 Font Awesome Pro,然后运行以下 Artisan 命令将图标添加到您的 resources
路径。
php artisan blade-fontawesome:sync-icons --pro
Blade Font Awesome 将自动检测并使用位于 resources/icons/blade-fontawesome
路径下的专业图标。
由于图标数量众多,当使用专业图标时可能会出现一些性能影响。如果您想减轻这种影响,您可以缓存图标。为此,请运行以下 Artisan 命令
php artisan icons:cache
Blade Icons
Blade Font Awesome 在底层使用 Blade Icons。有关其他功能,请参阅 Blade Icons 的说明。
变更日志
请参阅 CHANGELOG 了解最近的变化。
测试
composer test
贡献
请参阅 CONTRIBUTING 了解详细信息。
安全
如果您发现任何与安全相关的问题,请通过电子邮件 security@voke.dev 反馈,而不是使用问题跟踪器。
鸣谢
许可证
MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件。
Treeware
您可以使用此包,但如果它进入您的生产环境,您需要为世界买一棵树。
众所周知,解决气候危机并保持我们的温度不上升超过1.5C的最好工具之一是植树。如果您支持此包并贡献于Treeware森林,您将为当地家庭创造就业机会并恢复野生动物栖息地。
您可以通过 这里 购买树木。
有关Treeware的更多信息,请访问 treeware.earth。