# fontawesome

> Get the Font Awesome unicode character by the icon name.

Latest version **5.6.3** (published 2018-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install fontawesome
pnpm add fontawesome
yarn add fontawesome
bun add fontawesome
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.6.3 |
| Published | 2018-12-28 |
| First published | 2016-03-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 45.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Moritz Marquardt |
| Maintainers | momar |
| Keywords | fontawesome, unicode, icons, icon, utf, character, font, awesome |

## Links

- npm: https://www.npmjs.com/package/fontawesome
- Repository: https://github.com/moqmar/node-fontawesome
- Homepage: https://github.com/moqmar/node-fontawesome#readme
- Issues: https://github.com/moqmar/node-fontawesome/issues
- npm.io page: https://npm.io/package/fontawesome

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 5.6.3 (latest) — 2018-12-28
- 4.7.2 — 2017-02-22
- 4.7.1 — 2017-02-22
- 4.7.0 — 2016-11-27
- 4.5.0 — 2016-03-03

## README

# Font Awesome unicode bindings
Get a [Font Awesome](http://fontawesome.io/) unicode character by the icon name.  
Especially useful for outputting to e.g. terminals with a [Font Awesome patched font](https://github.com/gabrielelana/awesome-terminal-fonts) or for [Lemonbar](https://www.npmjs.com/package/lemonbar), but I'm sure you'll think of even better use cases.

## Usage:
```javascript
var fa = require("fontawesome");
console.log(fa("fort-awesome") + " Hello World!"); // Hello World!
console.log(fa.fortAwesome + " Hello World!"); // Hello World!
```

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