README

A comprehensive media management package for Laravel applications with support for image processing, folder organization, tagging, and modern image format conversion (WebP/AVIF).

Features

📁 Hierarchical Folder Organization - Organize media into nested folders
🏷️ Tag Management - Tag media items for easy categorization
🖼️ Image Processing - Automatic thumbnail generation in multiple sizes
🚀 Modern Image Formats - Automatic conversion to WebP and AVIF
📦 Storage Abstraction - Support for multiple storage backends via Laravel's filesystem
🎬 Video Support - Video thumbnail extraction using FFmpeg (optional)
🔍 Advanced Search & Filtering - Search by name, filter by type, folder, or tag
🎯 Drag & Drop Upload - Modern upload interface with progress tracking
🖱️ Media Modal Component - Single/multi-select modal for choosing media with context support
🔐 Permission-based Access Control - Granular capability-based permissions
🎨 Publishable Views - Customize all Blade views to match your design
🧪 Comprehensive Test Coverage - Over 100 tests with 90%+ coverage

Requirements

PHP 8.2 or higher
Laravel 12.0 or higher
Intervention Image 3.0 for image processing
FFmpeg (optional, for video thumbnail extraction)

Installation

Install via Composer:

composer require artisanpack-ui/media-library

Quick Start

// Upload media
$media = apUploadMedia($file, [
    'title' => 'My Image',
    'alt_text' => 'Alt text for accessibility',
    'folder_id' => 1,
]);

// Get media URL
$url = apGetMediaUrl($mediaId, 'thumbnail');

// Display image
$media = apGetMedia($mediaId);
echo $media->displayImage('large', ['class' => 'img-fluid']);

Documentation

📚 Complete Documentation

Getting Started - Quick start guide
Installation - Detailed installation instructions
Configuration - All configuration options
Helper Functions - Common usage patterns
Working with Models - Advanced model usage
Livewire Components - UI component guide
API Reference - Complete API documentation
CMS Integration - Digital Shopfront CMS setup
Permissions - Access control guide
Customization - Customization options
Troubleshooting - Common issues and solutions
FAQ - Frequently asked questions

Testing

Run the test suite:

composer test

Contributing

Contributions are welcome! Please ensure all tests pass and code follows ArtisanPack UI Code Standards.

Security

If you discover a security vulnerability, please send an email to security@artisanpack.com.

Credits

Jacob Martella
Intervention Image for image processing
PHP-FFMpeg for video processing

License

This package is proprietary software developed by ArtisanPack UI.

artisanpack-ui / media-library

Maintainers

Details