Lucide Vue ​

Implementation of the lucide icon library for Vue applications.

Vue 2 or Vue 3 ​

Installation ​

pnpm install lucide-vue

yarn add lucide-vue

npm install lucide-vue

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 ​

Additional props can be passed to adjust the icon:

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

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

  export default {
    name: 'My Component',
    components: { Camera }
  };
</script>

Props ​

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.

<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.

Icon Component Example ​

<template>
  <component :is="icon" />
</template>

<script>
  import * as icons from 'lucide-vue';

  export default {
    props: {
      name: {
        type: String,
        required: true
      }
    },
    computed: {
      icon() {
        return icons[this.name];
      }
    }
  };
</script>

Using the Icon Component ​

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