README

Blade Country Flags

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

This package is using SVG flags provided by flag-icon-css. All credits go to this project and all of it's creators.

Requirements

PHP 7.4 or higher
Laravel 8.0 or higher

Installation

composer require stijnvanouplines/blade-country-flags

Blade Icons

Blade Country 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 Country 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-country-flags.php config file:

php artisan vendor:publish --tag=blade-country-flags-config

Usage

Flags can be used as self-closing Blade components which will be compiled to SVG flags:

<x-flag-4x3-be/>

You can also pass classes to your flag components:

<x-flag-4x3-be class="w-6"/>

And even use inline styles:

<x-flag-4x3-be style="width: 1.5rem"/>

A square flag can be referenced like this:

<x-flag-1x1-be/>

Raw SVG Flags

If you want to use the raw SVG flags as assets, you can publish them using:

php artisan vendor:publish --tag=blade-country-flags --force

Then use them in your views like:

<img src="{{ asset('vendor/blade-country-flags/4x3-be.svg') }}" width="10"/>

stijnvanouplines / blade-country-flags

Maintainers

Details