README

Heroicons for Laravel is an elegant Laravel package that enables developers to effortlessly integrate Heroicons into their Laravel applications using Blade components. This package provides a convenient and efficient way to utilize Heroicons' beautifully designed icons in your web projects.

Prerequisites

This package assumes that you are using Tailwind CSS in your Laravel project, as Heroicons are primarily designed to complement Tailwind's utility-first approach. Please ensure that Tailwind CSS is properly set up in your project environment.

Minimum requirements

Name	Version
PHP	8.2
Laravel	10.0

Features

Easy Integration: Seamlessly integrates with Laravel projects.
Blade Components: Leverage Laravel Blade components for easy icon insertion.
Full Heroicons Library: Access to the complete Heroicons collection.

Installation

Install the package via Composer:

composer require codebros-nl/laravel-heroicons

Publish the assets (optional):

php artisan vendor:publish --provider="CodeBros\LaravelHeroicons\Providers\LaravelHeroiconsServiceProvider"

Usage

Using Heroicons in your Laravel views is simple:

<x-heroicons::outline.bolt class="w-6 h-6 text-green-500" />

Replace outline.bolt with the desired Heroicon style and name. Add your own class attributes for size and color customization.

Or if you do like to specify it more specific you can use the code template below:

<x-herocions::icon icon-name="bolt" solid class="w-6 h-6 text-green-500" />

The solid property is optional and will trigger the solid icon set. Removing this property will fallback to our default icon set which is outline.

Contribution

Contributions are welcome! Please follow the standard Laravel contribution guidelines.

License

This package is open-sourced software licensed under the MIT license.

codebros-nl / laravel-heroicons

Maintainers

Details