Template

I recently worked on a custom module where one of the requirements was to use Font Awesome for custom forms and notifications / alerts.

Most of the people in the Magento community suggest to load Font Awesome via CDN, but this can cause ” blank squares ” and eventually slow down the front-end on slower connections.

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <head>
        <css src="https://use.fontawesome.com/releases/v5.2.0/css/all.css" src_type="url"/>
    </head>
</page>

<?xml version="1.0"?>

<head>

</head>

</page>

So instead using a CDN I decided to add those libraries in Magento which will be merged with the static view files. Here is how it works.

1. Copy files

Go to Host Font Awesome Yourself and download the entire library. The zip file should contain css, js and less files as well as webfonts.

Copy all less files to the following folder.

[Namespace]/[YourModule]/view/frontend/web/css/fontawesome/

1	[Namespace]/[YourModule]/view/frontend/web/css/fontawesome/

Next, copy all files from the webfonts folder to the below path.

[Namespace]/[YourModule]/view/frontend/web/css/webfonts/

1	[Namespace]/[YourModule]/view/frontend/web/css/webfonts/

Make sure you only copy the less files ( no CSS files ).

2. Update Layout XML

Don’t load the library globally if you only need it at one place. In my case, I added those library to my custom controller only. For example:

[Namespace]/[YourModule]/view/frontend/layout/namespace_yourmodule_controller_action.xml

1	[Namespace]/[YourModule]/view/frontend/layout/namespace_yourmodule_controller_action.xml

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <head>
        <css src="Namespace_YourModule::css/fontawesome/fontawesome.css"/>
        <css src="Namespace_YourModule::css/fontawesome/regular.css"/>
        <css src="Namespace_YourModule::css/fontawesome/solid.css"/>
        <css src="Namespace_YourModule::css/style.css"/>
    </head>
    <body>
        <referenceContainer name="content">
            ...
        </referenceContainer>
    </body>
</page>

<?xml version="1.0"?>

<head>

</head>

<body>

...

</referenceContainer>

</body>

</page>

3. Template

Once you have re-compiled your code, you should be able to use Front Awesome in your template. For example:

[Namespace]/[YourModule]/view/frontend/templates/form.phtml

1	[Namespace]/[YourModule]/view/frontend/templates/form.phtml

<button class="action-quicklogin">
    <i class="fas fa-sign-in-alt"></i>
</button>

</button>

Btw. the same works for the adminhtml area in ./view/adminhtml/.

I am using the statement include for dynamic sections in MODx.

{% for page in pages.children.visible %}

    {% set color = page.header.color %}
    {% set classes = page.header.body_classes %}

    <section id="{{ classes }}" class="{{ color }}">
        {% include 'layouts/' ~ classes ~ '.html.twig' %}
    </section>

{% endfor %}

{% for page in pages.children.visible %}

{% set color = page.header.color %}

{% set classes = page.header.body_classes %}

{% include 'layouts/' ~ classes ~ '.html.twig' %}

</section>

{% endfor %}

It was working fine so far, but today I received the following exception that basically means, my snippet tried to include a file that doesn’t exist. The variable classes was empty that causes a broken website.

RuntimeException (400) Template "layouts/.html.twig" is not defined in "default.html.twig" at line 12.

1	RuntimeException (400) Template "layouts/.html.twig" is not defined in "default.html.twig" at line 12.

In my case I improved my snippet with an if condition.

{% if classes is not empty %}

    <section id="{{ classes }}" class="{{ color }}">
        {% include 'layouts/' ~ classes ~ '.html.twig' %}
    </section>

{% endif %}

{% if classes is not empty %}

{% include 'layouts/' ~ classes ~ '.html.twig' %}

</section>

{% endif %}

Tag: Template

Font Awesome Icons without CDN in Magento2

1. Copy files

2. Update Layout XML

3. Template

Template “layouts/.html.twig” is not defined in “default.html.twig” at line 12.