DOCS
DOCS

Version

Theme

Table Builder - Filters

Filters

Overview

Filters allow you to define certain constraints on your data, and allow users to scope it to find the information they need. You put them in the $table->filters() method:

use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ]);
}
Table with filter

Filters may be created using the static make() method, passing its unique name. You should then pass a callback to query() which applies your filter's scope:

use Filament\Tables\Filters\Filter;
use Illuminate\Database\Eloquent\Builder;
 
Filter::make('is_featured')
    ->query(fn (Builder $query): Builder => $query->where('is_featured', true))

Setting a label

By default, the label of the filter, which is displayed in the filter form, is generated from the name of the filter. You may customize this using the label() method:

use Filament\Tables\Filters\Filter;
 
Filter::make('is_featured')
    ->label('Featured')

Optionally, you can have the label automatically translated using Laravel's localization features with the translateLabel() method:

use Filament\Tables\Filters\Filter;
 
Filter::make('is_featured')
    ->translateLabel() // Equivalent to `label(__('Is featured'))`

Customizing the filter form

By default, creating a filter with the Filter class will render a checkbox form component. When the checkbox is checked, the query() function will be applied to the table's query, scoping the records in the table. When the checkbox is unchecked, the query() function will be removed from the table's query.

Filters are built entirely on Filament's form fields. They can render any combination of form fields, which users can then interact with to filter the table.

Using a toggle button instead of a checkbox

The simplest example of managing the form field that is used for a filter is to replace the checkbox with a toggle button, using the toggle() method:

use Filament\Tables\Filters\Filter;
 
Filter::make('is_featured')
    ->toggle()
Table with toggle filter

Applying the filter by default

You may set a filter to be enabled by default, using the default() method:

use Filament\Tables\Filters\Filter;
 
Filter::make('is_featured')
    ->default()

Select filters

Often, you will want to use a select field instead of a checkbox. This is especially true when you want to filter a column based on a set of pre-defined options that the user can choose from. To do this, you can create a filter using the SelectFilter class:

use Filament\Tables\Filters\SelectFilter;
 
SelectFilter::make('status')
    ->options([
        'draft' => 'Draft',
        'reviewing' => 'Reviewing',
        'published' => 'Published',
    ])

The options() that are passed to the filter are the same as those that are passed to the select field.

Customizing the column used by a select filter

Select filters do not require a custom query() method. The column name used to scope the query is the name of the filter. To customize this, you may use the attribute() method:

use Filament\Tables\Filters\SelectFilter;
 
SelectFilter::make('status')
    ->options([
        'draft' => 'Draft',
        'reviewing' => 'Reviewing',
        'published' => 'Published',
    ])
    ->attribute('status_id')

Multi-select filters

These allow the user to select multiple options to apply the filter to their table. For example, a status filter may present the user with a few status options to pick from and filter the table using. When the user selects multiple options, the table will be filtered to show records that match any of the selected options. You can enable this behaviour using the multiple() method:

use Filament\Tables\Filters\SelectFilter;
 
SelectFilter::make('status')
    ->multiple()
    ->options([
        'draft' => 'Draft',
        'reviewing' => 'Reviewing',
        'published' => 'Published',
    ])

Relationship select filters

Select filters are also able to automatically populate themselves based on a relationship. For example, if your table has a author relationship with a name column, you may use relationship() to filter the records belonging to an author:

use Filament\Tables\Filters\SelectFilter;
 
SelectFilter::make('author')
    ->relationship('author', 'name')

Preloading the select filter relationship options

If you'd like to populate the searchable options from the database when the page is loaded, instead of when the user searches, you can use the preload() method:

use Filament\Tables\Filters\SelectFilter;
 
SelectFilter::make('author')
    ->relationship('author', 'name')
    ->searchable()
    ->preload()
Customizing the select filter relationship query

You may customize the database query that retrieves options using the third parameter of the relationship() method:

use Filament\Tables\Filters\SelectFilter;
use Illuminate\Database\Eloquent\Builder;
 
SelectFilter::make('author')
    ->relationship('author', 'name', fn (Builder $query) => $query->withTrashed())

Searching select filter options

You may enable a search input to allow easier access to many options, using the searchable() method:

use Filament\Tables\Filters\SelectFilter;
 
SelectFilter::make('author')
    ->relationship('author', 'name')
    ->searchable()

Ternary filters

Ternary filters allow you to easily create a select filter which has three states - usually true, false and blank. To filter a column named is_admin to be true or false, you may use the ternary filter:

use Filament\Tables\Filters\TernaryFilter;
 
TernaryFilter::make('is_admin')

Using a ternary filter with a nullable column

Another common pattern is to use a nullable column. For example, when filtering verified and unverified users using the email_verified_at column, unverified users have a null timestamp in this column. To apply that logic, you may use the nullable() method:

use Filament\Tables\Filters\TernaryFilter;
 
