Nuxt Lucide Icons

This Nuxt module makes working with Lucide icons a breeze!

Features

🚠 Auto imports Lucide icons
🎛️ Configurable name prefix
🌲 Supports tree-shaking

Quick Setup

Add nuxt-lucide-icons dependency to your project

# Using pnpmpnpm add -D nuxt-lucide-icons# Using yarnyarn add --dev nuxt-lucide-icons# Using npmnpm install --save-dev nuxt-lucide-icons

Add nuxt-lucide-icons to the modules section of nuxt.config.ts

export default defineNuxtConfig({  modules: [    'nuxt-lucide-icons'  ]})

That's it! You can now use all Lucide icons in your Nuxt app ✨

<template>  <div>    <h1>Nuxt Lucide Icons</h1>    <LucideRocket />    <LucideFolderGit2 color="red" />    <LucideGithub :size="32" />  </div></template>

Configuration

Don't like the default component name prefix? You can change it in nuxt.config.ts:

export default defineNuxtConfig({  modules: [    'nuxt-lucide-icons'  ],  lucide: {    namePrefix: 'Icon'  }})

Development

# Install dependenciesnpm install# Generate type stubsnpm run dev:prepare# Develop with the playgroundnpm run dev# Build the playgroundnpm run dev:build# Run ESLintnpm run lint# Run Vitestnpm run testnpm run test:watch# Release new versionnpm run release

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email security@swis.nl instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

SWIS ❤️ Open Source

SWIS is a web agency from Leiden, the Netherlands. We love working with open source software.