ichava/icon-sets-flag

Country flag icons for the Ichava Laravel icon ecosystem: 542 SVGs, 271 flags in 4x3 and 1x1 ratios, vendored from lipis/flag-icons.

Requires ichava/core ^0.1 on PHP ^8.4.1 || ^8.5 and Laravel ^13.

Install

This pack requires ichava/core and nothing else. Nothing in the Ichava family is on Packagist yet, so the application's composer.json first names the repositories: core's installation guide holds the one block that lists them, core's dependencies included, and this pack's line in it is https://github.com/ichava/icon-sets-flag.

Then require the pack:

composer require ichava/icon-sets-flag

The service provider is discovered automatically. Core's installation guide covers core's own setup.

Quick start guide and usage

Getting started

Seed the pack once after installing it, and again after upgrading it:

php artisan ichava::ichava-core.database seed --package=ichava/icon-sets-flag

The seed is not optional: until it runs the registry holds no rows for this pack and every lookup returns nothing. No configuration is needed; the defaults are merged without publishing anything.

Usage

Icons are addressed as ichava/icon-sets-flag::<ratio>/<code>. In Blade, through core's component:

<x-ichava::icon name="ichava/icon-sets-flag::4x3/us" class="w-6 h-4" />

Or from PHP, through core's helper:

{{ ichava('ichava/icon-sets-flag::1x1/de')->class('w-5 h-5') }}

See Getting started for the full walkthrough, and the Documentation index below for everything else.

Documentation

The full documentation lives in this repository, under docs/, and is indexed below.

This pack

• Installation — requirements, the repositories block, seeding
• Getting started — your first icon from this pack
• Configuration — this pack's config key, and what is core's instead
• Architecture — what it ships, what it delegates, and why
• Release — how a version is cut, and when the core floor moves
• Variants — the 1x1 and 4x3 ratios, and the ISO 3166-1 codes files are named by
• Customisation — sizing, why currentColor does nothing here, rounded and bordered flags
• Attribution — upstream project, licence terms, and where the vendored version is recorded

Shared across every pack

• Use an icon pack — addressing icons, in Blade and in PHP
• Seed pack icons — the seeding pipeline and its options
• Check pack updates — the update checker and what its statuses mean
• Serve icons from a CDN — reading this pack's CDN templates out of config.json

Its upstream is lipis/flag-icons; run core's check pack updates recipe to see whether a newer release exists.

Contributing & security

See CONTRIBUTING.md. Report vulnerabilities privately through security policy — never in a public issue.

License

The package code is MIT, © Simtabi LLC. See LICENSE.

The flags are flag-icons, © Panayiotis Lipiridis, under their own MIT licence. Simtabi LLC claims no authorship of them. Their notice is in ATTRIBUTION.md, which ships with the package and must accompany any copy of the flags.