rdiedrich/phosphoricons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md to be consistent with the new AP

Browse Source
This commit is contained in:
Nuno Moço
2022-09-21 23:05:54 +01:00
committed by GitHub
parent 2d5d7513df
commit 142c87e3b1
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -26,17 +26,20 @@ After that, run `mix deps.get`.
The components are provided by the `Heroicons` module. Each icon is a Phoenix Component you can use in your HEEx templates.
By default the outline style is used:
By default, the icon components will use the outline style, but the `solid` or
`mini` attributes may be passed to select styling, for example:
```eex
<Heroicons.Solid.cake />
<Heroicons.cake />
<Heroicons.cake solid />
<Heroicons.cake mini />
```
You can render the solid or mini styles by providing the `solid` or `mini` flags:
You can also pass arbitrary HTML attributes to the components:
```eex
<Heroicons.Solid.cake solid />
<Heroicons.Solid.cake mini />
```eex
<Heroicons.cake class="w-2 h-2" />
<Heroicons.cake solid class="w-2 h-2" />
```
You can also provide arbitrary HTML attributes to the svg tag, such as classes: