@icon/font-awesome
v4.7.0-2
Published
The iconic font and CSS framework
Downloads
231
Readme
@icon/font-awesome
This repository is a module of the full icon repository.
Install
This repository is distributed with npm. After installing npm, you can install @icon/font-awesome
with this command.
npm install --save @icon/font-awesome
Usage
There are many ways/formats of how to use font-awesome. The fastest and recommended way is via SVG directly. Or use the webfont version if you want to include all icons at once:
SVG icons -- when you need just a few icons in your project
1 . If you want to use just a few icons. Find the icons you need in "icons" folder. Then use them as regular images:
<img height="32" width="32" src="@icon/font-awesome/icons/address-book.svg" />
2 . Icons can be served from a CDN such as Unpkg. Simply use the @icon/font-awesome
npm package in the URL like the following:
<img height="32" width="32" src="https://unpkg.com/@icon/font-awesome/icons/address-book.svg" />
Icons font -- ideal when you want to include all icons at once
1 . Install @icon/font-awesome
with this command. In the <head>
of your html, reference the location to your font-awesome.css
.
<head>
...
<link rel="stylesheet" href="@icon/font-awesome/font-awesome.css">
...
</head>
2 . Use unpkg.com to load directly font-awesome without installing anything:
<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/font-awesome/font-awesome.css">
...
</head>
Place font-awesome with
<i>
tag in your html like this. Icon class names are to be used with thefa
class prefix.
<i class="fa fa-address-book"></i>
Bugs, Ideas, Pull Requests
If you have any ideas or found bugs, please send me Pull Requests or let me know with GitHub Issues.
License
Font-awesome is copyright by Dave Gandy. Font is licensed under the SIL OFL 1.1. CSS, LESS, and Sass files are licensed under the MIT License. Documentation is licensed under the CC BY 3.0 License.