Filament Excel

Many customization methods on the ExcelExport class accept a Closure. This allows you to inject dynamic data into your export configuration. The following arguments are available within these Closures:

• $livewire: The Livewire component instance (not available for queued exports).
• $livewireClass: The class name of the Livewire component.
• $resource: The Resource class.
• $model: The Model class.
• $recordIds: The IDs of the selected records (used in Bulk Actions).
• $query: The Eloquent query builder instance.

use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportAction::make()->exports([
    ExcelExport::make('table')->withFilename(fn ($resource) => $resource::getLabel()),
])

To separate export logic from your resources or to achieve advanced customization, extend the ExcelExport class and use the setUp() method to configure columns and filenames.

use pxlrbtilament-excel\Actions\Tables\ExportAction;
use pxlrbtilament-excel\Exports\ExcelExport;
use pxlrbtilament-excel\Columns\Column;

class CustomExport extends ExcelExport
{
    public function setUp()
    {
        $this->withFilename('custom_export');
        $this->withColumns([
            Column::make('name'),
            Column::make('email'),
        ]);
    }
}

Install the package using Composer. This will also install laravel-excel as a dependency.

composer require pxlrbt/filament-excel

For exports involving many records, use ->queue() to process the export in a background job. This prevents timeout issues and improves user experience.

• Chunking: Use ->withChunkSize(int) to adjust the number of records processed per job.
• Queue Configuration: You can specify a custom queue name and connection via ->queue(queue: 'name', connection: 'name').
• Lifecycle: Temporary files are deleted after the first download. Un-downloaded files are deleted by a scheduled command after 24 hours.

use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

// Basic queued export
ExcelExport::make()->queue()

// Queued export with custom chunk size
ExcelExport::make()->queue()->withChunkSize(100)

// Queued export with custom queue and connection
ExcelExport::make()->queue(queue: 'exports', connection: 'redis')

Filament Excel provides three primary action classes to trigger exports within your Filament application:

• Actions\Tables\ExportBulkAction: For bulk actions on table rows.
• Actions\Tables\ExportAction: For header actions on a table.
• Actions\Pages\ExportAction: For record pages.

By default, these actions attempt to resolve fields from your existing table or form definitions to generate the Excel file.

use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;

// In a Filament Table
ExportAction::make()

When upgrading to Filament v4, you must use version 3.x of the plugin. Note that Action classes have been simplified into ExportBulkAction (for tables) and ExportAction (for pages).

composer require pxlrbt/filament-excel:3.0

The ExcelExport class is designed to automatically detect the context of the export based on the provided Livewire component (e.g., a Filament Table or Relation Manager):

1. Model Detection: It attempts to find the model class via the Livewire component's table relationship, the associated Filament Resource, or the record currently being viewed.
2. Query Resolution:
   • If useTableQuery is enabled, it uses the filtered and sorted query from the Livewire table.
   • Otherwise, it starts with a base query from the detected model class.
   • If specific recordIds are provided (via hydrate()), the query is automatically constrained to those IDs.
3. Query Modification: You can provide a closure via modifyQueryUsing to further customize the query before execution.

If composer require fails on Laravel 9 or greater due to the simple-cache dependency, you must explicitly specify psr/simple-cache version ^2.0 to satisfy the PhpSpreadsheet dependency.

composer require psr/simple-cache:^2.0 pxlrbt/filament-excel

The simplest way to use Filament Excel is to add the ExportBulkAction to your table's bulk actions. This works with both filament/filament and filament/tables packages.

<?php

namespace App\Filament\Resources;

use pxlrbt\FilamentExcel\Actions\Tables\ExportBulkAction;

class UserResource extends Resource
{
    public static function table(Table $table): Table
    {
        return $table
            ->columns([
                //   
            ])
            ->bulkActions([
                ExportBulkAction::make()
            ]);
    }
}

If you are using a separate table package, you can return the ExportBulkAction within your bulk actions method.

<?php

namespace App\Filament\Resources;

use pxlrbt\FilamentExcel\Actions\Tables\ExportBulkAction;

public function getTableBulkActions()
{
    return  [
        ExportBulkAction::make()
    ];
}

You can overwrite the default export behavior or provide multiple export options. When multiple exports are configured, Filament will present the user with a modal to select which export class they wish to use.

use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportAction::make()->exports([
    ExcelExport::make('table')->fromTable(),
    ExcelExport::make('form')->fromForm(),
])