Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 1.62 KB

README.md

File metadata and controls

43 lines (33 loc) · 1.62 KB
Raw

NativeScript Vector Icons

       

Prerequisites / Requirements

You will have to manually install the fonts you want to use.

Installation

From the command prompt go to your app's root folder and execute:

tns plugin add nativescript-vector-icons

Demo app

If you want a quickstart, clone the repo, cd src, and npm run demo.ios or npm run demo.android.

API

getImage

Returns the image url based on the given parameters.

Parameters Type Description
font Font Instance of Font you want to use, created with font family name and size.
glyph String A string that represents an icon.
color Color Instance of Color you want to use, created with known color names / hex code / raba values. 
var Color = require('color').Color;
var Font = require('ui/styling/font').Font;
var vectorIcons = require('nativescript-vector-icons');
vectorIcons.getImage(
    Font.default.withFontFamily('Material Design Icons, MaterialDesignIcons').withFontSize(48), 
    String.fromCharCode(63615), 
    new Color('blue')
);

Known issues on Android

Icon resolution is too low in ActionBar / TabView

#5887 - Android uses deprecated method to create Drawable from Bitmap