Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.3 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.3 KB
Raw

React Native Vector Icons - Fontello

React Native Vector Icons font package to support using custom fonts created with Fontello

See the React Native Vector Icons README for more details.

Installation

npm install @react-native-vector-icons/fontello

Usage

  1. Add the config.json somewhere in your project to be imported
  2. Add the ttf file into rnvi-fonts. You can customise this location as described in react-native-vector-icons
  3. Add this package to your project
yarn instal @react-native-vector-icons/fontello
  1. Create the component in your project and use it
import createIconSet from '@react-native-vector-icons/fontello';
import fontelloConfig from './config.json';
const Icon = createIconSet(fontelloConfig);

cont icon = <Icon name="comments" />;

If you want to customise the font postscript name and filename you can pass extra arguments.

import createIconSet from '@react-native-vector-icons/fontello';
import fontelloConfig from './config.json';
const Icon = createIconSet(fontelloConfig, 'Font Family', 'FontFamily.ttf');

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT