# faicon

> Font awesome react component

Latest version **1.1.0** (published 2018-08-30) · Apache-2.0 license · 0 weekly downloads

## Install

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

## 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.1.0 |
| Published | 2018-08-30 |
| First published | 2017-04-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | ZhukMax |
| Maintainers | zhukmax |

## Links

- npm: https://www.npmjs.com/package/faicon
- Repository: https://github.com/ZhukMax/faicon
- Homepage: https://github.com/ZhukMax/faicon#readme
- Issues: https://github.com/ZhukMax/faicon/issues
- npm.io page: https://npm.io/package/faicon

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^16.4.1
- [webpack](https://npm.io/package/webpack.md) ^4.17.1

## Recent versions

- 1.1.0 (latest) — 2018-08-30
- 1.0.1 — 2017-05-05
- 1.0.0 — 2017-04-29

## README

# Faicon
[![Software License][ico-license]](license.md)

Font awesome icon is react component.

## Install

#### With Yarn
```console
yarn add faicon font-awesome
```

#### With npm
```console
npm i --save faicon font-awesome
```

## Use


After installing faicon, react, and webpack (or gulp):
```javascript
import React from 'react';
import { Faicon } from 'faicon';
import 'font-awesome/css/font-awesome.css';

class App extends React.Component {
  render() {
    return (
      <Faicon name="user"/>
    );
  };
}
```
#### Attributes
* `name="user"` - name of icon without "fa-" (*required*)
* `size="2"` - size of icon without "fa-" & "x", default "lg"
* `spin` or `pulse` - Set animate for icon
* `border`
* `fixed` - Set fixed size for icon
* `fh` or `fv` - Set flip for icon
* `rotate="90"`
* `inverse`
* `addClass="my-cool-class"`

#### Stack
Inversing user in square:
```javascript
import React from 'react';
import { Stack } from 'faicon';
import 'font-awesome/css/font-awesome.css';

class App extends React.Component {
  render() {
    return (
      <Stack name1="user" name2="square-o" inverse1/>
    );
  };
}
```

## Change log

Please see [CHANGELOG](changelog.md) for more information what has changed recently.

## License

The Apache License Version 2.0. Please see [License File](license.md) for more information.

[ico-license]: https://img.shields.io/badge/license-Apache%202-brightgreen.svg?style=flat-square

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