TernaryFilter::make('email_verified_at')
    ->nullable()

Customizing the column used by a ternary filter

The column name used to scope the query is the name of the filter. To customize this, you may use the attribute() method:

use Filament\Tables\Filters\TernaryFilter;
 
TernaryFilter::make('verified')
    ->nullable()
    ->attribute('status_id')

Customizing the ternary filter option labels

You may customize the labels used for each state of the ternary filter. The true option label can be customized using the trueLabel() method. The false option label can be customized using the falseLabel() method. The blank (default) option label can be customized using the placeholder() method:

use Illuminate\Database\Eloquent\Builder;
use Filament\Tables\Filters\TernaryFilter;
 
TernaryFilter::make('email_verified_at')
    ->label('Email verification')
    ->nullable()
    ->placeholder('All users')
    ->trueLabel('Verified users')
    ->falseLabel('Not verified users')

Customizing how a ternary filter modifies the query

You may customize how the query changes for each state of the ternary filter, use the queries() method:

use Illuminate\Database\Eloquent\Builder;
use Filament\Tables\Filters\TernaryFilter;
 
TernaryFilter::make('trashed')
    ->placeholder('Without trashed records')
    ->trueLabel('With trashed records')
    ->falseLabel('Only trashed records')
    ->queries(
        true: fn (Builder $query) => $query->withTrashed(),
        false: fn (Builder $query) => $query->onlyTrashed(),
        blank: fn (Builder $query) => $query->withoutTrashed(),
    )

Custom filter forms

Filament Laracasts
Build a Custom Table Filter
Watch the Build Advanced Components for Filament series on Laracasts - it will teach you how to build components, and you'll get to know all the internal tools to help you.
Play Video
Instructor

You may use components from the Form Builder to create custom filter forms. The data from the custom filter form is available in the $data array of the query() callback:

use Filament\Forms\Components\DatePicker;
use Filament\Tables\Filters\Filter;
use Illuminate\Database\Eloquent\Builder;
 
Filter::make('created_at')
    ->form([
        DatePicker::make('created_from'),
        DatePicker::make('created_until'),
    ])
    ->query(function (Builder $query, array $data): Builder {
        return $query
            ->when(
                $data['created_from'],
                fn (Builder $query, $date): Builder => $query->whereDate('created_at', '>=', $date),
            )
            ->when(
                $data['created_until'],
                fn (Builder $query, $date): Builder => $query->whereDate('created_at', '<=', $date),
            );
    })
Table with custom filter form

Setting default values for custom filter fields

To customize the default value of a field in a custom filter form, you may use the default() method:

use Filament\Forms\Components\DatePicker;
use Filament\Tables\Filters\Filter;
 
Filter::make('created_at')
    ->form([
        DatePicker::make('created_from'),
        DatePicker::make('created_until')
            ->default(now()),
    ])

Active indicators

When a filter is active, an indicator is displayed above the table content to signal that the table query has been scoped.

Table with filter indicators

By default, the label of the filter is used as the indicator. You can override this using the indicator() method:

use Filament\Tables\Filters\Filter;
 
Filter::make('is_admin')
    ->label('Administrators only?')
    ->indicator('Administrators')

If you are using a custom filter form, you should use indicateUsing() to display an active indicator.

Custom active indicators

Not all indicators are simple, so you may need to use indicateUsing() to customize which indicators should be shown at any time.

For example, if you have a custom date filter, you may create a custom indicator that formats the selected date:

use Filament\Forms\Components\DatePicker;
use Filament\Tables\Filters\Filter;
 
Filter::make('created_at')
    ->form([DatePicker::make('date')])
    // ...
    ->indicateUsing(function (array $data): ?string {
        if (! $data['date']) {
            return null;
        }
 
        return 'Created at ' . Carbon::parse($data['date'])->toFormattedDateString();
    })

Multiple active indicators

You may even render multiple indicators at once, by returning an array of Indicator objects. If you have different fields associated with different indicators, you should set the field using the removeField() method on the Indicator object to ensure that the correct field is reset when the filter is removed:

use Filament\Forms\Components\DatePicker;
use Filament\Tables\Filters\Filter;
use Filament\Tables\Filters\Indicator;
 
Filter::make('created_at')
    ->form([
        DatePicker::make('from'),
        DatePicker::make('until'),
    ])
    // ...
    ->indicateUsing(function (array $data): array {
        $indicators = [];
 
        if ($data['from'] ?? null) {
            $indicators[] = Indicator::make('Created from ' . Carbon::parse($data['from'])->toFormattedDateString())
                ->removeField('from');
        }
 
        if ($data['until'] ?? null) {
            $indicators[] = Indicator::make('Created until ' . Carbon::parse($data['until'])->toFormattedDateString())
                ->removeField('until');
        }
 
        return $indicators;
    })

Positioning filters into grid columns

