yajra/laravel-datatables-export

Laravel DataTables Queued Export Plugin.

v11.0.1 2024-04-16 13:55 UTC

Requires

• php: ^8.2
• ext-json: *
• livewire/livewire: ^2.11.2|^3.0.1
• openspout/openspout: ^4.12.1
• pestphp/pest: ^2.34
• pestphp/pest-plugin-laravel: ^2.3
• phpoffice/phpspreadsheet: ^1.27
• yajra/laravel-datatables-buttons: ^11.0

Requires (Dev)

• larastan/larastan: ^2.9.1
• laravel/pint: ^1.14
• orchestra/testbench: ^9
• rector/rector: ^1.0

MIT

• Arjay Angeles

• queue
• excel
• export
• laravel
• datatables
• livewire

README

This package is a plugin of Laravel DataTables for handling server-side exporting using Queue, OpenSpout and Livewire.

Requirements

• PHP >=8.2
• Laravel 11
• Laravel Livewire
• OpenSpout
• Laravel DataTables 11.x
• jQuery DataTables v1.10.x

Documentations

• Laravel DataTables Documentation

Laravel Version Compatibility

Laravel	Package
8.x	0.x
9.x	1.x
10.x	10.x
11.x	11.x

Quick Installation

composer require yajra/laravel-datatables-export:^11.0

The package also requires batch job:

php artisan queue:batches-table
php artisan migrate

Service Provider (Optional since Laravel 5.5+)

Yajra\DataTables\ExportServiceProvider::class

Configuration and Assets (Optional)

$ php artisan vendor:publish --tag=datatables-export --force

Usage

1. Add the export-button livewire component on your view file that uses dataTable class.

<livewire:export-button :table-id="$dataTable->getTableId()"/>

1. On your DataTable class, use WithExportQueue

use Yajra\DataTables\WithExportQueue;

class PermissionsDataTable extends DataTable
{
    use WithExportQueue;
    
    ...
}

1. Run your queue worker. Ex: php artisan queue:work

Purging exported files

On app\Console\Kernel.php, register the purge command

$schedule->command('datatables:purge-export')->weekly();

Export Filename

You can set the export filename by setting the property.

<livewire:export-button :table-id="$dataTable->getTableId()" filename="my-table.xlsx"/>
<livewire:export-button :table-id="$dataTable->getTableId()" filename="my-table.csv"/>

<livewire:export-button :table-id="$dataTable->getTableId()" :filename="$filename"/>

Export Type

You can set the export type by setting the property to csv or xlsx. Default value is xlsx.

<livewire:export-button :table-id="$dataTable->getTableId()" type="xlsx"/>
<livewire:export-button :table-id="$dataTable->getTableId()" type="csv"/>

Set Excel Sheet Name

Option 1: You can set the Excel sheet name by setting the property.

<livewire:export-button :table-id="$dataTable->getTableId()" sheet-name="Monthly Report"/>

Option 2: You can also set the Excel sheet name by overwriting the method.

protected function sheetName() : string
{
    return "Yearly Report";
}

Formatting Columns

You can format the column by setting it via Column definition on you DataTable service class.

Column::make('mobile')->exportFormat('00000000000'),

The format above will treat mobile numbers as text with leading zeroes.

Numeric Fields Formatting

The package will auto-detect numeric fields and can be used with custom formats.

Column::make('total')->exportFormat('0.00'),
Column::make('count')->exportFormat('#,##0'),
Column::make('average')->exportFormat('#,##0.00'),

Date Fields Formatting

The package will auto-detect date fields when used with a valid format or is a DateTime instance.

Column::make('report_date')->exportFormat('mm/dd/yyyy'),
Column::make('created_at'),
Column::make('updated_at')->exportFormat(NumberFormat::FORMAT_DATE_DATETIME),

Valid Date Formats

Valid date formats can be adjusted on datatables-export.php config file.

    'date_formats' => [
        'mm/dd/yyyy',
        NumberFormat::FORMAT_DATE_DATETIME,
        NumberFormat::FORMAT_DATE_YYYYMMDD,
        NumberFormat::FORMAT_DATE_XLSX22,
        NumberFormat::FORMAT_DATE_DDMMYYYY,
        NumberFormat::FORMAT_DATE_DMMINUS,
        NumberFormat::FORMAT_DATE_DMYMINUS,
        NumberFormat::FORMAT_DATE_DMYSLASH,
        NumberFormat::FORMAT_DATE_MYMINUS,
        NumberFormat::FORMAT_DATE_TIME1,
        NumberFormat::FORMAT_DATE_TIME2,
        NumberFormat::FORMAT_DATE_TIME3,
        NumberFormat::FORMAT_DATE_TIME4,
        NumberFormat::FORMAT_DATE_TIME5,
        NumberFormat::FORMAT_DATE_TIME6,
        NumberFormat::FORMAT_DATE_TIME7,
        NumberFormat::FORMAT_DATE_XLSX14,
        NumberFormat::FORMAT_DATE_XLSX15,
        NumberFormat::FORMAT_DATE_XLSX16,
        NumberFormat::FORMAT_DATE_XLSX17,
        NumberFormat::FORMAT_DATE_YYYYMMDD2,
        NumberFormat::FORMAT_DATE_YYYYMMDDSLASH,
    ]

Force Numeric Field As Text Format

Option to force auto-detected numeric value as text format.

Column::make('id')->exportFormat('@'),
Column::make('id')->exportFormat(NumberFormat::FORMAT_GENERAL),
Column::make('id')->exportFormat(NumberFormat::FORMAT_TEXT),

Auto Download

Option to automatically download the exported file.

<livewire:export-button :table-id="$dataTable->getTableId()" filename="my-table.xlsx" auto-download="true"/>

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

• Arjay Angeles
• All Contributors
• Laravel Daily

License

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