Media Library - v1.0-beta1

Welcome to the documentation for the ArtisanPack UI Media Library package. This comprehensive guide covers installation, configuration, usage patterns, API endpoints, integration with the Digital Shopfront CMS, and troubleshooting.

The Media Library provides a complete solution for managing media files in Laravel applications, including hierarchical folder organization, tagging, image processing with modern format conversion (WebP/AVIF), video thumbnail extraction, and a powerful Livewire-based UI.

Use the sidebar or the links below to navigate. Each page begins with a header and concise summary, and many include copy-paste examples.

Table of Contents

• Getting Started

  • Quick Start Guide

• Installation

  • Installation Overview
  • Requirements
  • Configuration

• Usage

  • Helper Functions
  • Working with Models
  • Livewire Components

• API

  • API Overview
  • Endpoints Reference
  • Authentication

• Integration

  • CMS Module Integration
  • Permissions & Access Control
  • Customization

• Reference

  • Troubleshooting
  • FAQ

Key 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
• 🎬 Video Support - Video thumbnail extraction using FFmpeg
• 🔍 Advanced Search & Filtering - Search, filter by type, folder, or tag
• 🎯 Drag & Drop Upload - Modern upload interface with progress tracking
• 🖱️ Media Modal Component - Single/multi-select modal with context support
• 🔐 Permission-based Access Control - Granular capability-based permissions

Quick Links

• Installation Guide - Get started quickly
• Helper Functions - Common usage patterns
• API Endpoints - Complete API reference
• Troubleshooting - Common issues and solutions

About This Documentation

This documentation is structured to support both standalone package usage and integration with the Digital Shopfront CMS. Examples are provided for both scenarios where applicable.

The package follows Laravel and ArtisanPack UI best practices, ensuring compatibility and maintainability.