# font-awesome-icon-chars

> The list of Font Awesome icon unicode characters in several file format

Latest version **2.6.0** (published 2020-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install font-awesome-icon-chars
pnpm add font-awesome-icon-chars
yarn add font-awesome-icon-chars
bun add font-awesome-icon-chars
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.6.0 |
| Published | 2020-07-17 |
| First published | 2016-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 535.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Saran Tanpituckpong |
| Maintainers | illuminator |
| Keywords | font-awesome, font awesome |

## Links

- npm: https://www.npmjs.com/package/font-awesome-icon-chars
- Repository: https://github.com/gluons/Font-Awesome-Icon-Chars
- Issues: https://github.com/gluons/Font-Awesome-Icon-Chars/issues
- npm.io page: https://npm.io/package/font-awesome-icon-chars

## Recent versions

- 2.6.0 (latest) — 2020-07-17
- 2.5.0 — 2019-07-26
- 2.4.0 — 2018-11-10
- 2.3.0 — 2018-11-04
- 2.2.0 — 2018-10-28
- 2.1.0 — 2018-09-11
- 2.0.0 — 2018-03-01
- 1.3.0 — 2017-11-05
- 1.2.5 — 2017-05-12
- 1.2.4 — 2017-05-07
- 1.2.3 — 2017-04-28
- 1.2.2 — 2017-01-14
- 1.2.1 — 2017-01-09
- 1.2.0 — 2017-01-08
- 1.1.2 — 2016-10-25
- … 7 more at https://npm.io/package/font-awesome-icon-chars/versions

## README

# Font Awesome Icon Character List
[![license](https://img.shields.io/github/license/gluons/Font-Awesome-Icon-Chars.svg?style=flat-square)](./LICENSE)
[![npm](https://img.shields.io/npm/v/font-awesome-icon-chars.svg?style=flat-square)](https://www.npmjs.com/package/font-awesome-icon-chars)
[![npm](https://img.shields.io/npm/dt/font-awesome-icon-chars.svg?style=flat-square)](https://www.npmjs.com/package/font-awesome-icon-chars)
[![Known Vulnerabilities](https://snyk.io/test/github/gluons/font-awesome-icon-chars/badge.svg?style=flat-square)](https://snyk.io/test/github/gluons/font-awesome-icon-chars)
[![Travis](https://img.shields.io/travis/gluons/Font-Awesome-Icon-Chars.svg?style=flat-square)](https://travis-ci.org/gluons/Font-Awesome-Icon-Chars)
[![TSLint](https://img.shields.io/badge/TSLint-gluons-15757B.svg?style=flat-square)](https://github.com/gluons/tslint-config-gluons)
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg?style=flat-square)](https://renovateapp.com/)

The list of [Font Awesome](https://fontawesome.com/) icon **unicode characters** in several file format.

> This list contains only [**free**](https://fontawesome.com/icons?d=gallery&m=free) icons.

## Installation

**Via [NPM](https://www.npmjs.com/):**

[![NPM](https://nodei.co/npm/font-awesome-icon-chars.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/font-awesome-icon-chars)

```
npm install font-awesome-icon-chars
```

**Via [Yarn](https://yarnpkg.com/):**

```
yarn add font-awesome-icon-chars
```

## Usage

### Assets

You can use characters list file in [character-list](./character-list) directory.  
All characters list files will be placed in this directory.

### Node.js

You can also get list of icon from this module.

```javascript
const faIconChars = require('font-awesome-icon-chars');
const { solid, regular, brands } = faIconChars;

// Solid icons
for (let icon of solid) {
	console.log(`Icon ID: ${icon.name}, Icon Unicode: ${icon.unicode}`);
}
// Regular icons
for (let icon of regular) {
	console.log(`Icon ID: ${icon.name}, Icon Unicode: ${icon.unicode}`);
}
// Brands icons
for (let icon of brands) {
	console.log(`Icon ID: ${icon.name}, Icon Unicode: ${icon.unicode}`);
}
```

## Schema

### 📜 [CSON](https://github.com/bevry/cson), [JSON](https://www.json.org/), [TOML](https://github.com/toml-lang/toml), [YAML](http://yaml.org/)

- `solid` (`Icon[]`) — Font Awesome [solid icons](https://fontawesome.com/icons?d=gallery&s=solid&m=free)
- `regular` (`Icon[]`) — Font Awesome [regular icons](https://fontawesome.com/icons?d=gallery&s=regular&m=free)
- `brands` (`Icons[]`) — Font Awesome [brands icons](https://fontawesome.com/icons?d=gallery&s=brands&m=free)

#### Icon

- `name` (`string`) — Font Awesome icon name.
- `unicode` (`string`) — An unicode of Font Awesome icon.

### 📜 [XML](https://www.w3.org/XML/)

- `<style>`
  - `<solid>` — Font Awesome [solid icons](https://fontawesome.com/icons?d=gallery&s=solid&m=free)
    - `<icon id="...icon name...">`
      - `id` (attribute) — Font Awesome icon name  
      - `<unicode>` — Contain an unicode of Font Awesome icon.
  - `<regular>` — Font Awesome [regular icons](https://fontawesome.com/icons?d=gallery&s=regular&m=free)
    - `<icon id="...icon name...">`
      - `id` (attribute) — Font Awesome icon name  
      - `<unicode>` — Contain an unicode of Font Awesome icon.
  - `<brands>` — Font Awesome [brands icons](https://fontawesome.com/icons?d=gallery&s=brands&m=free)
    - `<icon id="...icon name...">`
      - `id` (attribute) — Font Awesome icon name  
      - `<unicode>` — Contain an unicode of Font Awesome icon.

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