feather-icons-ts-react/README.md
2018-03-05 18:22:44 -06:00

30 lines
740 B
Markdown

# Feather Icons React
[![npm](https://img.shields.io/npm/v/feather-icons-react.svg)](https://www.npmjs.com/package/feather-icons-react)
`npm install --save feather-icons-react`
This package lets you use [Feather Icons](https://feathericons.com/) as a React Component.
Feather Icons is an svg font library by Cole Bemis.
### Example usage:
```
import FeatherIcon from 'feather-icons-react';
<FeatherIcon icon="close" />
```
**Setting a size:**
Size can be passed as either string or number.
e.g.: `<FeatherIcon icon="copy" size="24" />` or `<... size={24} />`
Sizes can always be easily overridden by CSS.
The icons are all square.
The full list of icon names can be referenced at: [feathericons.com](https://feathericons.com/)