Logo for jsDocs.io

@types/react-native-vector-icons

  • Version 6.4.18
  • Published
  • 12.3 kB
  • 2 dependencies
  • MIT license

Install

npm i @types/react-native-vector-icons
yarn add @types/react-native-vector-icons
pnpm add @types/react-native-vector-icons

Overview

TypeScript definitions for react-native-vector-icons

Index

Functions

Functions

function createIconSet

createIconSet: (
    glyphMap: {},
    fontFamily: string,
    fontFile?: string
) => typeof Icon;

  • 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. Optionally pass the third fontFile argument for android support, it should be a path to the font file in you asset folder.

function createIconSetFromFontello

createIconSetFromFontello: (
    config: {},
    fontName?: string,
    fontFile?: string
) => typeof Icon;

  • 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.

    Example usage import { createIconSetFromFontello } from 'react-native-vector-icons'; import fontelloConfig from './config.json'; const Icon = createIconSetFromFontello(fontelloConfig);

    See Also

    • http://fontello.com

function createIconSetFromIcoMoon

createIconSetFromIcoMoon: (
    config: {},
    fontName?: string,
    fontFile?: string
) => typeof Icon;

  • Convenience method to create a custom font from IcoMoon Make sure you're using the Download option in IcoMoon, and use the .json file that's included in the .zip you've downloaded. You'll also need to import the .ttf font file into your project

    Example usage import { createIconSetFromIcoMoon } from 'react-native-vector-icons'; import icoMoonConfig from './config.json'; const Icon = createIconSetFromIcoMoon(icoMoonConfig);

    See Also

    • https://icomoon.io/app

Package Files (1)

Dependencies (2)

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/react-native-vector-icons.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/react-native-vector-icons)
  • HTML
    <a href="https://www.jsdocs.io/package/@types/react-native-vector-icons"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>