To change the number of columns that filters may occupy, you may use the filtersFormColumns() method:

use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ])
        ->filtersFormColumns(3);
}

Controlling the width of the filters dropdown

To customize the dropdown width, you may use the filtersFormWidth() method, and specify a width - xs, sm, md, lg, xl, 2xl, 3xl, 4xl, 5xl, 6xl, or 7xl. By default, the width is xs:

use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ])
        ->filtersFormWidth('4xl');
}

Controlling the maximum height of the filters dropdown

To add a maximum height to the filters' dropdown content, so that they scroll, you may use the filtersFormMaxHeight() method, passing a CSS length:

use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ])
        ->filtersFormMaxHeight('400px');
}

Displaying filters in a modal

To render the filters in a modal instead of in a dropdown, you may use:

use Filament\Tables\Enums\FiltersLayout;
use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ], layout: FiltersLayout::Modal);
}

You may use the trigger action API to customize the modal, including using a slideOver().

Displaying filters above the table content

To render the filters above the table content instead of in a dropdown, you may use:

use Filament\Tables\Enums\FiltersLayout;
use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ], layout: FiltersLayout::AboveContent);
}
Table with filters above content

Allowing filters above the table content to be collapsed

To allow the filters above the table content to be collapsed, you may use:

use Filament\Tables\Enums\FiltersLayout;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ], layout: FiltersLayout::AboveContentCollapsible);
}

Displaying filters below the table content

To render the filters below the table content instead of in a dropdown, you may use:

use Filament\Tables\Enums\FiltersLayout;
use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ], layout: FiltersLayout::BelowContent);
}
Table with filters below content

Persist filters in session

To persist the table filters in the user's session, use the persistFiltersInSession() method:

use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ])
        ->persistFiltersInSession();
}

Deselecting records when filters change

By default, all records will be deselected when the filters change. Using the deselectAllRecordsWhenFiltered(false) method, you can disable this behaviour:

use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ])
        ->deselectAllRecordsWhenFiltered(false);
}

Modifying the base query

By default, modifications to the Eloquent query performed in the query() method will be applied inside a scoped where() clause. This is to ensure that the query does not clash with any other filters that may be applied, especially those that use orWhere().

However, the downside of this is that the query() method cannot be used to modify the query in other ways, such as removing global scopes, since the base query needs to be modified directly, not the scoped query.

To modify the base query directly, you may use the baseQuery() method, passing a closure that receives the base query:

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\SoftDeletingScope;
use Filament\Tables\Filters\TernaryFilter;
 
TernaryFilter::make('trashed')
    // ...
    ->baseQuery(fn (Builder $query) => $query->withoutGlobalScopes([
        SoftDeletingScope::class,
    ]))

Customizing the filters trigger action

To customize the filters trigger buttons, you may use the filtersTriggerAction() method, passing a closure that returns an action. All methods that are available to customize action trigger buttons can be used:

use Filament\Tables\Actions\Action;
use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->filters([
            // ...
        ])
        ->filtersTriggerAction(
            fn (Action $action) => $action
                ->button()
                ->label('Filter'),
        );
}
Table with custom filters trigger action

Table filter utility injection

The vast majority of methods used to configure filters accept functions as parameters instead of hardcoded values:

use App\Models\Author;
use Filament\Tables\Filters\SelectFilter;
 
SelectFilter::make('author')
    ->options(fn (): array => Author::query()->pluck('name', 'id')->all())

This alone unlocks many customization possibilities.

The package is also able to inject many utilities to use inside these functions, as parameters. All customization methods that accept functions as arguments can inject utilities.

These injected utilities require specific parameter names to be used. Otherwise, Filament doesn't know what to inject.

Injecting the current filter instance

If you wish to access the current filter instance, define a $filter parameter:

use Filament\Tables\Filters\BaseFilter;
 
function (BaseFilter $filter) {
    // ...
}

Injecting the current Livewire component instance

If you wish to access the current Livewire component instance that the table belongs to, define a $livewire parameter:

use Filament\Tables\Contracts\HasTable;
 
function (HasTable $livewire) {
    // ...
}

Injecting the current table instance

If you wish to access the current table configuration instance that the filter belongs to, define a $table parameter:

use Filament\Tables\Table;
 
function (Table $table) {
    // ...
}

Injecting multiple utilities

The parameters are injected dynamically using reflection, so you are able to combine multiple parameters in any order:

use Filament\Tables\Contracts\HasTable;
use Filament\Tables\Table;
 
function (HasTable $livewire, Table $table) {
    // ...
}

Injecting dependencies from Laravel's container

You may inject anything from Laravel's container like normal, alongside utilities:

use Filament\Tables\Table;
use Illuminate\Http\Request;
 
function (Request $request, Table $table) {
    // ...
}
Edit on GitHub

Still need help? Join our Discord community or open a GitHub discussion

Next
Installation
Your logo here? 💖