README

Integrates the Simple Icons SVG icon set into Hyvä Themes, exposing brand icons as a dedicated SvgIcons view model. Preview available icons at simpleicons.org.

Important

SVG icons are not bundled with this module. They are copied automatically from the simple-icons/simple-icons Composer dependency during setup:upgrade and kept in sync on every subsequent run.

Installation

composer require aimanecouissi/module-hyva-simple-icons
bin/magento module:enable AimaneCouissi_HyvaSvgIcons AimaneCouissi_HyvaSimpleIcons
bin/magento setup:upgrade
bin/magento cache:flush

Usage

In Hyvä PHTML templates

Require the view model and call its helper methods to render icons:

<?php

use AimaneCouissi\HyvaSimpleIcons\ViewModel\SimpleIcons;
use Hyva\Theme\Model\ViewModelRegistry;

/** @var ViewModelRegistry $viewModels */

$simpleIcons = $viewModels->require(SimpleIcons::class);
?>

<?= $simpleIcons->phpHtml('w-6 h-6', 24, 24, ['aria-label' => 'PHP']) ?>

Methods are generated from SVG filenames and fully documented via PHPDoc on the view model, so your IDE can autocomplete them. Icons whose names start with a digit are prefixed with an underscore (e.g. _99designsHtml, _500pxHtml).

In CMS content

The module registers the simpleicons prefix for Hyvä SvgIcons. Icons can be used directly in CMS pages, blocks, and widgets:

{{icon "simpleicons/php" classes="inline-block w-6 h-6" width=24 height=24}}

Uninstall

bin/magento module:disable AimaneCouissi_HyvaSimpleIcons
composer remove aimanecouissi/module-hyva-simple-icons
bin/magento setup:upgrade
bin/magento cache:flush

Changelog

See CHANGELOG for all recent changes.

License

The Simple Icons SVG icons are created by Simple Icons contributors and dedicated to the public domain under CC0 1.0.

Warning

Individual brand icons may be subject to their own trademark and usage guidelines. Trademark usage is the responsibility of the end user. Please consult individual brand guidelines before displaying logos in commercial contexts. See DISCLAIMER.md for further details.

This module's source code is separately licensed under MIT.

aimanecouissi / module-hyva-simple-icons

Maintainers

Package info

Statistics

Security