README

Statamic Heroicons

一个易于在Statamic网站上使用Heroicons的包。此包是blade-ui-kit/blade-heroicons的包装。

要查看可用图标的全列表，请参阅blade-ui-kit/blade-heroicons仓库的SVG目录或heroicons.com上的预览。Heroicons最初由Steve Schoger和Adam Wathan开发。

如果您想使用Heroicons v1，请使用该包的v1版本。

要求

PHP 8.1 或更高版本
Laravel 9.0 或更高版本
Statamic 3.3 或更高版本

除了上述要求之外，您还必须使用Statamic的新Runtime Antlers引擎。有关更多信息以及如何启用它的说明，请参阅Statamic官方文档。

文档

安装

首先，将 statamic-heroicons 作为Composer依赖项要求

composer require stefangalescu/statamic-heroicons

如果您需要其他选项，可以发布blade-ui-kit/blade-heroicons配置。请确保还要查看blade-ui-kit/blade-heroicons提供的图标缓存功能。

使用

{{ heroicon:mini:bars-3 }}

{{ heroicon:solid:bars-3 }}

{{ heroicon:outline:bars-3 }}

{{ heroicon:outline:bars-3 class="text-gray-500" }}

{{ heroicon :variant="variant" :icon="icon" }}

除了几个保留的属性名（as、scope、variant、icon）之外，您可以将任何属性（例如class、style、aria-hidden等）传递给标签，它将被添加到根SVG元素。

{{ heroicon }} 标签还允许您传递动态绑定的属性，就像在Alpine.js这样的JavaScript框架中一样使用。唯一的麻烦是，您不能使用缩写语法:class="condition ? 'text-red-500' : 'text-green-500'"。您必须使用完整的绑定（例如x-bind:class、v-bind:class）。示例

{{ heroicon:solid:bars-3 class="w-5 h-5" title="Main menu" }}

{{ heroicon:solid:bars-3 class="w-5 h-5" x-bind:class="condition ? 'text-red-500' : 'text-green-500'" }}

测试

composer test

安全性

如果发现漏洞，只有statamic-heroicons的最新版本将收到安全更新。

如果您发现安全漏洞，请立即通过电子邮件向Stefan Galescu报告。请不要通过GitHub Issues报告安全漏洞。

赞助Stefan

此插件是开源的，这意味着任何人都可以在他们的网站上免费使用此插件！

然而，维护和为开源项目开发新功能需要相当多的时间。如果您在生产环境中使用statamic-heroicons，请考虑以您认为合理的方式赞助我。

starfolksoftware / statamic-heroicons

维护者

详细信息

README

Statamic Heroicons

要求

文档

安装

使用

测试

安全性

赞助Stefan