This is a fork of React Icons with some spark icons added

Include popular icons in your React projects easily with spark-icons, which utilizes ES6 imports that allows you to include only the icons that your project is using.

yarn add @uswitch/spark-icons
# or
npm install @uswitch/spark-icons --save

example usage

import { FaBeer } from '@uswitch/spark-icons/fa';

class Question extends React.Component {
    render() {
        return <h3> Lets go for a <FaBeer />? </h3>
    }
}

View the documentation for further usage examples and how to use icons from other packages. NOTE: each Icon package has it's own subfolder under react-icons you import from.

For example, to use an icon from Material Design, your import would be: import { ICON_NAME } from 'react-icons/md';

If your project grows in size, this option is available. This method has the trade-off that it takes a long time to install the package.

yarn add @uswitch/spark-icons.all-files
# or
npm install @uswitch/spark-icons.all-files --save

example usage

import { FaBeer } from "@uswitch/spark-icons.all-files/fa/FaBeer";
class Question extends React.Component {
  render() {
    return <h3> Lets go for a <FaBeer />? </h3>
  }
}

You can add more icons by submitting pull requests or creating issues.

You can configure react-icons props using React Context API.

Requires React 16.3 or higher.

import { IconContext } from "@uswitch/spark-icons";

<IconContext.Provider value={{ color: "blue", className: "global-class-name" }}>
  <div>
    <FaFolder />
  </div>
</IconContext.Provider>

Import path has changed. You need to rewrite from the old style.

// OLD IMPORT STYLE
import FaBeer from '@uswitch/spark-icons/lib/fa/beer';

class Question extends React.Component {
    render() {
        return <h3> Lets go for a <FaBeer />? </h3>
    }
}

// NEW IMPORT STYLE
import { FaBeer } from '@uswitch/spark-icons/fa';

class Question extends React.Component {
    render() {
        return <h3> Lets go for a <FaBeer />? </h3>
    }
}

From version 3, vertical-align: middle is not automatically given. Please use IconContext to specify className or specify an inline style.

<IconContext.Provider value={{ style: { verticalAlign: 'middle' } }}>

Component

<IconContext.Provider value={{ className: 'react-icons' }}>

CSS

.react-icons {
  vertical-align: middle;
}

Dependencies on @types/react-icons can be deleted.

yarn remove @types/react-icons

npm remove @types/react-icons

yarn
yarn submodule  # fetch icon sources
cd packages/react-icons
yarn build

The preview site is the react-icons website, built in NextJS.

cd packages/react-icons
yarn build

cd ../preview
yarn start

The demo is a Create React App boilerplate with react-icons added as a dependency for easy testing.

cd packages/react-icons
yarn build

cd ../demo
yarn start

SVG is supported by all major browsers. With react-icons, you can serve only the needed icons instead of one big font file to the users, helping you to recognize which icons are used in your project.

• react-svg-morph

MIT

• Icons are taken from the other projects so please check each project licences accordingly.