PHPackages                             artisanpack-ui/icons - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Templating & Views](/categories/templating)
4. /
5. artisanpack-ui/icons

ActiveLibrary[Templating & Views](/categories/templating)

artisanpack-ui/icons
====================

An extensibility layer for Blade Icons that enables flexible registration of custom SVG icon sets via config or events.

2.1.0(5mo ago)0592↓75%1MITPHPPHP ^8.2CI passing

Since Apr 30Pushed 1mo agoCompare

[ Source](https://github.com/ArtisanPack-UI/icons)[ Packagist](https://packagist.org/packages/artisanpack-ui/icons)[ RSS](/packages/artisanpack-ui-icons/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (7)Dependencies (13)Versions (11)Used By (1)

ArtisanPack UI Icons
====================

[](#artisanpack-ui-icons)

An extensibility layer for custom icon sets that integrates seamlessly with `blade-ui-kit/blade-icons` and `livewire-ui-components`. This package provides a simple, flexible way to register and use custom SVG icon sets in your Laravel applications without the overhead of hardcoded icon libraries.

Features
--------

[](#features)

- **Zero Hardcoded Icons:** No memory-heavy icon arrays - bring your own icons
- **Seamless Integration:** Built on `blade-ui-kit/blade-icons` foundation
- **Dual Registration System:** Configure via config files or register programmatically via events
- **Third-Party Extensible:** Other packages can register icon sets via event hooks
- **Font Awesome Pro Ready:** Easy integration with Font Awesome Pro and other premium icon sets
- **Performance Optimized:** Minimal memory footprint and fast loading

Installation
------------

[](#installation)

Install the package via Composer:

```
composer require artisanpack-ui/icons
```

Publish the configuration file:

```
php artisan vendor:publish --tag=artisanpack-package-config
```

Quick Start
-----------

[](#quick-start)

### 1. Configure Your Icon Sets

[](#1-configure-your-icon-sets)

Edit `config/artisanpack/icons.php` to register your icon sets:

```
return [
    'sets' => [
        'fa' => [
+            'path' => resource_path('icons/fontawesome-pro'),
+            'prefix' => 'fa',
+        ],
+        'brand' => [
+            'path' => resource_path('icons/custom-brand'),
+            'prefix' => 'brand',
+        ],
    ],
];
```

### 2. Organize Your Icons

[](#2-organize-your-icons)

Place your SVG files in the configured directories:

```
resources/
├── icons/
│   ├── fontawesome-pro/
│   │   ├── home.svg
│   │   └── user.svg
│   └── custom-brand/
│       ├── logo.svg
│       └── badge.svg

```

### 3. Use Icons in Blade Templates

[](#3-use-icons-in-blade-templates)

```
{{-- Using Font Awesome Pro icons with 'fa' prefix --}}

{{-- Using custom brand icons with 'brand' prefix --}}

```

Registration Methods
--------------------

[](#registration-methods)

### Config-Based Registration

[](#config-based-registration)

The simplest approach - define icon sets in your `config/artisanpack/icons.php`:

```
return [
    'sets' => [
        'hero' => [
            'path'   => resource_path('icons/heroicons'),
            'prefix' => 'hero'
        ],
+       'tabler' => [
            'path'   => resource_path('icons/tabler'),
            'prefix' => 'tabler'
        ],
    ],
];
```

### Event-Driven Registration

[](#event-driven-registration)

Perfect for packages that want to register their own icon sets:

```
use ArtisanPackUI\Icons\Registries\IconSetRegistration;

// In a service provider or event listener
addFilter('ap.icons.register-icon-sets', function (IconSetRegistration $registry) {
    $registry->addSet(__DIR__ . '/../../resources/icons', 'mypackage');
    return $registry;
});
```

Documentation
-------------

[](#documentation)

For comprehensive documentation, visit the [docs](docs) directory:

### Getting Started

[](#getting-started)

- **[Installation Guide](docs/guide/installation.md)** - Complete setup instructions
- **[Usage Examples](docs/guide/usage-examples.md)** - Practical implementation examples
- **[Architecture Overview](docs/guide/architecture.md)** - How the extensibility layer works

### Advanced Usage

[](#advanced-usage)

- **[Extension API](docs/guide/extension-api.md)** - Third-party package integration
- **[Migration Guide](docs/guide/migration.md)** - Upgrading from v1.x
- **[Deprecation Strategy](docs/guide/deprecation-strategy.md)** - v1.x support timeline and migration assistance
- **[Service Provider](docs/guide/service-provider.md)** - Laravel integration details

Requirements
------------

[](#requirements)

- PHP 8.2 or higher
- Laravel 12.0 or higher
- `blade-ui-kit/blade-icons` ^1.8

Contributing
------------

[](#contributing)

As an open source project, this package is open to contributions from anyone. Please [read through the contributing guidelines](CONTRIBUTING.md) to learn more about how you can contribute to this project.

###  Health Score

44

—

FairBetter than 92% of packages

Maintenance81

Actively maintained with recent releases

Popularity17

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~41 days

Recently: every ~48 days

Total

6

Last Release

177d ago

Major Versions

1.0.4 → 2.0.02025-10-06

### Community

Maintainers

![](https://www.gravatar.com/avatar/ba2a2c40c9a93470595cd10701d2291434f3a7db61862d9700a9e69e31608c6c?d=identicon)[JacobMartellaWebDesign](/maintainers/JacobMartellaWebDesign)

---

Top Contributors

[![ViewFromTheBox](https://avatars.githubusercontent.com/u/8247489?v=4)](https://github.com/ViewFromTheBox "ViewFromTheBox (43 commits)")

---

Tags

blade-componentsicon-libraryiconslaravellaravel-packagephpsvg-icons

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/artisanpack-ui-icons/health.svg)

```
[![Health](https://phpackages.com/badges/artisanpack-ui-icons/health.svg)](https://phpackages.com/packages/artisanpack-ui-icons)
```

###  Alternatives

[stijnvanouplines/blade-country-flags

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

26307.2k6](/packages/stijnvanouplines-blade-country-flags)[technikermathe/blade-lucide-icons

A package to easily make use of Lucide icons in your Laravel Blade views.

18299.2k7](/packages/technikermathe-blade-lucide-icons)[saade/blade-iconsax

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

21138.5k](/packages/saade-blade-iconsax)[mckenziearts/blade-untitledui-icons

A package to easily make use of UntitledUI icons in your Laravel Blade views.

16104.9k5](/packages/mckenziearts-blade-untitledui-icons)[afatmustafa/blade-hugeicons

A package to easily make use of Hugeicons(Free version) in your Laravel Blade views.

13129.0k3](/packages/afatmustafa-blade-hugeicons)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)