Feather


What is Feather?

Feather is a collection of simply beautiful open source icons. Each icon is designed on a 24x24 grid with an emphasis on simplicity, consistency and readability.

https://feathericons.com

``sh
npm install feather-icons
`

Sponsored by

Table of Contents

* Quick Start
* Usage
* Client-side JavaScript
* Node
* SVG Sprite
* API Reference
* feather.icons
* [feather.icons[name].toSvg()](#feathericonsnametosvgattrs)
* feather.replace()
* (DEPRECATED) feather.toSvg()
* Roadmap
* Contributing
* Related Projects
* License

Quick Start

Start with this CodePen Template to begin prototyping with Feather in the browser.

Or copy and paste the following code snippet into a blank html file.

`html









`

Usage

At its core, Feather is a collection of 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

The following are additional ways you can use Feather.

$3

#### 1. Install

> Note: If you intend to use Feather with a CDN, you can skip this installation step.

Install with npm.

`
npm install feather-icons --save
`

Or just copy feather.js or feather.min.js into your project directory. You don't need both feather.js and feather.min.js.

#### 2. Include

Include feather.js or feather.min.js with a
`

Or load the script from a CDN provider.

`html



`

After including the script, feather will be available as a global variable.

#### 3. Use

To use an icon on your page, add a data-feather attribute with the icon name to an element.

`html

`

See the complete list of icons at feathericons.com.

#### 4. Replace

Call the feather.replace() method.

`html

`

All elements that have a data-feather attribute will be replaced with SVG markup corresponding to their data-feather attribute value. See the API Reference for more information about feather.replace().

$3

`
npm install feather-icons --save
`

#### 2. Require

`javascript
const feather = require('feather-icons')
`

#### 3. Use

`js
feather.icons.x
// {
// name: 'x',
// contents: ',
// tags: ['cancel', 'close', 'delete', 'remove'],
// attrs: {
// class: 'feather feather-x',
// xmlns: 'http://www.w3.org/2000/svg',
// width: 24,
// height: 24,
// viewBox: '0 0 24 24',
// fill: 'none',
// stroke: 'currentColor',
// 'stroke-width': 2,
// 'stroke-linecap': 'round',
// 'stroke-linejoin': 'round',
// }
// }

feather.icons.x.toSvg()
//

feather.icons.x.toSvg({ class: 'foo bar', 'stroke-width': 1, color: 'red' })
//
``

See the API Reference for more information about the available properties and methods of the feather object.

$3

#### 1. Install

> Note: If you intend to use Feather with a CDN, you can skip this installation step.

Install with npm.

`
npm install feather-icons --save
`

Or just copy feather-sprite.svg into your project directory.

#### 2. Use

In your HTML, you can include an icon like so:

`html
width="24"
height="24"
fill="none"
stroke="currentColor"
stroke-width="2"
stroke-linecap="round"
stroke-linejoin="round"
>


`

> Note: circle in the above example can be replaced with any valid icon name. See the complete list of icon names at feathericons.com.

However, this markup can be simplified using a simple CSS class to avoid repetition of SVG attributes between icons.

`css
.feather {
width: 24px;
height: 24px;
stroke: currentColor;
stroke-width: 2;
stroke-linecap: round;
stroke-linejoin: round;
fill: none;
}
`

`html



`

API Reference

$3

An object with data about every icon.

#### Usage

`js
feather.icons.x
// {
// name: 'x',
// contents: '',
// tags: ['cancel', 'close', 'delete', 'remove'],
// attrs: {
// class: 'feather feather-x',
// xmlns: 'http://www.w3.org/2000/svg',
// width: 24,
// height: 24,
// viewBox: '0 0 24 24',
// fill: 'none',
// stroke: 'currentColor',
// 'stroke-width': 2,
// 'stroke-linecap': 'round',
// 'stroke-linejoin': 'round',
// }
// }

feather.icons.x.toString()
// ''
`

> Note: x in the above example can be replaced with any valid icon name. See the complete list of icon names at feathericons.com. Icons with multi-word names (e.g. arrow-right) cannot be accessed using dot notation (e.g. feather.icons.x). Instead, use bracket notation (e.g. feather.icons['arrow-right']).

View Source

---

$3

Returns an SVG string.

#### Parameters

| Name | Type | Description |
| --------- | ------ | ----------- |
| attrs (optional) | Object | Key-value pairs in the attrs object will be mapped to HTML attributes on the tag (e.g. { foo: 'bar' } maps to foo="bar"). All default attributes on the tag can be overridden with the attrs object. |

#### Usage

`javascript
feather.icons.circle.toSvg()
// ''

feather.icons.circle.toSvg({ 'stroke-width': 1 })
// ''

feather.icons.circle.toSvg({ class: 'foo bar' })
// ''
`

View Source

---

$3

Replaces all elements that have a data-feather attribute with SVG markup corresponding to the element's data-feather attribute value.

#### Parameters

| Name | Type | Description |
| ---------- | ------ | ----------- |
| attrs (optional) | Object | Key-value pairs in the attrs object will be mapped to HTML attributes on the tag (e.g. { foo: 'bar' } maps to foo="bar"). All default attributes on the tag can be overridden with the attrs object. |

#### Usage

> Note: feather.replace() only works in a browser environment.

Simple usage:
`html




`

You can pass feather.replace() an attrs object:
`html




`

All attributes on the placeholder element (i.e. ) will be copied to the tag:

`html




`

View Source

---

$3

> Note: feather.toSvg() is deprecated. Please use feather.icons[name].toSvg() instead.

Returns an SVG string.

#### Parameters

| Name | Type | Description |
| --------- | ------ | ----------- |
| name | string | Icon name |
| attrs (optional) | Object | Key-value pairs in the attrs object will be mapped to HTML attributes on the tag (e.g. { foo: 'bar' } maps to foo="bar"). All default attributes on the tag can be overridden with the attrs object. |

#### Usage

`javascript
feather.toSvg('circle')
// ''

feather.toSvg('circle', { 'stroke-width': 1 })
// ''

feather.toSvg('circle', { class: 'foo bar' })
// ''
`

View Source

Roadmap

- [ ] Write icon design guidelines
- [ ] Track code coverage
- [ ] Improve SVG accessibility
- [ ] Handle usage of custom icons
- [ ] Add usage examples
- [ ] Make ` web component

Contributing

For more info on how to contribute please see the contribution guidelines.

Caught a mistake or want to contribute to the documentation? Edit this page on Github

Related Projects

- angular-feather - Feather icons for Angular applications
- elm-feather - Feather icons for Elm applications
- react-feather - Feather icons as React components
- sketch-feather - Feather icons as a Sketch library
- vue-feather-icon - Feather icons as Vue components

License

Feather is licensed under the MIT License.