marcw / twig-heroicons

Heroicons <3 Twig

Twig Heroicons

This package provides an Heroicons integration for Twig.

Install

Use composer:

composer require marcw/twig-heroicons

Symfony

You do not need to do anything more to use the extension.

Twig

If you use Twig directly, register the extension before using it:

<?php

use MarcW\Heroicons\Twig\HeroiconsExtension;
use Twig\Environment;

$twig = new Environment(/* ... */);
$twig->addExtension(new HeroiconsExtension());

Usage

This extension provides a heroicon function that outputs the icon SVG.

{# function signature #}
{{ heroicon(icon, class, style) }}

{# the default style is 'solid' #}
{{ heroicon('academic-cap') }}

{# use the 'outline' style #}
{{ heroicon('academic-cap', '', 'outline') }}

{# Add a custom class to the SVG #}
{{ heroicon('academic-cap', 'text-green-200', 'outline') }}

License

This library is MIT licensed.

twig-heroicons's Issues

Make icons cacheable inside opcache

Currently file_get_contents is everytime used to load the icon. This means it need to load and read the icon from the filesystem. This can be an overhead.
I would suggest to create a script which will create a PHP class per icon e.g.:

namespace MarcW\Heroicons\Icons\Solid

use MarcW\Heroicons\IconInterface;

class AcademicCap implements IconInterface {
    public static function getIcon(): string
    {
         return '<svg ... >';
    }
}

Then we can get the icon with:

return call_user_func_array(['MarcW\\Heroicons\\Icons\\' . $solidOrOutline . '\\' . $icon], ['getIcon']);

The advantage of this is that the icon are cacheable inside the opcache of php and don't need to be loaded everytime when being accessed. The svg I would keep in the repository, the classes could be generated over a script inside this repository and so the classes are easy to update if you update the resources directory with new icons. What do you think?

Future deprecation notice

Method "Twig\Extension\ExtensionInterface::getFunctions()" might add "array" as a native return type declaration in the future. Do the same in implementation "MarcW\Heroicons\Twig\HeroiconsExtension" now to avoid errors or add an explicit @return annotation to suppress this message.

Working with Symfony 5

How this exactly is supposed to work? Do I have to register something in Symfony Services to get it working?

An exception has been thrown during the rendering of a template ("Heroicon "academy-cap" in style "outline" cannot be found or is not readable.").

{% extends '@EasyAdmin/page/content.html.twig' %}
{% block page_content %}
    <div class="px-4 py-5 my-5 text-center">
        {{ heroicon('academy-cap', '', 'outline') }}