README

此插件提供了一种简单的方式来显示 SVG 图标，并提供了自定义和/或缓存它们的选项。它作为一个特质打包，可以在您的应用程序的任何位置使用，并且提供了一个助手（使用特质）以方便使用和缓存。

安装

您可以使用 composer 将此插件安装到您的 CakePHP 应用程序中。

安装 composer 包的推荐方式是

composer require loadsys/cakephp-svg-icon

版本

标签 1.x 用于 CakePHP v4.x。
标签 2.x 用于 CakePHP v5.x。

配置

图标应添加到 config/app_svg_icon.php - 请参阅 config 目录中包含的示例以了解预期格式。任何 SVG 图标都应工作，例如 heroicons 或 Bootstrap Icons。

图标将使用 default 缓存配置进行缓存。这可以通过在加载助手时提供不同的缓存配置来更改

/*
 * src/View/AppView.php
 */
public function initialize(): void
{
    $this->loadHelper('SvgIcon.SvgIcon', [
        'cacheConfig' => 'svg_icon',
    ]);
}

此示例将使用 svg_icon 缓存配置，这可以在 config/app/php 中设置

/*
 * Optional configuration settings for the SvgIcon plugin cache
 */
'svg_icon' => [
    'className' => FileEngine::class,
    'prefix' => 'svg_icon_',
    'path' => CACHE . 'views' . DS,
    'duration' => '+1 years',
    'url' => env('CACHE_DEFAULT_URL', null),
]

使用

配置的图标可以通过名称显示 - 这里是基于 config/app_svg_icon.php 中的示例名称的示例。

<?= $this->SvgIcon->get('heroicon.home') ?>
<?= $this->SvgIcon->get('bootstrap.bi-house') ?>

要更改默认图标属性，可以提供选项

<?= $this->SvgIcon->get('heroicon.home', [
  'class' => 'text-gray-300 h-9 w-9',
  'stroke-width' => '2',
]) ?>

请注意，属性覆盖仅适用于 svg 标签，而不是其子 path 标签。

loadsys / cakephp-svg-icon

维护者

详情

README

安装

版本

配置

使用