adamkiss/kirby-icons-heroicons

Heroicons作为Kirby CMS的片段

安装: 338

依赖项: 0

建议者: 0

安全性: 0

星星: 10

关注者: 1

分支: 1

开放问题: 0

类型:kirby-plugin

2.1.3 2024-04-27 23:20 UTC

This package is auto-updated.

Last update: 2024-09-28 00:24:17 UTC


README

Heroicons Heroicons

一套450+个免费MIT授权的高质量SVG图标,您可以在您的Kirby CMS项目中使用。
作为一组Kirby片段打包,允许您轻松嵌入。查看原始项目获取更多信息。

安装

下载文件夹并将其复制到您的site/plugins/文件夹中,或使用composer

composer require adamkiss/kirby-icons-heroicons

用法

// use an icon as is
snippet('heroicons/solid/check');

// or
snippet('heroicons/mini/check');

// or add additional classes
snippet('heroicons/outline/check', [
    'class' => 'red-color',
    'attributes' => 'aria-hidden="true" data-hook="something"' // You can also add custom attributes
    'strokeWidth' => 3 // Outline icons have a modifiable stroke width as well
]);

可用变体/尺寸

  • 轮廓(24px)
  • 实心(24px)
  • 迷你(20px)
  • 微型(16px)

默认情况下,不使用类,默认属性是aria-hidden="true"。如果您添加了属性并希望保留aria-hidden属性,您也必须添加它。

图标字段支持(WIP)

当您同时安装Heroicons和图标字段时,您可以使用所有Heroicons作为图标字段的选项

// in your config.php, configure icon-field to use Heroicons by default
'tobimori.icon-field' => [
    'folder' => fn() => \Heroicons::folder(),
    'sprite' => fn() => \Heroicons::sprite(),
],
# In your bluprints, keep the icon field folder/sprite blank for the
# default to to be picked upw
fields:
  icon:
    label: Icon
    type: icon
    max: 1

然后,一旦您在面板中设置了图标,您就可以在模板/片段中这样使用它

<?= snippet("heroicons/mini/{$page->icon()}") ?>

有关更多信息,您可以查看Kirby图标字段文档

许可证

MIT (c) 2024 Adam Kiss(插件),Tailwind Labs(Heroicons)