1.0.0 • Published 5 years ago

ngx-font-awesome v1.0.0

Weekly downloads
96
License
MIT
Repository
github
Last release
5 years ago

Ngx Font Awesome

Simple, easy to use Angular component to manage Font Awesome icons.

How to install

Install Packages npm install ngx-font-awesome font-awesome --save

Import the module:

//...
import { NgxFontAwesomeModule } from 'ngx-font-awesome';
@NgModule({
  //...
  imports: [
    //...
    NgxFontAwesomeModule
  ],
  //...
})
export class AppModule { }

If you're using Angular CLI 6.0.0, add the font-awesome CSS to styles inside the angular.json

"styles": [
    "styles.css",
    "./node_modules/font-awesome/css/font-awesome.css"
],

If you're using Angular CLI, add the font-awesome CSS to styles inside the angular-cli.json

"styles": [
    "styles.css",
    "../node_modules/font-awesome/css/font-awesome.css"
],

NOTE: If using SCSS preprocessor just change the css for scss

If you're not using the CLI, import the stylesheet to your index.html file

<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" />

Usage and options

*NOTE: Pass boolean values with square brackets []

NameTypeOptionsOptional
nameStringF-A IconsNo
sizeStringlg, 2x, 3x, 4x, 5xYes
animationBooleantrue, falseYes
rotateNumber90, 180, 270Yes
flipStringvertical, horizontalYes
fixedBooleantrue, falseYes
borderBooleantrue, falseYes
customClassStringeg: customYes

Example Use

<ngx-fa name="cog" [animation]="true" size="lg"></ngx-fa>