Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scottbedard/vue-lucide
Tree shakeable lucide icon components
https://github.com/scottbedard/vue-lucide
Last synced: 17 days ago
JSON representation
Tree shakeable lucide icon components
- Host: GitHub
- URL: https://github.com/scottbedard/vue-lucide
- Owner: scottbedard
- License: mit
- Created: 2023-01-17T03:10:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-24T08:31:40.000Z (almost 2 years ago)
- Last Synced: 2024-12-08T18:49:47.979Z (25 days ago)
- Language: Vue
- Size: 533 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `@bedard/vue-lucide`
[![Build status](https://img.shields.io/github/actions/workflow/status/scottbedard/vue-lucide/build.yml?branch=main)](https://github.com/scottbedard/vue-lucide/actions)
[![NPM](https://img.shields.io/npm/v/@bedard/vue-lucide)](https://www.npmjs.com/package/@bedard/vue-lucide)
[![License](https://img.shields.io/github/license/scottbedard/vue-sortablejs?color=blue)](https://github.com/scottbedard/vue-lucide/blob/main/LICENSE)Tree-shakeable Vue components for [Lucide icons](https://lucide.dev/)
[View live sandbox →](https://vue-lucide.scottbedard.net)
## Installation
Install via NPM
```
npm install @bedard/vue-lucide
```Install via cdn
```html
```
The cdn bundle is very big, do not use it for anything serious.
## Basic use
All components are suffixed with `Icon`. For cdn use, access icons via `window.VueLucide`.
```vue
import { ShareIcon } from '@bedard/lucide-vue'
```
Use `size` to set the height and width together. If no `stroke` is defined, icons will use the current text color.
## Updating
When this library falls out of sync with Lucide, run the following commands.
```
npm installnpm run build
```## License
[MIT](https://github.com/scottbedard/vue-lucide/blob/master/LICENSE)
Copyright (c) 2023-present, Scott Bedard