maatwebsite/laravel-nova-excel

Supercharged Excel exports for Laravel Nova Resources

1.1.7 2019-09-11 18:22 UTC

README

banner-nova

StyleCI Latest Stable Version Total Downloads License

Supercharge your Laravel Nova resource exports

Quickstart · Documentation · Blog · Contributing · Support

✨ Features

  • Easily export resources to Excel. Supercharge your Nova resources and export them directly to an Excel or CSV document. Exporting has never been so easy.

  • Supercharged resource exports. Export resources with automatic chunking for better performance. You provide us the query, we handle the performance. Exporting even larger resources? No worries, Laravel Nova Excel has your back. You can queue your exports so all of this happens in the background.

  • Export based on filters and selection. Select or filter only certain resources and export only those to Excel!

  • Export lenses. Got custom lenses defined? When exporting from a lens, it will use the query of the lens to determine which data needs to be exported!

🚀 5 minutes quick start

💡 Require this package in the composer.json of your Laravel project. This will download the package and Laravel-Excel.

composer require maatwebsite/laravel-nova-excel

💪 Go to your resource. As example we'll use the app/Nova/User.php. Add DownloadExcel action to your actions() list.

<?php

namespace App\Nova;

use Illuminate\Http\Request;
use Maatwebsite\LaravelNovaExcel\Actions\DownloadExcel;

class User extends Resource
{
    /**
     * The model the resource corresponds to.
     *
     * @var string
     */
    public static $model = 'App\\User';
    
    // Other default resource methods
    
    /**
     * Get the actions available for the resource.
     *
     * @param  \Illuminate\Http\Request $request
     *
     * @return array
     */
    public function actions(Request $request)
    {
        return [
            new DownloadExcel,
        ];
    }
}

🔥 Go to your resource in your Nova admin panel, select all or some users and click "Download Excel"

Laravel-Nova-Excel

📄 Find your users.xlsx in your downloads folder!

More installation instructions can be found at: https://docs.laravel-excel.com/nova/1.1/getting-started/installation.html

🎓 Learning Laravel Excel

You can find the full documentation of Laravel Nova Excel on the website.

We welcome suggestions for improving our docs. The documentation repository can be found at https://github.com/Maatwebsite/laravel-excel-docs.

Some articles and tutorials can be found on our blog: https://medium.com/maatwebsite/laravel-excel/home

🎥 Video Course

1_bzlh2ituv5x7yu2wenhxxw

We are currently building a video course called "Advanced Laravel Excel". In this video course we’ll build a small application with real-life, complex imports and exports that go beyond simple user imports and exports. We’ll go step-by-step and tackle implementing Laravel Excel in a performant way.

If you sign up now, you’ll get notified when the course launches and get it for the early bird price of $69 instead of $99.

📬 License & Postcardware

1_5nblgs68uarg0wxxejozdq

Laravel Excel is completely free (MIT license) to use, however the package is licensed as Postcardware. This means that if it makes it to your production environment, we would very much appreciate receiving a postcard from your hometown.

Maatwebsite
Markt 2
6231 LS Meerssen
The Netherlands

More about the license can be found at: https://docs.laravel-excel.com/3.1/getting-started/license.html