Skip to content

🌳 Icon component for React Native & Expo with better font family management

License

Notifications You must be signed in to change notification settings

native-ly/native-icons

Repository files navigation

NPM version NPM downloads NPM license run in expo snack Codecov Travis Bundle size

About

Icon component for React Native & Expo with better font family management

Similar Projects

A similar solution is also available in React Native Elements

How to Install

First, install the library in your project by npm:

$ npm install native-icons

Or Yarn:

$ yarn add native-icons

Bare React Native Project

Getting Started

Connect the library with the project using ES6 import:

import Icon from 'native-icons'

Options

IconsProvider

IconsProvider allows you to set a global icon type for all icons. You don't need to use it. You can pass the type directly to the Icon component. After setting the provider and passing the type to Icon component, the type from context will be overwritten.

Name Type Default Description Available options
type string Icons font type Icon Types

Icon

The component extends react-native-vector-icons props and implements IconsProvider props

Available Icon Types

  • ant-design
  • entypo
  • evil-icons
  • feather
  • font-awesome
  • font-awesome-5
  • fontisto
  • foundation
  • ionicons
  • material-icons
  • material-community-icons
  • octicons
  • zocial
  • simple-line-icons

License

This project is licensed under the MIT License © 2020-present Jakub Biesiada