smarteknoloji / blade-circle-flags
A package to easily make use of Circle Flags in your Laravel Blade views.
Requires
- php: ^8.1
- blade-ui-kit/blade-icons: ^1.1
- illuminate/support: ^10.0|^11.0
Requires (Dev)
- orchestra/testbench: ^8.0|^9.0
- phpunit/phpunit: ^10.0|^11.0
README
Blade Circle Flags
A package to easily make use of circle-flags in your Laravel Blade views.
For a full list of available icons see the SVG directory or preview them at https://hatscripts.github.io/circle-flags/.
Requirements
- PHP 8.1 or higher
- Laravel 10.0 or higher
Installation
composer require smarteknoloji/blade-circle-flags
Updating
Please refer to the upgrade guide when updating the library.
Blade Icons
Blade circle-flags 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 circle-flags 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-circle-flags.php config file:
php artisan vendor:publish --tag=blade-circle-flags-config
Usage
Icons can be used as self-closing Blade components which will be compiled to SVG icons:
<x-circleflag-l-zh/>
You can also pass classes to your icon components (flags):
<x-circleflag-l-zh class="w-6 h-6 text-gray-500"/>
And even use inline styles:
<x-circleflag-l-zh style="color: #555"/>
The country flag icons can be referenced like this:
<x-circleflag-c-cn/>
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-circle-flags --force
Then use them in your views like:
<img src="{{ asset('vendor/blade-circle-flags/c-cn.svg') }}" width="10" height="10"/>
Changelog
Check out the CHANGELOG in this repository for all the recent changes.
Maintainers
Blade circle-flags is developed and maintained by Blade Developer.
License
Blade circle-flags is open-sourced software licensed under the MIT license.