FontAwesome helper and blade directive for Laravel
, (*1)
The PendoNL/laravel-fontawesome
package provides an easy way to include FontAwesome icons in your code, there's even a Blade directive to use them inside your blade templates., (*2)
Usage
Make sure you've loaded FontAwesome's CSS on your page! This package only providers little helpers to generate icons!, (*3)
You can use the Facade to generate icons from within your code:, (*4)
FontAwesome::icon('arrow-up');
// Generates <i class="fa fa-arrow-up"></i>
It's also possible to add optional attributes for the icon:, (*5)
FontAwesome::icon('arrow-up', ['class' => 'tiny', 'id' => 'MyFirstIcon']);
// Generates <i class="fa fa-arrow-up tiny" id="MyFirstIcon"></i>
If you aren't using the Facade, this is the way to generate an icon:, (*6)
use PendoNL\LaravelFontAwesome\LaravelFontAwesome;
$fa = new LaravelFontAwesome();
$icon = $fa->icon('arrow-up', ['class' => 'tiny', 'id' => 'MyFirstIcon']);
And last, but not least, you there'a a blade directive to use inside your blade templates:, (*7)
@fa('arrow-up');
@fa('arrow-up', ['class' => 'tiny', 'id' => 'MyFirstIcon']);
Using the Facade from within your templates work as well:, (*8)
{!! FontAwesome::icon('building') !!}
{!! FontAwesome::icon('building', ['id' => 'building-icon']) !}}
Installation
You can install the package via composer:, (*9)
``` bash
composer require pendonl/laravel-fontawesome, (*10)
Next, you must install the service provider (For L5.5 and up Auto-Discovery is enabled):
```php
// config/app.php
'providers' => [
...
PendoNL\LaravelFontAwesome\LaravelFontAwesomeServiceProvider::class,
];
Optionally, register the facade:, (*11)
// config/app.php
'aliases' => [
...
'FontAwesome' => PendoNL\LaravelFontAwesome\Facade::class,
];
Security
If you discover any security related issues, please email joshua@pendo.nl instead of using the issue tracker., (*12)
Credits
It was incredible helpfull to view various packages of Spatie to get to this final version. Aswel as lucasruroken/laravel-font-awesome
which I spotted and was the main reason to start creating my first package ever. Thanks both for open sourcing your packages! I also tried to write down this first experience on my companies blog, comments appreciated!, (*13)
About Pendo
Pendo is a webdevelopment agency based in Maastricht, Netherlands. If you'd like, you can visit our website., (*14)
License
The MIT License (MIT). Please see License File for more information., (*15)