https://github.com/fengyuanchen/vue-feather

Feather component for Vue.js.
https://github.com/fengyuanchen/vue-feather

feather feather-icons icons vue vue-component vuejs

Last synced: about 6 hours ago
JSON representation

Feather component for Vue.js.

• Host: GitHub
• URL: https://github.com/fengyuanchen/vue-feather
• Owner: fengyuanchen
• License: mit
• Created: 2018-03-20T15:21:41.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2022-04-11T22:08:45.000Z (over 2 years ago)
• Last Synced: 2024-04-24T18:55:49.046Z (7 months ago)
• Topics: feather, feather-icons, icons, vue, vue-component, vuejs
• Language: TypeScript
• Homepage: https://fengyuanchen.github.io/vue-feather/
• Size: 1.58 MB
• Stars: 145
• Watchers: 5
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue-feather

[![Coverage Status](https://img.shields.io/codecov/c/github/fengyuanchen/vue-feather.svg)](https://codecov.io/gh/fengyuanchen/vue-feather) [![Downloads](https://img.shields.io/npm/dm/vue-feather.svg)](https://www.npmjs.com/package/vue-feather) [![Version](https://img.shields.io/npm/v/vue-feather.svg)](https://www.npmjs.com/package/vue-feather) [![Gzip Size](https://img.shields.io/bundlephobia/minzip/vue-feather.svg)](https://unpkg.com/vue-feather/dist/vue-feather.js)

> [Feather](https://feathericons.com/) icons component for Vue 3. For Vue 2, check out the [`v1`](https://github.com/fengyuanchen/vue-feather/tree/v1) branch.

- [Docs](src/README.md)

- [Demo](https://fengyuanchen.github.io/vue-feather)

## Main npm package files

```text

dist/

├── vue-feather.js         (UMD, default)

├── vue-feather.min.js     (UMD, compressed)

├── vue-feather.esm.js     (ECMAScript Module)

├── vue-feather.esm.min.js (ECMAScript Module, compressed)

└── vue-feather.d.ts       (TypeScript Declaration File)

```

## Getting started

### Installation

Using npm:

```shell

npm install vue@3 feather-icons@4 vue-feather@2

```

Using pnpm:

```shell

pnpm add vue@3 feather-icons@4 vue-feather@2

```

Using Yarn:

```shell

yarn add vue@3 feather-icons@4 vue-feather@2

```

Using CDN:

```html

```

### Usage

```js

import { createApp } from 'vue';

import VueFeather from 'vue-feather';

const app = createApp({});

app.component(VueFeather.name, VueFeather);

```

```html

```

## Browser support

Same as Vue 3.

## Versioning

Maintained under the [Semantic Versioning guidelines](https://semver.org/).

## License

[MIT](https://opensource.org/licenses/MIT) © [Chen Fengyuan](https://chenfengyuan.com/)