rn-icons
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

RN Icons

react-native version of react-icons

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

Installation

yarn add react-native-svg rn-icons
# or
npm install react-native-svg rn-icons --save
# or
pnpm install react-native-svg rn-icons

cd ios && pod install # for react-native-svg

example usage

import { FaBeer } from "rn-icons/fa";

function Question() {
  return (
    <Text>
      Lets go for a <FaBeer />?
    </Text>
  );
}

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

How to pick icons

Checkout this website: https://react-icons.github.io/react-icons/. you can view all icons.

and replace library name from react-icons to rn-icons will be ok.

Icons

Icon Library License Version Count
Circum Icons MPL-2.0 license 1.0.0 288
Font Awesome 5 CC BY 4.0 License 5.15.4-3-gafecf2a 1612
Font Awesome 6 CC BY 4.0 License 6.4.2 2025
Ionicons 4 MIT 4.6.3 696
Ionicons 5 MIT 5.5.4 1332
Material Design icons Apache License Version 2.0 4.0.0-90-g1ea21d5429 4341
Typicons CC BY-SA 3.0 2.1.2 336
Github Octicons icons MIT 18.3.0 264
Feather MIT 4.29.1 287
Lucide ISC v4.11.0-15-g7493227d 1215
Game Icons CC BY 3.0 12920d6565588f0512542a3cb0cdfd36a497f910 4040
Weather Icons SIL OFL 1.1 2.0.12 219
Devicons MIT 1.8.0 192
Ant Design Icons MIT 4.3.1 789
Bootstrap Icons MIT 1.11.1 2716
Remix Icon Apache License Version 2.0 3.5.0 2537
Flat Color Icons MIT 1.0.2 329
Grommet-Icons Apache License Version 2.0 4.11.0 635
Heroicons MIT 1.0.6 460
Heroicons 2 MIT 2.0.18 876
Simple Icons CC0 1.0 Universal 9.20.0 2753
Simple Line Icons MIT 2.5.5 189
IcoMoon Free CC BY 4.0 License d006795ede82361e1bac1ee76f215cf1dc51e4ca 491
BoxIcons CC BY 4.0 License 2.1.4 1634
css.gg MIT 2.1.1 704
VS Code Icons CC BY 4.0 0.0.35 439
Tabler Icons MIT 2.40.0 4836
Themify Icons MIT v0.1.2-2-g9600186 352
Radix Icons MIT @radix-ui/react-icons@1.3.0-1-g94b3fcf 318
Phosphor Icons MIT 2.0.2 7488
Icons8 Line Awesome MIT 1.3.1 1544

You can add more icons by submitting into react-icons with pull requests or creating issues. And this repo with be sync.

Configuration

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

Requires React 16.3 or higher.

import { IconContext } from "rn-icons";

<IconContext.Provider value={{ color: "blue" }}>
  <div>
    <FaFolder />
  </div>
</IconContext.Provider>;
Key Default Notes
color undefined (inherit)
style undefined Can overwrite size and color

Contributing

./build-script.sh will build the whole project. See also CI scripts for more information.

Development

pnpm install
cd packages/react-icons
pnpm fetch  # fetch icon sources
pnpm build

Add/Update icon set

Check react-icons

Preview

TODO

Why React SVG components instead of fonts?

In React native, use fonts is hard to maintain, and its must be touch native code which react native dont like. With rn-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.

Related Projects

Licence

MIT

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

Readme

Keywords

none

Package Sidebar

Install

npm i rn-icons

Weekly Downloads

547

Version

1.1.0

License

MIT

Unpacked Size

83.2 MB

Total Files

150

Last publish

Collaborators

  • moonrailgun