mindkomm/theme-lib-icons

WordPress 主题图标精灵辅助函数集合

维护者

详细信息

github.com/mindkomm/theme-lib-icons

源代码

问题

安装: 358

依赖关系: 0

建议者: 0

安全: 0

星标: 0

关注者: 5

分支: 0

公开问题: 0

1.0.1 2018-11-22 13:18 UTC

Requires

MIT c4ee1981af5058c915cf5886b749ce5c8574e600

This package is auto-updated.

Last update: 2024-09-23 01:49:38 UTC

README

WordPress 主题图标精灵辅助函数集合。

安装

您可以通过 Composer 安装此包

composer require mindkomm/theme-lib-icons

函数

get_icon

获取一个图标

此函数是一个包装器，只需提供图标的名称而不是整个路径，就可以更容易地包含图标。通过添加此函数，还可以使用主题版本常量进行缓存破坏。

get_icon( string $icon_name, string $width, string $height, array $args = [] )

返回： string 用于模板的 HTML。

PHP

<?php
echo get_icon( 'angle-down', 12, 12, [ 'class' => 'icon icon-dropdown' ] );

get_svg_icon

返回图标精灵中的可访问 SVG 图标的 HTML。

有添加图标描述的可能性，以提高更好的可访问性。

get_svg_icon( string $path, string $width = '', string $height = '', array $args = [] )

返回： string 用于模板的 HTML。

PHP

<?php
echo get_svg_icon(
    'https://www.mind.ch/wp-content/theme/theme-mind/build/icons/icon-sprite.svg#arrow-right',
    20, 20,
    [ 'class' => 'icon']
);

prepare_html_tag_attribute

将值和名称转换为 HTML 属性。

prepare_html_tag_attribute( string $value = '', string $name = '' )

返回： string

get_icon_url

获取图标精灵的 URI。

返回： string 图标精灵的 URI。默认 build/icons/icons.svg

过滤器

get_icon_url

图标精灵的默认位置是 build/icons/icons.svg。如果您已使用不同的文件夹结构设置主题，则可以使用 get_icon_url 过滤器在此库中使用不同的 URL。

add_filter( 'get_icon_url', function( $icon_url ) {
    return 'absolute/path/to/your/icon/sprite.svg';
} );

Twig 函数

您需要 Timber 来使用此功能。

icon

用于 get_icon() 的简写函数。

{{ icon('angle-down', 12, 12, { class: 'icon icon-dropdown' }) }}

支持

这是我们用于开发 WordPress 主题的库。您可以自由使用它，但当前我们不提供任何支持。