# @buffetjs/icons

> Icons kit

Latest version **3.3.8** (published 2021-07-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @buffetjs/icons
pnpm add @buffetjs/icons
yarn add @buffetjs/icons
bun add @buffetjs/icons
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.3.8 |
| Published | 2021-07-19 |
| First published | 2019-10-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 418.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 538 |
| Author | strapi Team |
| Maintainers | lauriejim, soupette, alexandrebodin, hichamelbsi |
| Keywords | Buffet.js, icons |

## Links

- npm: https://www.npmjs.com/package/@buffetjs/icons
- Repository: https://github.com/strapi/buffet
- Homepage: https://github.com/strapi/buffet#readme
- Issues: https://github.com/strapi/buffet/issues
- npm.io page: https://npm.io/package/@buffetjs/icons

## Dependencies (1)

- [prop-types](https://npm.io/package/prop-types.md) ^15.5.10

## 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

- 3.3.8 (latest) — 2021-07-19
- 3.3.7-next.1 (next) — 2021-07-19
- 3.3.2-rc.0 (rc) — 2020-12-11
- 3.3.7 — 2021-07-19
- 3.3.6 — 2021-05-10
- 3.3.5 — 2021-04-16
- 3.3.5-next.3 — 2021-03-31
- 3.3.5-next.2 — 2021-03-30
- 3.3.5-next.1 — 2021-03-04
- 3.3.5-next.0 — 2021-03-04
- 3.3.4 — 2021-02-01
- 3.3.4-next.0 — 2021-02-01
- 3.3.3-next.3 — 2021-01-07
- 3.3.3-next.2 — 2021-01-04
- 3.3.3-next.1 — 2020-12-24
- … 56 more at https://npm.io/package/@buffetjs/icons/versions

## README

# Buffet.js Icons

## Getting Started

### Installation

Using yarn

```bash
yarn add @buffetjs/icons
# Install the required dependencies
yarn add prop-types react styled-components
```

or npm

```bash
npm install @buffetjs/icons --save
# Install the required dependencies
npm install prop-types react styled-components --save
```

### Contributing

In order to add a new icon, you can design your svg using Sketch or another design toolkit.

Then you need to clean your svg:

```
npm install -g svgo

svgo my-svg.svg
```

Finally transform the cleaned svg to a React Component.

### Available commands

- **build**<br/>
  Builds the library for production
- **build:analyze**<br/>
  Analyse the generated build
- **build:watch**<br/>
  Whatch the files with webpack
- **build:watch:esm**<br/>
  Whatch the files with babel
- **create:index**<br/>
  Create the `build/index.js` file
- **test**<br/>
  Runs the entire set of test: lint, style and jest
- **test:jest**<br/>
  Runs the unit tests
- **test:jest:watch**<br/>
  Runs the unit tests in watch mode
- **test:lint**<br/>
  Runs the lint tests
- **test:lint:quiet**<br/>
  Runs the lint tests without displaying the warnings
- **test:style**<br/>
  Runs the stylelint tests
- **test:style:quiet**<br/>
  Runs the stylelint tests without displaying the warnings
- **lint:fix**<br/>
  Fixes the lint

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