awesome-react-icons

🙋‍♂️ Made by @abhijithvijayan

Donate: PayPal, Patreon

---

❤️ it? ⭐️ it on GitHub or Tweet about it.

Table of Contents

• Installation
• Usage
• API
• Issues
  • 🐛 Bugs
• LICENSE

Installation

Ensure you have Node.js 10 or later installed. Then run the following:

# via npm
npm install awesome-react-icons

# or yarn
yarn add awesome-react-icons

Usage

import Icon from 'awesome-react-icons';

const SampleIcon = () => {
  return (
    <Icon name="user" />
  )
}

API

name

Type: string

Icon's name

size

Type: number or string

Default: 20

Size of icon

stroke

Type: string

Default: currentColor

Stroke color

strokeWidth

Type: number or string

Default: 1.5

Stroke width

rootDivClassName

Type: string

Default: icon-wrapper

Wrapper div element's class name

Issues

Looking to contribute? Look for the Good First Issue label.

🐛 Bugs

Please file an issue here for bugs, missing documentation, or unexpected behavior.

See Bugs

Linting & TypeScript Config

• Shared Eslint & Prettier Configuration - @abhijithvijayan/eslint-config
• Shared TypeScript Configuration - @abhijithvijayan/tsconfig

License

MIT © Abhijith Vijayan