react-native-vector-icons/README.md

Vector Icons for React Native

Choose from 2800 icons or use your own.

Perfect for buttons, logos and nav/tab bars. Easy to extend, style and integrate into your project.

Installation

$ npm install react-native-vector-icons --save

If you want to use any of the bundled icons, you need to add the icon fonts to your XCode project. Just follow these steps:

• Right click on you project in XCode and select Add files to xxx.
• Browse to node_modules/react-native-vector-icons and select the folder Fonts (or just the ones you want).
• Edit Info.plist and add a property called Fonts provided by application (if you haven't added one already) and type in the files you just added. It will look something like this:

Note: you need to recompile your project after adding new fonts.

If you want to use the TabBar integration, then you need to add RNVectorIcons.xcodeproj to Libraries and add libRNVectorIcons.a to Link Binary With Libraries under Build Phases. More info and screenshots about how to do this is available in the React Native documentation.

Usage

You can either use one of the bundled icons or roll your own custom font. Currently available options for bundled icon sets are:

• Entypo by Daniel Bruce (411 icons)
• EvilIcons by Alexander Madyankin & Roman Shamin (v1.7.6, 68 icons)
• FontAwesome by Dave Gandy (v4.3, 519 icons)
• Foundation by ZURB, Inc. (v3.0, 283 icons)
• Ionicons by Ben Sperry (v2.0.1, 733 icons)
• MaterialIcons by Google, Inc. (v2.0, 796 icons)
• Zocial by Sam Collins (v1.0, 100 icons)

var Icon = require('FontAwesome');
var myIcon = (<Icon name="rocket" size={30} color="#900" style={styles.icon} />)

Sizing

Either use the size attribute or a style with fontSize, defaults to 12. Sets the height of the icon, width depends on the icon aspect ratio, but will most likely be the same.

Color

Either use the color attribute or a style with color, defaults to black.

Style

Most style properties will work as expected, you might find it useful to play around with these:

• backgroundColor
• borderWidth
• borderColor
• borderRadius
• padding
• margin
• color
• fontSize
• flexDirection
• justifyContent
• alignItems

By combining some of these you can create for example:

Nesting

It's possible to nest the icons, any child content will appear after the icon, see the button example below.

Usage as PNG image/source object

Convenient way to plug this in into other components that rely on bitmap images rather than scalable vector icons. Takes the arguments name, size and color as described above.

Icon.getImageSource('user', 20, 'red').then((source) => this.setState({ userIcon: source }));

For a complete example check out the TabBarExample project.

Usage with TabBarIOS

Simply use Icon.TabBarItem instead of TabBarIOS.Item. This is an extended component that works exactly the same but with three additional properties:

• iconName name of the default icon (similar to TabBarIOS.Item icon).
• selectedIconName name of the default icon (similar to TabBarIOS.Item selectedIcon). Optional.
• iconSize size of the icon, defaults to 30. Optional.

For example usage see Examples/TabBarExample or the examples section below. Don't forget to import and link to this project as described above if you are going to use the TabBar integration.

Usage with NavBarIOS

Use Icon.getImageSource to get an image source object and pass it as you would with backButtonIcon, leftButtonIcon or rightButtonIcon.

Note: Since NavBarIOS doesn't rerender with new state and the async nature of getImageSource it's not possible to use it in initialRoute, but any view added by push should be fine.

Custom Fonts

createIconSet(glyphMap, fontFamily)

Returns your own custom font based on the glyphMap where the key is the icon name and the value is either a UTF-8 character or it's character code. fontFamily is the name of the font NOT the filename. Open the font in Font Book.app or similar to learn the name.

var createIconSet = require('createIconSet');
var glyphMap = { 'icon-name': 1234, test: '∆' };
var Icon = createIconSet(glyphMap, 'FontName');

createIconSetFromFontello(config[, fontFamily])

Convenience method to create a custom font based on a fontello config file. Don't forget to import the font as described above and drop the config.json somewhere convenient in your project.

var require('createIconSetFromFontello');
var fontelloConfig = require('./config.json');
var Icon = createIconSetFromFontello(fontelloConfig);

Examples

IconExplorer

Try the IconExplorer project in Examples/IconExplorer folder, there you can also search for any icon.

Basic Example

var React = require('react-native');
var Icon = require('Ionicons');

var ExampleView = React.createClass({
  render: function() {
    return <Icon name="person" size={30} color="#4F8EF7" />;
  }
};

TabBar

Full example in TabBarExample project in Examples/TabBarExample folder.

var React = require('react-native');
var {
  View, 
  Text, 
  TabBarIOS,
} = React;
var Icon = require('Ionicons');

var TabBarView = React.createClass({
  render: function() {
    return (
      <TabBarIOS>
        <Icon.TabBarItem
          title="Home"
          iconName="ios-home-outline"
          selectedIconName="ios-home"
          }}>
          <View style={styles.tabContent}><Text>Home Tab</Text></View>
        </Icon.TabBarItem>
      </TabBarIOS>
    );
  }
};

Button

By nesting a <Text> element and assigning padding and background color you can achieve a button like appearance. To register taps, just wrap it with a Touchable* component.

var Icon = require('FontAwesome')

var styles = StyleSheet.create({
  icon: {
    fontSize: 20,
    color: 'white',
    paddingVertical: 5,
    paddingHorizontal: 8,
    borderRadius: 4,
    backgroundColor: '#3b5998',
  },
  text: {
    marginLeft: 10,
    color: 'white',
    fontWeight: '600',
  },
});
var button = (
  <Icon name="facebook" style={styles.icon}>
    <Text style={styles.text}>Login with Facebook</Text>
  </Icon>
);

Generating your own icon set from a CSS file

If you already have a icon font with associated CSS file then you can easily generate a icon set with the generate-icon script.

Example usage:

./node_modules/.bin/generate-icon path/to/styles.css --componentName=MyIcon --fontFamily=myicon > Components/MyIcon.js

Options

Any flags not listed below, like --componentName and --fontFamily, will be passed on to the template.

-p, --prefix

CSS selector prefix [default: ".icon-"]

-t, --template

Template in lodash format [default: "./template/iconSet.tpl"]

For default template please provide --componentName and --fontFamily.

-o, --output

Save output to file, defaults to STDOUT

License

This project is licenced under the MIT License.

Any bundled fonts are copyright to their respective authors and mostly under MIT or SIL OFL.