https://github.com/siteation/magento2-hyva-icons-feather

This Magento 2 module adds the option to use Feather Icons in your Hyva frontend.
https://github.com/siteation/magento2-hyva-icons-feather

feather-icons hyva hyva-icons icons magento2 magento2-module

Last synced: about 2 months ago
JSON representation

This Magento 2 module adds the option to use Feather Icons in your Hyva frontend.

• Host: GitHub
• URL: https://github.com/siteation/magento2-hyva-icons-feather
• Owner: Siteation
• License: mit
• Created: 2021-10-04T17:17:59.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-03T17:47:21.000Z (8 months ago)
• Last Synced: 2024-10-06T17:48:14.830Z (3 months ago)
• Topics: feather-icons, hyva, hyva-icons, icons, magento2, magento2-module
• Language: PHP
• Homepage: https://siteation.dev
• Size: 96.7 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Siteation - Hyva Icon Pack - FeatherIcons

[![Packagist Version](https://img.shields.io/packagist/v/siteation/magento2-hyva-icons-feather?style=for-the-badge)](https://packagist.org/packages/siteation/magento2-hyva-icons-feather)

![Supported Magento Versions](https://img.shields.io/badge/magento-%202.4-brightgreen.svg?logo=magento&longCache=true&style=for-the-badge)

[![Hyva Themes Module](https://img.shields.io/badge/Hyva_Themes-Module-3df0af.svg?longCache=true&style=for-the-badge)](https://hyva.io/)

![License](https://img.shields.io/github/license/fylgja/fylgja?color=%23234&style=for-the-badge)

This Magento 2 module adds the option to use [Feather Icons](https://github.com/colebemis/feather) in your Hyva frontend.

This requires that you have a working Hyva frontend,

this icon pack was made specifically for Hyva Themes and will not work out of the box with any other frontend.

## Installation

Install the package via;

```bash

composer require siteation/magento2-hyva-icons-feather

bin/magento setup:upgrade

```

> This Module requires Magento 2.4 or higher and requires Hyva!

> For more requirements see the `composer.json`.

## How to use

By default this module loads nothing.

To use this icon pack instead of the default Hyva icons, add the following to your phtml file;

```php

require(FeatherIcons::class);

```

and use the FeatherIcons just as the HeroIcons in Hyva;

```php

= $featherIcons->menuHtml('p-1', 24, 24, ["aria-label" => "Open menu"]) ?>

```

### Using SVG icons in CMS content

You can now also use the SVG icons in your CMS content.

Bringing svg icon support to you CMS pages, Blocks and Widgets.

```txt

{{icon "feather/menu"}}

```

[For more information on how and what see the Hyva Docs](https://docs.hyva.io/hyva-themes/writing-code/working-with-view-models/svgicons.html#using-svg-icons-in-cms-content)

> This feature is supported since Hyva v1.1.12 and Siteation/magento2-hyva-icons-feather v1.2

## Other icon packs for Hyva

- For Icons packs see https://github.com/topics/hyva-icons

_If you are looking for a Luma based option [checkout this icon pack instead](https://github.com/GrimLink/magento2-icon-packs)._

## Icon License

[Feather Icons](https://github.com/colebemis/feather) used in this module were created by [Cole Bemis](https://github.com/feathericons) under a [MIT License, found here](https://github.com/feathericons/feather/blob/master/LICENSE)