https://github.com/arisris/famicon
Fontawesome icon component for mithril
https://github.com/arisris/famicon
Last synced: 3 months ago
JSON representation
Fontawesome icon component for mithril
- Host: GitHub
- URL: https://github.com/arisris/famicon
- Owner: arisris
- Created: 2020-01-21T04:45:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T18:20:14.000Z (almost 4 years ago)
- Last Synced: 2025-02-19T01:01:49.367Z (5 months ago)
- Language: JavaScript
- Homepage: https://kliksob.github.io/famicon/
- Size: 1.17 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mithril - famicon - Fontawesome svg icons component for mithril (Uncategorized / Uncategorized)
README
## Famicon
Fontawesome svg icon component for mithril
https://kliksob.github.io/famicon/
## How to use
```bash
npm install famicon
```
```js
const m = require("mithril");
const faIconName = require("famicon/dist/solid/faIconName");
m(faIconName, {
svgAttrs: {}, // svg attributes eg. style
pathAttrs: {} // path attributes
});
```
### all icon
```js
const { solid } = require("famicon");
const { faIconName } = solid;
```
### all icon type
```js
const { faIconName } = require("famicon/dist/solid");
```
### individual icon [recomended]
```js
const faIconName = require("famicon/dist/solid/faIconName");
```
### Build example docs
```sh
npm install -g parcel-bundler
npm run watch-docs
npm run build-docs
```
### Development
Make sure your os is linux. because we use shelljs
```sh
git clone https://github.com/kliksob/famicon.git
cd famicon
npm install
node build.js
```