# ngx-font-awesome

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

Latest version **1.0.0** (published 2019-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngx-font-awesome
pnpm add ngx-font-awesome
yarn add ngx-font-awesome
bun add ngx-font-awesome
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-08-28 |
| First published | 2019-08-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 49.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Mohammad Javed |
| Maintainers | immohammadjaved |
| Keywords | ngx-font-awesome, ng4-font-awesome, ng5-font-awesome, ng6-font-awesome, ng7-font-awesome, ng8-font-awesome, ng2-fontawesome, ng2-fontawesome, ng2-font-awesome, ng-font-awesome, ng-fontawesome, font-awesome, fontawesome, font awesome, angular, angular2, ng, ng2, angular2-font-awesome, angular-font-awesome, angular4-font-awesome, angular4 font awesome, angular font awesome |

## Links

- npm: https://www.npmjs.com/package/ngx-font-awesome
- Repository: https://github.com/immohammadjaved/ngx-font-awesome
- Homepage: https://github.com/immohammadjaved/ngx-font-awesome#readme
- Issues: https://github.com/immohammadjaved/ngx-font-awesome/issues
- npm.io page: https://npm.io/package/ngx-font-awesome

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^1.9.0

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2019-08-28
- 0.0.2 — 2019-08-27
- 0.0.1 — 2019-08-27

## README

# Ngx Font Awesome
Simple, easy to use [Angular](https://angular.io) component to manage Font Awesome icons.

# How to install

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

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

**If you're using [Angular CLI](https://github.com/angular/angular-cli) 6.0.0, add the font-awesome CSS to `styles` inside the `angular.json`**
```json
"styles": [
    "styles.css",
    "./node_modules/font-awesome/css/font-awesome.css"
],
```


**If you're using [Angular CLI](https://github.com/angular/angular-cli), add the font-awesome CSS to `styles` inside the `angular-cli.json`**
```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**
```html
<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 `[]`

Name           | Type               | Options                                   | Optional
---            | ---                | ---                                       | ---
name           | `String`           | [F-A Icons](http://fontawesome.io/icons/) | No
size           | `String`           | `lg, 2x, 3x, 4x, 5x`                      | Yes
animation      | `Boolean`          | `true, false`                             | Yes
rotate         | `Number`           | `90, 180, 270`                            | Yes
flip           | `String`           | `vertical, horizontal`                    | Yes
fixed          | `Boolean`          | `true, false`                             | Yes
border         | `Boolean`          | `true, false`                             | Yes
customClass    | `String`           | `eg: custom`                              | Yes

*Example Use*
```html
<ngx-fa name="cog" [animation]="true" size="lg"></ngx-fa>
```

---
_Source: https://npm.io/package/ngx-font-awesome · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._