Lucide

Appearance

Lucide Vue Next ​

Implementation of the lucide icon library for Vue 3 applications.

Vue 3 or Vue 2 ​

TIP

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

Installation ​

sh
pnpm install lucide-vue-next
pnpm install lucide-vue-next
sh
yarn add lucide-vue-next
yarn add lucide-vue-next
sh
npm install lucide-vue-next
npm install lucide-vue-next

How to use ​

Lucide is built with ES Modules, so it's completely tree-shakable.

Each icon can be imported as a Vue component, which renders an inline SVG Element. This way only the icons that are imported into your project are included in the final bundle. The rest of the icons are tree-shaken away.

Example ​

You can pass additional props to adjust the icon.

vue
<template>
  <Camera
    color="red"
    :size="32"
  />
</template>

<script setup>
import { Camera } from 'lucide-vue-next';
</script>
<template>
  <Camera
    color="red"
    :size="32"
  />
</template>

<script setup>
import { Camera } from 'lucide-vue-next';
</script>

Props ​

nametypedefault
sizenumber24
colorstringcurrentColor
stroke-widthnumber2
absolute-stroke-widthbooleanfalse
default-classstringlucide-icon

Applying props ​

To customize the appearance of an icon, you can pass custom properties as props directly to the component. The component accepts all SVG attributes as props, which allows flexible styling of the SVG elements. See the list of SVG Presentation Attributes on MDN.

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

One generic icon component ​

It is possible to create one generic icon component to load icons, but it is not recommended.

DANGER

The example below imports all ES Modules, so exercise caution when using it. Importing all icons will significantly increase the build size of the application, negatively affecting its performance. This is especially important when using bundlers like Webpack, Rollup, or Vite.

Icon Component Example ​

vue
<script setup>
import { computed } from 'vue';
import * as icons from "lucide-vue-next";

const props = defineProps({
  name: {
    type: String,
    required: true
  },
  size: Number,
  color: String,
  strokeWidth: Number,
  defaultClass: String
})

const icon = computed(() => icons[props.name]);
</script>

<template>
  <component
    :is="icon"
    :size="size"
    :color="color"
    :stroke-width="strokeWidth" :default-class="defaultClass"
  />
</template>
<script setup>
import { computed } from 'vue';
import * as icons from "lucide-vue-next";

const props = defineProps({
  name: {
    type: String,
    required: true
  },
  size: Number,
  color: String,
  strokeWidth: Number,
  defaultClass: String
})

const icon = computed(() => icons[props.name]);
</script>

<template>
  <component
    :is="icon"
    :size="size"
    :color="color"
    :stroke-width="strokeWidth" :default-class="defaultClass"
  />
</template>

Using the Icon Component ​

All other props listed above also work on the Icon Component.

vue
<template>
  <div id="app">
    <Icon name="Airplay" />
  </div>
</template>
<template>
  <div id="app">
    <Icon name="Airplay" />
  </div>
</template>