maiden-voyage-software / blade-emojis
A package to easily make use of Emojis in your Laravel Blade views.
Requires
- php: ^8.2
- blade-ui-kit/blade-icons: ^1.6
- illuminate/support: ^10.0|^11.0|^12.0
Requires (Dev)
- orchestra/testbench: ^10.0
- phpunit/phpunit: ^11.0
README
A package to easily make use of Noto Emoji in your Laravel Blade views.
For a full list of available icons see the SVG directory.
Requirements
- PHP 8.2 or higher
- Laravel 10.0 or higher
Installation
composer require maiden-voyage-software/blade-emojis
Updating
Please refer to the upgrade guide
when updating the library.
Blade Icons
Blade Emojis 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 Emojis 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-emojis.php
config file:
php artisan vendor:publish --tag=blade-emojis-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-emojis --force
Then use them in your views like:
<img src="{{ asset('vendor/blade-emojis/o-adjustments.svg') }}" width="10" height="10"/>
Changelog
Check out the CHANGELOG in this repository for all the recent changes.
Maintainers
Blade Emojis is developed and maintained by Maiden Voyage Software.
License
Blade Emojis is open-sourced software licensed under the MIT license.