Quick Filters

Important: Quick Filters is one of the biggest additions to Advanced Tables since it’s initial launch and I’m very excited to be able to bring this functionality to Filament. However, since additional configuration is needed, there are still outstanding features to be implemented, known limitations exist, and there may be custom Filament implementations that haven’t been accounted for, this feature is disabled by default. Please read all the instructions fully to know what is currently supported, what is under development, and what may not be supported. If you do find an issue, please reach out to me on discord our through email.

​

Enabling Quick Filters

1. Enable Quick Filters Quick Filters is disabled by default. To enable, add quickFiltersEnabled() to your panel provider:
   Copy

   AdvancedFilter::make()
       ->quickFiltersEnabled()
   
2. Compile assets After enabling be sure to run npm run build and php artisan filament:upgrade.
3. Update Custom Filter Classes Quick Filters automatically overrides any default Filament filters you have included in your resource or page. However, any custom filter classes that you have created that extends a Filament filter will need to be updated to use Advanced Table’s versions. This can be easily accomplished by just updating your imported class with the plugins equivalent:
   Copy

   - use Filament\Tables\Filters\Filter
   + use Archilex\AdvancedTables\Filament\Filter
   
   - use Filament\Tables\Filters\SelectFilter
   + use Archilex\AdvancedTables\Filament\SelectFilter
   
   - use Filament\Tables\Filters\TernaryFilter
   + use Archilex\AdvancedTables\Filament\TernaryFilter
   
   - use Filament\Tables\Filters\TrashedFilter
   + use Archilex\AdvancedTables\Filament\TrashedFilter
   
   Remember, you only need to override custom filter classes you have created. Filters used within Filament’s resources and pages will be overridden automatically.
4. Add the AdvancedTables trait If you haven’t already, add the AdvancedTables trait to your table.

​

Using Quick Filters

​

Custom Filters with Multiple Form Fields

Filter::make('created_at')
    ->form([
        DatePicker::make('created_from'),
        DatePicker::make('created_until'),
    ])
    ->query(function (Builder $query, array $data): Builder {
        ...
    })
    ->indicateUsing(function (array $data): ?Indicator {                        
        if (($data['created_from'] ?? null) && (! ($data['created_until'] ?? null))) {
            return Indicator::make('Created from ' . Carbon::parse($data['created_from'])->toFormattedDateString());
        } 

        if ((! ($data['created_from'] ?? null)) && ($data['created_until'] ?? null)) {
            return Indicator::make('Created until ' . Carbon::parse($data['created_until'])->toFormattedDateString());
        } 

        if (($data['created_from'] ?? null) && ($data['created_until'] ?? null)) {
            return Indicator::make('Created between ' . Carbon::parse($data['created_from'])->toFormattedDateString() . ' and ' . Carbon::parse($data['created_until'])->toFormattedDateString());
        }

        return null;
    })

Filter::make('published_at')
    ->form([
        DatePicker::make('published_from'),
        DatePicker::make('published_until'),
    ])
    ->query(function (Builder $query, array $data): Builder {
        ...
    })
    ->indicateUsing(function (array $data): array {                        
        $indicators = [];

        if ($data['published_from'] ?? null) {
            $indicators[] = Indicator::make('Published from ' . Carbon::parse($data['published_from'])->toFormattedDateString())
                ->removeField('published_from');
        }

        if ($data['published_until'] ?? null) {
            $indicators[] = Indicator::make('Published until ' . Carbon::parse($data['published_until'])->toFormattedDateString())
                ->removeField('published_until');
        }

        return $indicators;
    }),

Filter::make('created_at')
    ->multipleIndicators(false)

Filter::make('created_at')`
    ->multipleIndicators()

Note: Displaying indicators outside of these two examples (ie. a single indicator for all form fields, or a one-to-one field/indicator setup), is not currently supported. If you have a filter set up like this, please contact me.

​

Favorite Filters

SelectFilter::make('brand')
    ->favorite()

Note: Support for Filament’s ->columns() method on filters is coming soon.

​

Limiting the Indicator labels

SelectFilter::make('brand')
    ->limitIndicatorLabels(3)

'indicators' => [
    'more_indicator_labels' => '+ :count', // display as "+ 4"
],

​

Specifying Favorite Filters in Preset Views

'recentlyCreated' => PresetView::make()
    ->favorite()
    ->defaultFavoriteFilters(['created_at'])
    ->defaultFilters([
        'created_at' => [
            'created_from' => now()->startOfWeek()->toDateString(),
            'created_until' => now()->endOfWeek()->toDateString(),
        ],
    ])

Note: When defining default favorite filters, the order of the filters will be determined by the order they are in listed in Filament’s ->filters() array. Support for ordering by the order of the ->defaultFavoriteFilters() array is coming.

​

Specifying Favorite Filters with User Views (Under Development)

​

Deferring Quick Filters

​

Disabling Quick Filters

class ListOrders extends ListRecords
{
    use AdvancedTables; 

    public static function quickFiltersAreEnabled(): bool
    {
        return false;
    }
    ...

​

Current Limitations and Unknowns

1. Custom filters may not be fully supported, but the goal is to support any implementation with Filament’s filters. If something is not working as expected please contact me.
2. Third-party filter plugins have not been tested. If a filter plugin is not working, please contact me. Please note, that full support may require the plugin developer to update their filter.
3. Filament’s Query Builder Filter is not currently supported.