Skip to content

Commit

Permalink
IMP: readme with bootstrap sample
Browse files Browse the repository at this point in the history
  • Loading branch information
GrimLink committed Feb 23, 2022
1 parent a237d48 commit b79ed7a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![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 Bootstrap Icons in your Hyva frontend.
This Magento 2 module adds the option to use [Bootstrap Icons](https://icons.getbootstrap.com/) 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.
Expand Down Expand Up @@ -42,7 +42,7 @@ $bootstrapIcons = $viewModels->require(BootstrapIcons::class);
and use the Bootstrap Icons just as the HeroIcons in Hyva;

```php
<?= $bootstrapIcons->menuHtml('p-1', 24, 24, ["aria-label" => "Open menu"]) ?>
<?= $bootstrapIcons->listHtml('p-1', 24, 24, ["aria-label" => "Open menu"]) ?>
```

### Using SVG icons in CMS content
Expand Down Expand Up @@ -70,4 +70,4 @@ _If you are looking for a Luma based option [checkout this icon pack instead](ht

## Icon License

[Bootstrap Icons](https://github.com/colebemis/feather) used in this module were created by [The Bootstrap Authors](https://github.com/feathericons) under a [MIT License, found here](https://github.com/twbs/icons/blob/main/LICENSE.md)
[Bootstrap Icons](https://github.com/twbs/icons) used in this module were created by [The Bootstrap Authors](https://github.com/twbs) under a [MIT License, found here](https://github.com/twbs/icons/blob/main/LICENSE.md)

0 comments on commit b79ed7a

Please sign in to comment.