https://github.com/shiftgeist/feather-helper

Universal helper for feather-icons
https://github.com/shiftgeist/feather-helper

Last synced: 4 months ago
JSON representation

Universal helper for feather-icons

• Host: GitHub
• URL: https://github.com/shiftgeist/feather-helper
• Owner: shiftgeist
• License: apache-2.0
• Created: 2020-08-14T12:48:34.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-03-18T16:51:51.000Z (over 4 years ago)
• Last Synced: 2025-03-07T00:55:41.604Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 323 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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

  import Feather from "feather-helper";

  const githubIcon = Feather("github", {

    class: "flex",

    color: "#F09383",

    "stroke-width": 3,

  });

{@html githubIcon}

```

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