@icon/feather

Simply beautiful open source icons

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@icon/feather
Minified + gzip package size for @icon/feather in KB

Readme

@icon/feather

npm version

This repository is a module of the full standard-icons repository.

Install

This repository is distributed with npm. After installing npm, you can install @icon/feather with this command.

npm install --save @icon/feather

Usage

There are many ways/formats of how to use feather. 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/feather/icons/book.svg" />

2 . Icons can be served from a CDN such as Unpkg. Simply use the @icon/feather npm package in the URL like the following:

<img height="32" width="32" src="https://unpkg.com/@icon/feather/icons/book.svg" />

Icons font -- ideal when you want to include all icons at once

1 . Install @icon/feather with this command. In the <head> of your html, reference the location to your feather.css.

<head>
...
<link rel="stylesheet" href="@icon/feather/feather.css">
...
</head>

2 . Use unpkg.com to load directly feather without installing anything:

<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/feather/feather.css">
...
</head>

Place feather with <i> tag in your html like this. Icon class names are to be used with the fe class prefix.

<i class="fe fe-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

Feather is copyright by colebemis, licensed under the MIT.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.