Lucide

Lucide Vue Next

Implementation of the lucide icon library for Vue 3 applications.

⚠️ This version of lucide is for Vue 3, For Vue 2 got to lucide-vue

Installation

With yarn

yarn add lucide-vue-next

With npm

npm install lucide-vue-next

How to use

It's build with ESmodules so it's completely threeshakable. Each icon can be imported as a vue component.

Example

You can pass additional props to adjust the icon.

<template>
<Camera
color="red"
:size="32"
/>
</template>
<script>
// Returns Vue component
import { Camera } from 'lucide-vue-next';
export default {
name: "My Component",
components: { Camera }
}
</script>

Props

nametypedefault
sizeNumber24
colorStringcurrentColor
strokeWidthNumber2
defaultClassStringlucide-icon

Custom props

You can also pass custom props that will be added in the svg as attributes.

<template>
<Camera fill="red" />
</template>

One generic icon component

It is possible to create one generic icon component to load icons.

⚠️ Example below importing all EsModules, caution using this example, not recommended when you using bundlers, your application build size will grow strongly.

Icon Component Example

<template>
<component :is="icon" />
</template>
<script>
import * as icons from "lucide-vue-next";
export default {
props: {
name: {
type: String,
required: true,
},
},
setup(props) {
const icon = computed(() => icons[props.name])
return { icon }
}
};
</script>
Then you can use it like this
<template>
<div id="app">
<Icon name="Airplay" />
</div>
</template>

Powered by Vercel