Bump version + readme
This commit is contained in:
25
README.md
25
README.md
@ -8,36 +8,35 @@ Heroicons are designed by [Steve Schoger](https://twitter.com/steveschoger)
|
|||||||
|
|
||||||
Add Heroicons to your `mix.exs`:
|
Add Heroicons to your `mix.exs`:
|
||||||
|
|
||||||
|
```elixir
|
||||||
defp deps do
|
defp deps do
|
||||||
[
|
[
|
||||||
{:heroicons, "~> 0.2.2"}
|
{:heroicons, "~> 0.3.0"}
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
```
|
||||||
|
|
||||||
After that, run `mix deps.get`.
|
After that, run `mix deps.get`.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
The icons are in `Heroicons.Solid` and `Heroicons.Outline`. You can get a heroicon by name
|
The components are in `Heroicons.Solid` and `Heroicons.Outline`. Each icon is a Phoenix Component you can use in your HEEx templates.
|
||||||
|
|
||||||
```eex
|
```eex
|
||||||
<%= Heroicons.Solid.cake() %>
|
<Heroicons.Solid.cake />
|
||||||
```
|
```
|
||||||
|
|
||||||
and style it with some classes
|
and style it with some classes
|
||||||
|
|
||||||
```eex
|
```eex
|
||||||
|
<Heroicons.Solid.cake class="h-6 w-6 text-gray-500" />
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that if you are not using HEEx/LiveView, there are (deprecated) function versions of each component:
|
||||||
|
```eex
|
||||||
|
<%= Heroicons.Solid.cake() %>
|
||||||
|
|
||||||
<%= Heroicons.Solid.cake(class: "h-6 w-6 text-gray-500") %>
|
<%= Heroicons.Solid.cake(class: "h-6 w-6 text-gray-500") %>
|
||||||
```
|
```
|
||||||
|
|
||||||
Note these functions return `Phoenix.HTML.Safe` iodata:
|
|
||||||
```elixir
|
|
||||||
iex(1)> Heroicons.Solid.academic_cap
|
|
||||||
{:safe,
|
|
||||||
["<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 20 20\" fill=\"currentColor\"", #...
|
|
||||||
|
|
||||||
iex(2)> Heroicons.Solid.academic_cap |> Phoenix.HTML.safe_to_string
|
|
||||||
"<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 20 20\" fill=\"currentColor\">\n ..."
|
|
||||||
```
|
|
||||||
|
|
||||||
For a full list of icons see [the docs](https://hexdocs.pm/heroicons/api-reference.html) or [heroicons.com](https://heroicons.com/).
|
For a full list of icons see [the docs](https://hexdocs.pm/heroicons/api-reference.html) or [heroicons.com](https://heroicons.com/).
|
||||||
|
2
mix.exs
2
mix.exs
@ -4,7 +4,7 @@ defmodule HeroiconsElixir.MixProject do
|
|||||||
def project do
|
def project do
|
||||||
[
|
[
|
||||||
app: :heroicons,
|
app: :heroicons,
|
||||||
version: "0.2.4",
|
version: "0.3.0",
|
||||||
elixir: "~> 1.11",
|
elixir: "~> 1.11",
|
||||||
start_permanent: Mix.env() == :prod,
|
start_permanent: Mix.env() == :prod,
|
||||||
deps: deps(),
|
deps: deps(),
|
||||||
|
Reference in New Issue
Block a user