artisanpack-ui/icons

This package provides a set of icons for use in the ArtisanPack UI as well as a way for developers to add their own icons and to call them based on category and type.

1.0.4 2025-05-14 17:38 UTC

Requires

• php: ^8.2
• ext-fileinfo: *
• illuminate/support: >=5.3
• tormjens/eventy: ^0.9.4

Requires (Dev)

• orchestra/testbench: ^10.2
• pestphp/pest: ^3.8
• pestphp/pest-plugin-laravel: ^3.1

MIT

• Jacob Martella

README

This package provides a comprehensive set of icons for use in the ArtisanPack UI framework as well as a way for developers to add their own icons and to call them based on category and type.

Quick Start

Installation

Install the package via Composer:

composer require artisanpack-ui/icons

Basic Usage

use ArtisanPackUI\Icons\Facades\Icons;

// Get all icons
$allIcons = Icons::getIcons();

// Get icons by type
$solidIcons = Icons::getIcons(['type' => 'solid']);

// Or use helper functions
$icons = getIcons(['category' => 'navigation']);

Blade Integration

Include icon styles in your templates:

@apIcons

Use icon components:

<x-icon-home class="w-6 h-6" />
<x-icon-user class="w-5 h-5 text-blue-500" />

Documentation

For comprehensive documentation, please visit the docs directory:

Getting Started

• Installation Guide - Complete setup instructions
• Usage Examples - Practical implementation examples

Integration

• Blade Directives - Template integration
• Service Provider - Laravel service provider details
• Asset Management - Asset serving and optimization

API Reference

• Functions - Core class methods
• Helper Functions - Global helper functions

Browse All Documentation

• Guide - Step-by-step guides and tutorials
• Reference - Technical API documentation

Features

• Comprehensive Icon Set: Includes solid, regular, and brand icon types
• Flexible Filtering: Filter icons by category, type, or custom criteria
• Laravel Integration: Native Laravel service provider and Blade directives
• Multiple Access Methods: Use facades, helper functions, or direct instantiation
• Asset Management: Built-in asset serving with security validation
• Performance Optimized: Includes caching strategies and optimization guides

Requirements

• PHP 8.2 or higher
• Laravel 5.3 or higher
• Composer

Contributing

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