phyozawtun/blade-fontawesome

A package to easily make use of Font Awesome in your Laravel Blade views

dev-main 2023-06-06 13:12 UTC

Requires

• php: ^8.0
• blade-ui-kit/blade-icons: ^1.5
• illuminate/support: ^9.0|^10.0
• thecodingmachine/safe: ^2.4

Requires (Dev)

• laravel/pint: ^1.5
• orchestra/testbench: ^7.0|^8.0
• pestphp/pest: ^1.22.3
• phpstan/phpstan: ^1.9.17
• spatie/pest-plugin-snapshots: ^1.1
• symfony/var-dumper: ^6.0
• thecodingmachine/phpstan-safe-rule: ^1.2

MIT

README

• Add Blade Directives
• Add Tabler Icons
• Add Bootstrap Icon
• Add Father Icons
• Add Material Icons

Blade Font Awesome

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

For a full list of available icons see the SVG directory.

Documentation for older versions

You are reading the documentation for 2.x.

If you're using Laravel 8 or below, please see the docs for 1.x.

Please see the upgrade guide for information on how to upgrade to the latest version.

Requirements

• PHP 8.0 or higher
• Laravel 9.x or higher

Install

Via Composer

composer require phyozawtun/blade-fontawesome

Configuration

Blade Font Awesome 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-fontawesome.php config file:

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

Usage

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

<x-fas-cloud/>

You can also pass classes to your icon components:

<x-fas-cloud class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-fas-cloud style="color: #555"/>

Icon Sets

Note: These are default prefixes for the specified icon sets, these can all be configured in the config/blade-fontawesome.php file.

Free Icon Sets

• Brands (fab)
• Regular (far)
• Solid (fas)

Pro Icon Sets

• Duotone (fad)
• Light (fal)
• Thin (fat)
• Sharp (fash)

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

Then use them in your views like:

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

Font Awesome Pro

Blade Font Awesome supports pro icons using npm for downloads.

To use this, install Font Awesome Pro using npm i --save @fortawesome/fontawesome-pro, and then run the following Artisan command to add the icons to your resources path.

php artisan blade-fontawesome:sync-icons --pro

Blade Font Awesome will then automatically detect and use the pro icons under the resources/icons/blade-fontawesome path.

Blade Icons

Blade Font Awesome uses Blade Icons under the hood. Please refer to the Blade Icons readme for additional functionality.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Owen Voke
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.