README

A Laravel package that provides Lucide icons as Blade components.

Installation

You can install the package via composer:

composer require johnnynotsolucky/laravel-lucide

The package will automatically register its service provider.

You can use any Lucide icon as a Blade component:

<x-lucide::refresh-cw size="16" class="some-class" />

Prop	Default	Description
size	24	The size of the icon in pixels
stroke	currentColor	The stroke color of the icon
strokeWidth	2	The stroke width of the icon
class	''	Additional CSS classes to apply to the icon

You can also pass any additional HTML attributes to the component, which will be applied to the SVG element:

<x-lucide::refresh-cw size="16" class="some-class" />

If you want to customize the icon components, you can publish the views:

php artisan vendor:publish --tag=lucide-views

This package includes a script to generate the icon components from the Lucide library. To generate the icons, run:

npm install
npm run generate-icons

The Laravel Lucide package is licensed under the MIT License. Please see License File for more information.

The Lucide icons themselves are licensed under the ISC License and are maintained by the Lucide Icons project.