Featherity

What is Featherity?

Featherity is a fork of Feather Icons, with icons sourced by the community.

Table of Contents

• Usage
  • Figma
• Contributing
• License

Installation

npm install featherity
#or
yarn add featherity

Usage

At its core, Featherity is a collection of SVG files. This means that you can use Feather icons in all the same ways you can use SVGs (e.g. img, background-image, inline, object, embed, iframe). Here's a helpful article detailing the many ways SVGs can be used on the web: SVG on the Web – Implementation Options

The following are additional ways you can use Featherity.

ESModule

import { Camera } from 'featherity';
// Returns HTMLElement

// Usage
document.appendChild(Camera);

React

import { Camera } from 'featherity/react';
// Returns ReactComponent

// Usage
const App = () => {
  return <Camera color="red" size={48}/>
};

export default App;

Vue

<template>
  <div id="app">
    <Camera color="red" :size="48"/>
  </div>
</template>

<script>
import { Camera } from 'featherity/vue';

export default {
  name: "App",
  components: {
    Camera
  }
};
</script>

Figma

You can use the components from this Figma file.

Contributing

For more info on how to contribute please see the contribution guidelines.

Caught a mistake or want to contribute to the documentation? Edit this page on Github

Community

Do you want to join our community? Join us in discord!

License

Feather is licensed under the ISC License.