# fontawesome-icon

> Web component for displaying FontAwesome icons.

Latest version **1.0.4** (published 2018-06-27) · MIT license · 0 weekly downloads

## Install

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

## 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 | 1.0.4 |
| Published | 2018-06-27 |
| First published | 2018-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | soldag |

## Links

- npm: https://www.npmjs.com/package/fontawesome-icon
- Homepage: https://github.com/soldag/fontawesome-icon#readme
- npm.io page: https://npm.io/package/fontawesome-icon

## Dependencies (5)

- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0
- [@fortawesome/fontawesome-svg-core](https://npm.io/package/@fortawesome/fontawesome-svg-core.md) ^1.2.0
- [@fortawesome/free-solid-svg-icons](https://npm.io/package/@fortawesome/free-solid-svg-icons.md) ^5.1.0
- [@fortawesome/free-brands-svg-icons](https://npm.io/package/@fortawesome/free-brands-svg-icons.md) ^5.1.0
- [@fortawesome/free-regular-svg-icons](https://npm.io/package/@fortawesome/free-regular-svg-icons.md) ^5.1.0

## Recent versions

- 1.0.4 (latest) — 2018-06-27
- 1.0.3 — 2018-06-19
- 1.0.2 — 2018-06-06
- 1.0.1 — 2018-05-30
- 1.0.0 — 2018-05-30

## README

# fontawesome-icon

Polymer 3 component for displaying FontAwesome 5 icons.  

## Installation
The component is available on npm:
```
npm install fontawesome-icon
```

## Usage
The component's ES6 module needs to be imported first. The component can then be used in the template of the component.
```js
import 'fontawesome-icon';
import { PolymerElement, html } from '@polymer/polymer';

class TestComponent extends PolymerElement {
  static get template() {
    return html`
      <fontawesome-icon prefix="fas" name="user" fixed-width></fontawesome-icon>
    `;
  }

  static get is() { return 'test-component'; }
}

window.customElements.define(TestComponent.is, TestComponent);
```

The `fontawesome-icon` component has the following attributes:

| Attribute   | Description                                                                                                                                                                                |
|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| prefix      | The icon's prefix. Can be `fas`,`far`, or `fab`.                                                                                                                                           |
| name        | The icon's name (without `fa-` prefix).                                                                                                                                                    |
| fixed-width | If this boolean attribute is specified, the icon is set to the same fixed width independent of the actual icon (see [FontAwesome docs](https://fontawesome.com/how-to-use/svg-with-js)).   |

## Limitations
The component can only be used by other Polymer 3 components and can only display FontAwesome 5 free icons.

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