pavlovich4/livewire-filemanager

This package will help to have a livewire file manager

v0.0.1 2025-01-16 09:34 UTC

Requires

• php: ^8.2
• illuminate/support: ^10.0|^11.0
• livewire/livewire: ^3.0
• spatie/laravel-medialibrary: ^10.0|^11.0
• spatie/laravel-package-tools: ^1.14

Requires (Dev)

• laravel/pint: ^1.0
• orchestra/testbench: ^9.0
• pestphp/pest: ^3.0
• phpunit/phpunit: ^11.0

MIT

• Pavlove Biokou

• livewire-filemanager
• pavlovich4

README

A modern, responsive file manager for Laravel using Livewire and Alpine.js. Features include:

• Drag and drop file uploads
• Folder management
• Grid and list views
• File previews
• Image thumbnails
• Copy sharing links
• File downloads

Important Requirements

• PHP 8.2 or higher
• Laravel 10.0 or higher
• Livewire 3.0 or higher
• spatie/laravel-medialibrary 10.0 or higher

Caution

Please be sure to install, configure and run migrations of spatie/laravel-medialibrary package before continue. You can review the installation steps at spatie/laravel-medialibrary documentation.

Installation

1. Install the package via composer:

composer require pavlovich4/livewire-filemanager

1. Publish and run the migrations:

php artisan vendor:publish --tag="livewire-filemanager-migrations"
php artisan migrate

1. Publish the config file:

php artisan vendor:publish --tag="livewire-filemanager-config"

1. Publish and configure the media library:

php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="medialibrary-config"

Update config/media-library.php:

 'custom_path_generators' => [
        \Pavlovich4\LivewireFilemanager\Models\File::class => \Pavlovich4\LivewireFilemanager\Support\CustomPathGenerator::class,
        // or
        // 'model_morph_alias' => PathGenerator::class
    ],

1. Create the symbolic link for public storage:

php artisan storage:link

Important

This package requires Tailwind CSS along with the @tailwindcss/aspect-ratio and @tailwindcss/forms plugins to be installed and configured in your project.

1. Update your Tailwind CSS configuration in tailwind.config.js:

module.exports = {
  // ...
  content: [
    // ...
    './vendor/pavlovich4/livewire-filemanager/resources/views/**/*.blade.php',
  ],
  // ...
  plugins: [
    // ...
    require('@tailwindcss/forms'),
    require('@tailwindcss/aspect-ratio'),
  ],
};

Usage

1. Add the file manager component to your layout:

<livewire:file-manager />
{{-- Or --}}
@livewire('file-manager')

1. Include the style blade directive in the head tag of your layout:

@livewireFileManagerStyle

1. Include the scripts directive at the end of your body:

@livewireFileManagerScript

1. Trigger the file manager from any element using the data-trigger="filemanager" attribute:

<!-- Basic trigger -->
<button data-trigger="filemanager">Open File Manager</button>

Configuration

The package configuration file (config/livewire-filemanager.php) allows you to:

return [
    // Storage disk to use (default: 'public')
    'disk' => 'public',

    // Media library configuration
    'media' => [
        'path_generator' => Pavlovich4\LivewireFilemanager\Support\CustomPathGenerator::class,
    ],
];

Key Features

File Upload

• Drag and drop support
• Multiple file upload
• Progress indicator
• File type validation
• Size limits (configurable)

Folder Management

• Create folders
• Delete folders (with confirmation)
• Rename folders
• Nested folders
• Folder navigation

File Operations

• Preview files
• Download files
• Delete files
• Rename files
• Copy share links
• File icons based on type

UI Features

• Grid/List view toggle
• Breadcrumb navigation
• Responsive design
• Loading states
• Error handling

Interface Screenshot

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Pavlove Biokou
• All Contributors

License

The MIT License (MIT). Please see License File for more information.