ryangjchandler/filament-data-studio

Zero configuration CSV exports for your Filament resources.

v1.0.0-beta2 2023-12-08 21:33 UTC

Requires

• php: ^8.1
• filament/filament: ^3.0
• illuminate/contracts: ^10.0
• ryangjchandler/filament-progress-column: ^0.4.1
• spatie/laravel-package-tools: ^1.15.0
• spatie/simple-excel: ^3.3

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^7.9
• nunomaduro/larastan: ^2.0.1
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-arch: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• spatie/laravel-ray: ^1.26

MIT

• Ryan Chandler

• laravel
• ryangjchandler
• filament-easy-export
• filament-data-studio
• data-studio

README

Installation

You can install the package via Composer:

composer require ryangjchandler/filament-data-studio

Once the package is installed, us the filament-data-studio:install command to publish and run migrations.

php artisan filament-data-studio:install

Usage

Register the plugin on your Panel.

use RyanChandler\DataStudio\DataStudioPlugin;

$panel
    ->plugin(DataStudioPlugin::make());

Add the ExportAction to one of your Resource tables.

use RyanChandler\DataStudio\Actions\ExportAction;

public static function table(Table $table): Table
{
    return $table
        ->columns([
            // ...
        ])
        ->filters([
            // ...
        ])
        ->headerActions([
            ExportAction::make(),
        ]);
}

Open up the resource inside of your panel and start exporting data!

Using a custom Export model

If you wish to change the Export model and extend it with your own columns, you can do this by creating a model of your own that extends the base Export model and then configuring the plugin to use the new model.

use RyanChandler\DataStudio\Models\Export as BaseExport;

class Export extends BaseExport
{
    //
}

Inside of your PanelProvider:

use App\Models\Export;

$panel
    ->plugin(
        DataStudioPlugin::make()
            ->exportModelClass(Export::class)
    );

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Ryan Chandler
• All Contributors

License

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