Skip to content

Latest commit

 

History

History
96 lines (62 loc) · 2.67 KB

README.md

File metadata and controls

96 lines (62 loc) · 2.67 KB
Raw

Blade Lucide Icons

Tests Latest Stable Version Total Downloads

A package to easily make use of Lucide Icons in your Laravel Blade views.

For a full list of available icons see the SVG directory or preview them at lucide.dev.

Requirements

  • PHP 8.1 or higher
  • Laravel 9.0 or higher

Installation

composer require technikermathe/blade-lucide-icons

Blade Icons

Blade LucideIcons uses Blade Icons under the hood. Please refer to the Blade Icons readme for additional functionality. We also recommend to enable icon caching with this library.

Configuration

Blade LucideIcons also offers the ability to use features from Blade Icons like default classes, default attributes, etc. If you'd like to configure these, publish the blade-lucide-icons.php config file:

php artisan vendor:publish --tag=blade-lucide-icons-config

Usage

Icons can be used as self-closing Blade components which will be compiled to SVG icons:

<x-lucide-activity />

You can also pass classes to your icon components:

<x-lucide-album class="w-6 h-6 text-gray-500"/>

This is how you can change the stroke width:

<x-lucide-server stroke-width="1"/>

And even use inline styles:

<x-lucide-anchor style="color: #555"/>

The solid icons can be referenced like this:

<x-lucide-bike />

Raw SVG Icons

If you want to use the raw SVG icons as assets, you can publish them using:

php artisan vendor:publish --tag=blade-lucide-icons --force

Then use them in your views like:

<img src="{{ asset('vendor/blade-lucide-icons/cloud-moon.svg') }}" width="10" height="10"/>

Changelog

Check out the CHANGELOG in this repository for all the recent changes.

Maintainers

This is a fork of the initial work of Dan Pock.

License

Blade LucideIcons is open-sourced software licensed under the MIT license.