# angular-font-awesome

> Compact FontAwesome library ready to be used with Angular.

Latest version **3.1.2** (published 2018-01-10) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.2 |
| Published | 2018-01-10 |
| First published | 2017-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 6.9.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 70 |
| Author | Baruch Velez |
| Maintainers | baruchvlz |
| Keywords | ng4-font-awesome, ng4-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/angular-font-awesome
- Repository: https://github.com/baruchvlz/angular-font-awesome
- Homepage: https://github.com/baruchvlz/angular-font-awesome#readme
- Issues: https://github.com/baruchvlz/angular2-font-awesome/issues
- npm.io page: https://npm.io/package/angular-font-awesome

## 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

- 3.1.2 (latest) — 2018-01-10
- 3.1.2-test — 2018-01-10
- 3.1.1 — 2017-12-19
- 3.1.1-test — 2017-12-19
- 3.1.0 — 2017-12-19
- 3.0.4 — 2017-12-18
- 3.0.3 — 2017-11-12
- 3.0.2 — 2017-11-06
- 3.0.1 — 2017-11-05
- 3.0.0 — 2017-11-05
- 2.3.7 — 2017-10-15
- 2.3.6 — 2017-10-14
- 2.3.5 — 2017-10-12
- 2.3.4 — 2017-10-12
- 2.3.3 — 2017-10-12
- … 18 more at https://npm.io/package/angular-font-awesome/versions

## README

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

Built with [Angular QuickStart Lib](https://github.com/filipesilva/angular-quickstart-lib).

# How to install

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

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

**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

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

*Example Use*
```html
<fa name="cog" animation="spin"></fa>
```

# TODO
- Add [Stacked Icons](http://fontawesome.io/examples/#stacked) support
- Add [List Icons](http://fontawesome.io/examples/#list) support
- Tests
- Demo page

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