Skip to content

Latest commit

 

History

History
104 lines (69 loc) · 3.51 KB

README.md

File metadata and controls

104 lines (69 loc) · 3.51 KB
Raw

Blade Icons Template

Tests Latest Stable Version Total Downloads

This is a template repository for new icon packages for Blade Icons. Start a new repo with this and replace the relevant things below:

  1. blade-organization with your GitHub organization
  2. blade-heroicons with your repository name
  3. Blade Heroicons & Blade Icons Template with your icon set name
  4. Any other reference to Heroicons with your icon set name
  5. Blade Developer with your name

Then, make sure the implementation is correct, that you set up icon generation and that your tests pass. And remove this quote block from your readme. When you've published your package on Packagist, make sure to send it in to the Blade Icons package list.

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

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

Requirements

  • PHP 8.2 or higher
  • Laravel 10.0 or higher

Installation

composer require blade-organization/blade-heroicons

Updating

Please refer to the upgrade guide when updating the library.

Blade Icons

Blade Heroicons 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 Heroicons 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-heroicons.php config file:

php artisan vendor:publish --tag=blade-heroicons-config

Usage

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

<x-heroicon-o-adjustments/>

You can also pass classes to your icon components:

<x-heroicon-o-adjustments class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-heroicon-o-adjustments style="color: #555"/>

The solid icons can be referenced like this:

<x-heroicon-s-adjustments/>

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-heroicons --force

Then use them in your views like:

<img src="{{ asset('vendor/blade-heroicons/o-adjustments.svg') }}" width="10" height="10"/>

Changelog

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

Maintainers

Blade Heroicons is developed and maintained by Blade Developer.

License

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