# feather-helper

> Helper for feather-icons

Latest version **2.1.1** (published 2021-03-18) ·  Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install feather-helper
pnpm add feather-helper
yarn add feather-helper
bun add feather-helper
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2021-03-18 |
| First published | 2020-08-14 |
| Weekly downloads | 0 |
| License |  Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 38.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Felix Hungenberg |
| Maintainers | shiftgeist |
| Keywords | feather-helper, feather-icons, helper, svg, design, svelte, vue, react |

## Links

- npm: https://www.npmjs.com/package/feather-helper
- Repository: https://github.com/shiftgeist/feather-helper
- Homepage: https://github.com/shiftgeist/feather-helper#readme
- Issues: https://github.com/shiftgeist/feather-helper/issues
- npm.io page: https://npm.io/package/feather-helper

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

- 2.1.1 (latest) — 2021-03-18
- 2.0.2 — 2021-03-15
- 2.0.1 — 2021-03-15
- 2.0.0 — 2021-03-15
- 1.0.2 — 2020-08-14
- 1.0.1 — 2020-08-14
- 1.0.0 — 2020-08-14

## README

# feather-helper

> Helper for [`feather-icons`](https://github.com/feathericons/feather) to simplify the use.

![npm](https://img.shields.io/npm/v/feather-helper) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/feather-helper) [![Maintainability](https://api.codeclimate.com/v1/badges/44399aa35283c6f73e22/maintainability)](https://codeclimate.com/github/shiftgeist/feather-helper/maintainability) [![Release](https://github.com/shiftgeist/feather-helper/actions/workflows/release.yml/badge.svg)](https://github.com/shiftgeist/feather-helper/actions/workflows/release.yml)

## Highlights

- lightweight
- adds types for autocompletion
- simplifies usage

## Install

```bash
npm install feather-icons
npm install feather-helper
```

Note: `feather-icons` module is required.

## Usage

Example usage in [Svelte](https://github.com/sveltejs/svelte):

```html
<script>
  import Feather from "feather-helper";

  const githubIcon = Feather("github", {
    class: "flex",
    color: "#F09383",
    "stroke-width": 3,
  });
</script>

{@html githubIcon}
```

Check out a simple example in the [example](./example) folder.

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