Filament: Excel Export and Import Examples - Two Packages

Exporting and importing data from an Excel file is very common. In this tutorial, we will use pxlrbt/filament-excel for exporting and konnco/filament-import for importing data.

Importing Data

First, we must install the package via composer.

composer require konnco/filament-import:"^2.0"

When writing this tutorial, this package is in beta for supporting Filament v3. You need to set minimum-stability to beta.

composer.json:

{
    // ...
    "minimum-stability": "beta", 
    "prefer-stable": true
}

We can add an Import action to the header actions list. This is done in the ListRecords page for your Resource.

use Konnco\FilamentImport\Actions\ImportField;
use Konnco\FilamentImport\Actions\ImportAction;
 
class ListItems extends ListRecords
{
    protected static string $resource = ItemResource::class;
 
    protected function getHeaderActions(): array
    {
        return [
            Actions\CreateAction::make(),
            ImportAction::make() 
                ->uniqueField('name')
                ->fields([
                    ImportField::make('name')
                        ->required(),
                    ImportField::make('category.name')
                        ->required()
                        ->label('Category name'),
                    ImportField::make('stock')
                        ->required(),
                ]), 
        ];
    }
}

Now, we can see an action button in the tables header.

After uploading a file, we can select a column.

Great, that should work now, right? It would work if the category weren't in the relation in this example. For this case, the package allows to manually create records.

use App\Models\Item;
use App\Filament\Resources\CategoryResource;
use Konnco\FilamentImport\Actions\ImportField;
use Konnco\FilamentImport\Actions\ImportAction;
 
class ListItems extends ListRecords
{
    protected static string $resource = ItemResource::class;
 
    protected function getHeaderActions(): array
    {
        return [
            Actions\CreateAction::make(),
            ImportAction::make()
                ->uniqueField('name')
                ->fields([
                    ImportField::make('name')
                        ->required(),
                    ImportField::make('category.name')
                        ->required()
                        ->label('Category name'),
                    ImportField::make('stock')
                        ->required(),
                ])
                ->handleRecordCreation(function(array $data) { 
                    if ($category = CategoryResource::getEloquentQuery()->where('name', $data['category']['name'])->first()) {
                        return Item::create([
                            'name' => $data['name'],
                            'current_stock' => $data['stock'],
                            'category_id' => $category->id,
                        ]);
                    }
 
                    return new Item();
                }), 
        ];
    }
}

If the category exists, we only create a new record from the Excel import in this example. The handleRecordCreation method needs to return a Model. That's why we return the created Model or a new Model instance.

For more available options, check the package documentation.

Exporting Data

As always, the package can be installed via composer.

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

Next, we need to action button in the ListRecords page for your Resource.

use pxlrbt\FilamentExcel\Columns\Column;
use pxlrbt\FilamentExcel\Exports\ExcelExport;
use pxlrbt\FilamentExcel\Actions\Pages\ExportAction;
 
class ListItems extends ListRecords
{
    protected static string $resource = ItemResource::class;
 
    protected function getHeaderActions(): array
    {
        return [
            Actions\CreateAction::make(),
            ImportAction::make()
                ->uniqueField('name')
                ->fields([
                    ImportField::make('name')
                        ->required(),
                    ImportField::make('category.name')
                        ->required()
                        ->label('Category name'),
                    ImportField::make('stock')
                        ->required(),
                ])
                ->handleRecordCreation(function(array $data) {
                    if ($category = CategoryResource::getEloquentQuery()->where('name', $data['category']['name'])->first()) {
                        return Item::create([
                            'name' => $data['name'],
                            'current_stock' => $data['stock'],
                            'category_id' => $category->id,
                        ]);
                    }
 
                    return new Item();
                }),
            ExportAction::make() 
                ->exports([
                    ExcelExport::make()
                        ->fromTable()
                        ->withFilename(fn ($resource) => $resource::getModelLabel() . '-' . date('Y-m-d'))
                        ->withWriterType(\Maatwebsite\Excel\Excel::CSV)
                        ->withColumns([
                            Column::make('updated_at'),
                        ])
                ]), 
        ];
    }
}

Now, we can see an action button in the tables header.

Because we are exporting from the table, all fields are resolved from that, but using the withColumns method, we add an additional field, updated_at.

We also provide the filename using the withFilename method. And because this package uses the laravel-excel package under the hood, the file type in the withWriterType method is provided using the laravel-excel package.

After pressing the export button, we download the exported data as a CSV file.

If you want more Filament examples, you can find more real-life projects on our FilamentExamples.com.