https://github.com/mveytsman/heroicons_elixir
Phoenix components for Heroicons! 🛡️
https://github.com/mveytsman/heroicons_elixir
elixir phoenix-liveview
Last synced: about 1 year ago
JSON representation
Phoenix components for Heroicons! 🛡️
- Host: GitHub
- URL: https://github.com/mveytsman/heroicons_elixir
- Owner: mveytsman
- License: mit
- Created: 2021-03-03T22:42:56.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-18T12:59:46.000Z (over 2 years ago)
- Last Synced: 2024-04-14T05:51:50.683Z (about 2 years ago)
- Topics: elixir, phoenix-liveview
- Language: Elixir
- Homepage:
- Size: 1.74 MB
- Stars: 115
- Watchers: 4
- Forks: 27
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Heroicons
[Heroicons](https://heroicons.com) are "a set of free MIT-licensed high-quality SVG icons for you to use in your web projects". This package gives you Elixir functions to drop Heroicons into your HTML, styled with arbitrary classes.
This library provides optimized svgs for each Heroicon packaged as a Phoenix Component.
Heroicons are designed by [Steve Schoger](https://twitter.com/steveschoger)
Current Heroicons Version: **2.1.5**.
## Installation
Add Heroicons to your `mix.exs`:
```elixir
defp deps do
[
{:heroicons, "~> 0.5.5"}
]
end
```
After that, run `mix deps.get`.
## Usage
The components are provided by the `Heroicons` module. Each icon is a Phoenix Component you can use in your HEEx templates.
By default, the icon components will use the outline style, but the `solid`,
`mini` or `micro` attributes may be passed to select styling, for example:
```eex
```
You can also pass arbitrary HTML attributes to the components, such as classes:
```eex
```
For a full list of icons see [the docs](https://hexdocs.pm/heroicons/api-reference.html) or [heroicons.com](https://heroicons.com/).