mirror of
https://github.com/lucide-icons/lucide.git
synced 2026-11-14 13:58:21 +00:00
92 lines
2.1 KiB
Markdown
92 lines
2.1 KiB
Markdown
# Featherity
|
||
|
||
[](https://discord.gg/EH6nSts)
|
||
|
||
## What is Featherity?
|
||
|
||
Featherity is a fork of [Feather Icons](https://github.com/feathericons/feather), with icons sourced by the community.
|
||
|
||
## Table of Contents
|
||
|
||
* [Usage](#usage)
|
||
* [Figma](#figma)
|
||
* [Contributing](#contributing)
|
||
* [License](#license)
|
||
|
||
## Installation
|
||
``` bash
|
||
npm install featherity
|
||
#or
|
||
yarn add featherity
|
||
```
|
||
|
||
## Usage
|
||
|
||
At its core, Featherity is a collection of [SVG](https://svgontheweb.com/#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](https://svgontheweb.com/#implementation)
|
||
|
||
The following are additional ways you can use Featherity.
|
||
|
||
### ESModule
|
||
|
||
``` js
|
||
import { Camera } from 'featherity';
|
||
// Returns HTMLElement
|
||
|
||
// Usage
|
||
document.appendChild(Camera);
|
||
```
|
||
|
||
### React
|
||
|
||
``` js
|
||
import { Camera } from 'featherity/react';
|
||
// Returns ReactComponent
|
||
|
||
// Usage
|
||
const App = () => {
|
||
return <Camera color="red" size={48}/>
|
||
};
|
||
|
||
export default App;
|
||
```
|
||
|
||
### Vue
|
||
|
||
``` 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](https://www.figma.com/file/g0UipfQlRfGrntKPxZknM7/Featherity).
|
||
|
||
## Contributing
|
||
|
||
For more info on how to contribute please see the [contribution guidelines](https://github.com/featherity/featherity/blob/master/CONTRIBUTING.md).
|
||
|
||
Caught a mistake or want to contribute to the documentation? [Edit this page on Github](https://github.com/featherity/featherity/blob/master/README.md)
|
||
|
||
## Community
|
||
|
||
Do you want to join our community?
|
||
Join us in [discord](https://discord.gg/EH6nSts)!
|
||
|
||
## License
|
||
|
||
Feather is licensed under the [ISC License](https://github.com/featherity/featherity/blob/master/LICENSE).
|