# Featherity
[](https://discord.gg/EH6nSts)
## What is Featherity?
Featherity is a fork of [Feather Icons](https://github.com/feathericons/feather), with icons sourced by the community.
## Table of Contents
* [Usage](#usage)
* [Figma](#figma)
* [Contributing](#contributing)
* [License](#license)
## Installation
### Package Managers
``` bash
npm install featherity
#or
yarn add featherity
```
### CDN
``` html
```
## Usage
At its core, Featherity is a collection of [SVG](https://svgontheweb.com/#svg) files. This means that you can use Feather icons in all the same ways you can use SVGs (e.g. `img`, `background-image`, `inline`, `object`, `embed`, `iframe`). Here's a helpful article detailing the many ways SVGs can be used on the web: [SVG on the Web – Implementation Options](https://svgontheweb.com/#implementation)
The following are additional ways you can use Featherity.
With the Javascript library you can easily incorporate icon in you webpage.
```html
```
It will replace the html with a svg.
### With unpkg
Here is a complete example with unpkg
```html
```
### With ESModules
To reduce bundle size, featherity is build to be fully threeshakeble.
The `createIcons` function will search for HTMLElements with the attribute `icon-name` and replace it with the svg from the given icon name.
```html
```
```js
import { createIcons, icons } from 'featherity';
// Caustion, this will import all the icons and bundle them.
createIcons({icons});
// Recommended way, to include only the icons you need.
import { createIcons, Menu, ArrowRight, Globe } from 'featherity';
createIcons({
icons: {
Menu,
ArrowRight,
Globe,
},
});
```
#### Additional Options
In the `createIcons` function you can pass some extra parameters to adjust the `nameAttr` or add custom attributes like for example classes.
Here is a full example:
```js
import { createIcons } from 'featherity';
createIcons({
attrs: {
class: ['my-custom-class', 'icon'],
'stroke-width': 1,
stroke: '#333',
},
nameAttr: 'icon-name', // atrribute for the icon name.
});
```
#### Threeshake the library, only use the icons you use
```js
import { createIcons, Menu, ArrowRight, Globe } from 'featherity';
createIcons({
icons: {
Menu,
ArrowRight,
Globe,
},
});
```
#### Custom Element binding
```js
import { createElement, Menu } from 'featherity';
const menuIcon = createElement(Menu); // Returns HTMLElement (svg)
// set custom attributes with browser native functions
menuIcon.setAttribute('stroke', '#333');
menuIcon.classList.add('my-icon-class');
// Append HTMLElement in webpage
const myApp = document.getElementById('app');
myApp.appendChild(menuIcon);
```
### Figma
You can use the components from [this Figma file](https://www.figma.com/file/g0UipfQlRfGrntKPxZknM7/Featherity).
## Contributing
For more info on how to contribute please see the [contribution guidelines](https://github.com/featherity/featherity/blob/master/CONTRIBUTING.md).
Caught a mistake or want to contribute to the documentation? [Edit this page on Github](https://github.com/featherity/featherity/blob/master/README.md)
## Community
Do you want to join our community?
Join us in [discord](https://discord.gg/EH6nSts)!
## License
Feather is licensed under the [ISC License](https://github.com/featherity/featherity/blob/master/LICENSE).