dvarilek/filament-validation-overview

Validation overview for Filament forms

dev-main 2025-10-08 13:43 UTC

Requires

• php: ^8.2|^8.3|^8.4
• filament/filament: ^v4.0.18
• spatie/laravel-package-tools: ^1.18

Requires (Dev)

• larastan/larastan: ^3.5
• laravel/pint: ^1.22
• orchestra/testbench: ^8.0|^9.0
• pestphp/pest: ^2.31|^3.0.0
• pestphp/pest-plugin-livewire: ^3.0
• phpstan/phpstan: ^2.1
• phpstan/phpstan-deprecation-rules: ^2.0

MIT

• David Vařílek

• form
• validation
• overview
• filament

README

This plugin adds a validation overview for complex Filament forms that contain many fields.

Getting Started

Instalation

composer require dvarilek/filament-validation-overview:^1.0

Configuration

Validation overview can either be configured on every Livewire page component manually, or by registering a configuration through the admin panel provider. Doing the latter is the reccomended approach, mainly because it ultimately makes things more managable.

Pege Configuration

Declare validationOverview() method to configure the validation overview.

use Filament\Resources\Pages\EditRecord;
use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;

class EditCustomer extends EditRecord
{
    // ...

    public function validationOverview(ValidationOverview $validationOverview): ValidationOverview
    {
        return $validationOverview
            ->description("Custom description");
    }
}

To configure validation overview for a specific action, prefix the method name with the given action. For example, if your action is named editCustomer, it should be editCustomerValidationOverview().

use Filament\Resources\Pages\EditRecord;
use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;

class EditCustomer extends EditRecord
{
    // ...

    public function editCustomerValidationOverview(ValidationOverview $validationOverview): ValidationOverview
    {
        return $validationOverview
            ->description("Custom description for edit customer action");
    }
}

Additionally, declaring actionValidationOverview() allows you to configure all action validation overviews on that Livewire component. The former example of specifying the action name in the method signature takes priority if present.

use Filament\Resources\Pages\EditRecord;
use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;
use Filament\Actions\Action;

class EditCustomer extends EditRecord
{
    // ...

    public function actionValidationOverview(ValidationOverview $validationOverview, Action $action): ValidationOverview
    {
        return $validationOverview
            ->description("Custom description for " . $action->getName());
    }
}

Panel Configuration

To configure validation overview centrally, register the Dvarilek\FilamentValidationOverview\ValidationOverviewPlugin plugin in your admin panel provider. this is the recommended approach.

use Filament\Panel;
use Filament\PanelProvider;
use Dvarilek\FilamentValidationOverview\ValidationOverviewPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->id('admin')
            ...
            ->plugins([
                ValidationOverviewPlugin::make()
            ]);
    }
}

The default() method allows you to set a default validation overview configuration (excluding validation overview in action modals).

use Dvarilek\FilamentValidationOverview\ValidationOverviewPlugin;
use Filament\Schemas\Contracts\HasSchemas;
use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;

ValidationOverviewPlugin::make()
    ->default(function (ValidationOverview $validationOverview) {
        $validationOverview->description('Default description for validation overviews')
    })

For configuring the validation overview instance itself, see Validation overview configuration

The actionDefault()method allows you to set a default validation overview configuration.

use Dvarilek\FilamentValidationOverview\ValidationOverviewPlugin;
use Filament\Schemas\Contracts\HasSchemas;
use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;

ValidationOverviewPlugin::make()
    ->actionDefault(function (ValidationOverview $validationOverview) {
        $validationOverview->description('Default description for validation overviews')
    })

The forResource() method allows configuration for specific Filament Resources.

use Dvarilek\FilamentValidationOverview\ValidationOverviewPlugin;
use Filament\Schemas\Contracts\HasSchemas;
use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;

ValidationOverviewPlugin::make()
    ->forResource(CustomerResource::class, function (ValidationOverview $validationOverview, HasSchemas $livewire) {
        // The description will get changed on the suitable pages belongting to this Resource (most likely CreateCustomer and EditCustomer)
        $validationOverview->description("Please resolve the following errors with this customer");
    })

The for() method allows configuration of validation overviews for specific Livewire page components and takes priority over resource configurations. This doesn't change validation for specific action modals on the page(s).

use Dvarilek\FilamentValidationOverview\ValidationOverviewPlugin;
use Filament\Schemas\Contracts\HasSchemas;
use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;

ValidationOverviewPlugin::make()
    ->for(EditCustomers::class, function (ValidationOverview $validationOverview, HasSchemas $livewire) {
        $validationOverview->description("Please resolve the following errors with this customer");
    })
    ->for([
        EditCompany::class, 
        CreateCompany::class
    ], function (ValidationOverview $validationOverview, HasSchemas $livewire) {
        $validationOverview->description("Please resolve the following errors")
    })

The forAction() method allows configuration of validation overviews in modals in specific Livewire components. After the Livewire component(s), specific actions are expected as the second argument.

use Dvarilek\FilamentValidationOverview\ValidationOverviewPlugin;
use Filament\Schemas\Contracts\HasSchemas;
use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;

ValidationOverviewPlugin::make()
    ->forAction(
        EditCustomers::class, 
        'editCustomerInfo', 
        function (ValidationOverview $validationOverview, HasSchemas&HasActions $livewire, Action $action) {
            $validationOverview->description("Please resolve the following errors in this modal");
    })

The second argument of forAction() that specifies the action scope, can accept a Closure for flexibility.

use Dvarilek\FilamentValidationOverview\ValidationOverviewPlugin;
use Filament\Schemas\Contracts\HasSchemas;
use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;

ValidationOverviewPlugin::make()
    ->forAction(
        EditCustomers::class, 
        function (Action $action, HasSchemas&HasActions $livewire) {
            return $action->getName() === 'editCustomerInfo';
        }, 
        function (ValidationOverview $validationOverview) {
            // ...
        })

[!INFO]
The for(), forResource(), forAction() and forResourceAction() methods can be used multiple times on the plugin instance as the specific configurations gets appended to arrays and later resolved. Only one configuration gets applied for each component.

Validation overview configuration

You can change the heading and description of a validation overview.

use Dvarilek\FilamentValidationOverview\Components\ValidationOverview;

/* @var ValidationOverview */
$validationOverview
    ->heading("")
    ->description("Please resolve the folloing errors");