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

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

hyva hyva-icons icons lucide-icon magento2 magento2-module

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/siteation/magento2-hyva-icons-lucide
• Owner: Siteation
• License: mit
• Created: 2022-06-15T20:31:27.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-05T11:22:41.000Z (2 months ago)
• Last Synced: 2024-11-05T12:41:56.399Z (2 months ago)
• Topics: hyva, hyva-icons, icons, lucide-icon, magento2, magento2-module
• Language: PHP
• Homepage: https://siteation.nl
• Size: 1.82 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Siteation - Hyva Icon Pack - LucideIcons

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

![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/siteation/magento2-hyva-icons-lucide?color=%23234&style=for-the-badge)

This Magento 2 module adds the option to use [Lucide Icons](https://lucide.dev/) 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-lucide

bin/magento setup:upgrade

```

> **Warning** 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(LucideIcons::class);

```

and use the LucideIcons just as the HeroIcons in Hyva;

```php

= $lucideIcons->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 "lucide/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

## 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

[Lucide Icons](https://lucide.dev/) used in this module were created by [Lucide Contributors](https://github.com/lucide-icons) under a [ISC License, found here](https://github.com/lucide-icons/lucide/blob/main/LICENSE)