xbirdfr / ux-icons-alias-bundle
1.0.2
2024-08-13 23:18 UTC
Requires
- php: >=8.2
- symfony/ux-icons: ^2.19
This package is auto-updated.
Last update: 2024-09-26 13:50:45 UTC
README
⚠️ 注意: 此存储库不再维护,因为 Symfony UX 现在提供了更强大的处理图标别名的解决方案。
有关更多详细信息,请参阅 Symfony UX 文档中的别名字典。
此 Bundle 为 Symfony UX 图标 提供一个别名字典。
它在 symfony/ux-icons(从 2.19 版本开始引入)的基础上添加了一个 Twig 函数。
安装
确保全局安装了 Composer,如 Composer 文档中的安装章节所述。
使用 Symfony Flex 的应用程序
打开终端,导航到您的项目目录,并运行以下命令
composer require xbirdfr/ux-icons-alias-bundle
未使用 Symfony Flex 的应用程序
步骤 1:下载 Bundle
打开终端,导航到您的项目目录,并运行以下命令以下载此 Bundle 的最新稳定版本
composer require xbirdfr/ux-icons-alias-bundle
步骤 2:启用 Bundle
然后,通过将其添加到项目 config/bundles.php
文件中注册的 Bundle 列表中来启用 Bundle
// config/bundles.php return [ // ... Xbird\UxIconsAliasBundle\UxIconsAliasBundle::class => ['all' => true], ];
使用方法
步骤 1:创建配置文件
在 config/packages
目录中创建 ux_icons_alias.yaml
文件
# config/packages/ux_icons_alias.yaml ux_icons_alias: alias:
步骤 2:创建别名
通过向 alias
数组中添加 "key: icon-name" 对来创建您的第一个别名
# config/packages/ux_icons_alias.yaml ux_icons_alias: alias: home: material-symbols:home
除非您的别名将不会显示,否则不要忘记清除缓存
php bin/console cache:clear
步骤 3:使用您的新的别名
在 Twig 模板中,使用 ux_icon_alias
函数来显示您的别名字符
{{ ux_icon_alias('alias', { attributes }) }}
{# In a Twig template #} <div> {{ ux_icon_alias('home') }} </div> <div> {{ ux_icon_alias('home', {class: 'w-4 h-4'}) }} </div>
另外一件事
此 Bundle 是基于 symfony/ux-icons Bundle 构建的。
当调用时,此 Bundle 会检查配置中是否存在别名。如果存在,则将相应的值传递给 ux-icons
。如果别名不存在,则将别名名称本身传递给 ux-icons
。