Unverified Commit 26a3ab35 authored by Michael Spiss's avatar Michael Spiss Committed by GitHub

Add documentation for icon style selection

Fixes #89 by adding a paragraph about how to translate icon names from the website to the naming convention used by this package
parent 4fd74f52
......@@ -35,7 +35,19 @@ class MyWidget extends StatelessWidget {
}
```
## Example
### Icon names
Icon names equal those on the [official website](http://fontawesome.io/icons/), but are written in lower camel case. If more than one icon style is available for an icon, the style name is used as prefix, except for "regular".
#### Examples:
Icon name | Code | Style
--- | --- | ---
[angle-double-up](https://fontawesome.com/icons/angle-double-up?style=solid) | FontAwesomeIcons.angleDoubleUp | solid _(this icon does not have other free styles)_
[arrow-alt-circle-up](https://fontawesome.com/icons/arrow-alt-circle-up?style=regular) | FontAwesomeIcons.arrowAltCircleUp | regular
[arrow-alt-circle-up](https://fontawesome.com/icons/arrow-alt-circle-up?style=solid) | FontAwesomeIcons.solidArrowAltCircleUp | solid
## Example App
View the Flutter app in the `example` directory to see all the available `FontAwesomeIcons`.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment