公告: 旧版文档请移步 -> http://v2.laravel-filament.cn/docs
DOCS
DOCS

Languages

Version

Theme

Table Builder - Filters

Query builder

Overview

The query builder allows you to define a complex set of conditions to filter the data in your table. It is able to handle unlimited nesting of conditions, which you can group together with "and" and "or" operations.

To use it, you need to define a set of "constraints" that will be used to filter the data. Filament includes some built-in constraints, that follow common data types, but you can also define your own custom constraints.

You can add a query builder to any table using the QueryBuilder filter:

use Filament\Tables\Filters\QueryBuilder;
use Filament\Tables\Filters\QueryBuilder\Constraints\BooleanConstraint;
use Filament\Tables\Filters\QueryBuilder\Constraints\DateConstraint;
use Filament\Tables\Filters\QueryBuilder\Constraints\NumberConstraint;
use Filament\Tables\Filters\QueryBuilder\Constraints\RelationshipConstraint;
use Filament\Tables\Filters\QueryBuilder\Constraints\RelationshipConstraint\Operators\IsRelatedToOperator;
use Filament\Tables\Filters\QueryBuilder\Constraints\SelectConstraint;
use Filament\Tables\Filters\QueryBuilder\Constraints\TextConstraint;
 
QueryBuilder::make()
    ->constraints([
        TextConstraint::make('name'),
        BooleanConstraint::make('is_visible'),
        NumberConstraint::make('stock'),
        SelectConstraint::make('status')
            ->options([
                'draft' => 'Draft',
                'reviewing' => 'Reviewing',
                'published' => 'Published',
            ])
            ->multiple(),
        DateConstraint::make('created_at'),
        RelationshipConstraint::make('categories')
            ->multiple()
            ->selectable(
                IsRelatedToOperator::make()
                    ->titleAttribute('name')
                    ->searchable()
                    ->multiple(),
            ),
        NumberConstraint::make('reviewsRating')
            ->relationship('reviews', 'rating')
            ->integer(),
    ])

When deeply nesting the query builder, you might need to increase the amount of space that the filters can consume. One way of doing this is to position the filters above the table content:

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

Available constraints

Filament ships with many different constraints that you can use out of the box. You can also create your own custom constraints:

Text constraints

Text constraints allow you to filter text fields. They can be used to filter any text field, including via relationships.

use Filament\Tables\Filters\QueryBuilder\Constraints\TextConstraint;
 
TextConstraint::make('name') // Filter the `name` column
 
TextConstraint::make('creatorName')
    ->relationship(name: 'creator', titleAttribute: 'name') // Filter the `name` column on the `creator` relationship

By default, the following operators are available:

  • Contains - filters a column to contain the search term
  • Does not contain - filters a column to not contain the search term
  • Starts with - filters a column to start with the search term
  • Does not start with - filters a column to not start with the search term
  • Ends with - filters a column to end with the search term
  • Does not end with - filters a column to not end with the search term
  • Equals - filters a column to equal the search term
  • Does not equal - filters a column to not equal the search term
  • Is filled - filters a column to not be empty
  • Is blank - filters a column to be empty

Boolean constraints

Boolean constraints allow you to filter boolean fields. They can be used to filter any boolean field, including via relationships.

use Filament\Tables\Filters\QueryBuilder\Constraints\BooleanConstraint;
 
BooleanConstraint::make('is_visible') // Filter the `is_visible` column
 
BooleanConstraint::make('creatorIsAdmin')
    ->relationship(name: 'creator', titleAttribute: 'is_admin') // Filter the `is_admin` column on the `creator` relationship

By default, the following operators are available:

  • Is true - filters a column to be true
  • Is false - filters a column to be false

Number constraints

Number constraints allow you to filter numeric fields. They can be used to filter any numeric field, including via relationships.

use Filament\Tables\Filters\QueryBuilder\Constraints\NumberConstraint;
 
NumberConstraint::make('stock') // Filter the `stock` column
 
NumberConstraint::make('ordersItemCount')
    ->relationship(name: 'orders', titleAttribute: 'item_count') // Filter the `item_count` column on the `orders` relationship

By default, the following operators are available:

  • Is minimum - filters a column to be greater than or equal to the search number
  • Is less than - filters a column to be less than the search number
  • Is maximum - filters a column to be less than or equal to the search number
  • Is greater than - filters a column to be greater than the search number
  • Equals - filters a column to equal the search number
  • Does not equal - filters a column to not equal the search number
  • Is filled - filters a column to not be empty
  • Is blank - filters a column to be empty

When using relationship() with a number constraint, users also have the ability to "aggregate" related records. This means that they can filter the column to be the sum, average, minimum or maximum of all the related records at once.

Integer constraints

By default, number constraints will allow decimal values. If you'd like to only allow integer values, you can use the integer() method:

use Filament\Tables\Filters\QueryBuilder\Constraints\NumberConstraint;
 
NumberConstraint::make('stock')
    ->integer()

Date constraints

Date constraints allow you to filter date fields. They can be used to filter any date field, including via relationships.

use Filament\Tables\Filters\QueryBuilder\Constraints\DateConstraint;
 
DateConstraint::make('created_at') // Filter the `created_at` column
 
DateConstraint::make('creatorCreatedAt')
    ->relationship(name: 'creator', titleAttribute: 'created_at') // Filter the `created_at` column on the `creator` relationship

By default, the following operators are available:

  • Is after - filters a column to be after the search date
  • Is not after - filters a column to not be after the search date, or to be the same date
  • Is before - filters a column to be before the search date
  • Is not before - filters a column to not be before the search date, or to be the same date
  • Is date - filters a column to be the same date as the search date
  • Is not date - filters a column to not be the same date as the search date
  • Is month - filters a column to be in the same month as the selected month
  • Is not month - filters a column to not be in the same month as the selected month
  • Is year - filters a column to be in the same year as the searched year
  • Is not year - filters a column to not be in the same year as the searched year

Select constraints

Select constraints allow you to filter fields using a select field. They can be used to filter any field, including via relationships.

use Filament\Tables\Filters\QueryBuilder\Constraints\SelectConstraint;
 
SelectConstraint::make('status') // Filter the `status` column
    ->options([
        'draft' => 'Draft',
        'reviewing' => 'Reviewing',
        'published' => 'Published',
    ])
    
SelectConstraint::make('creatorStatus')
    ->relationship(name: 'creator', titleAttribute: 'department') // Filter the `department` column on the `creator` relationship
    ->options([
        'sales' => 'Sales',
        'marketing' => 'Marketing',
        'engineering' => 'Engineering',
        'purchasing' => 'Purchasing',
    ])

Searchable select constraints

By default, select constraints will not allow the user to search the options. If you'd like to allow the user to search the options, you can use the searchable() method:

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

Multi-select constraints

By default, select constraints will only allow the user to select a single option. If you'd like to allow the user to select multiple options, you can use the multiple() method:

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

When the user selects multiple options, the table will be filtered to show records that match any of the selected options.

Relationship constraints

Relationship constraints allow you to filter fields using data about a relationship:

use Filament\Tables\Filters\QueryBuilder\Constraints\RelationshipConstraint;
use Filament\Tables\Filters\QueryBuilder\Constraints\RelationshipConstraint\Operators\IsRelatedToOperator;
 
RelationshipConstraint::make('creator') // Filter the `creator` relationship
    ->selectable(
        IsRelatedToOperator::make()
            ->titleAttribute('name')
            ->searchable()
            ->multiple(),
    )

The IsRelatedToOperator is used to configure the "Is / Contains" and "Is not / Does not contain" operators. It provides a select field which allows the user to filter the relationship by which records are attached to it. The titleAttribute() method is used to specify which attribute should be used to identify each related record in the list. The searchable() method makes the list searchable. The multiple() method allows the user to select multiple related records, and if they do, the table will be filtered to show records that match any of the selected related records.

Multiple relationships

By default, relationship constraints only include operators that are appropriate for filtering a singular relationship, like a BelongsTo. If you have a relationship such as a HasMany or BelongsToMany, you may wish to mark the constraint as multiple():

use Filament\Tables\Filters\QueryBuilder\Constraints\RelationshipConstraint;
 
RelationshipConstraint::make('categories')
    ->multiple()

This will add the following operators to the constraint:

  • Has minimum - filters a column to have at least the specified number of related records
  • Has less than - filters a column to have less than the specified number of related records
  • Has maximum - filters a column to have at most the specified number of related records
  • Has more than - filters a column to have more than the specified number of related records
  • Has - filters a column to have the specified number of related records
  • Does not have - filters a column to not have the specified number of related records

Empty relationship constraints

The RelationshipConstraint does not support nullable() in the same way as other constraints.

If the relationship is multiple(), then the constraint will show an option to filter out "empty" relationships. This means that the relationship has no related records. If your relationship is singular, then you can use the emptyable() method to show an option to filter out "empty" relationships:

use Filament\Tables\Filters\QueryBuilder\Constraints\RelationshipConstraint;
 
RelationshipConstraint::make('creator')
    ->emptyable()

If you have a multiple() relationship that must always have at least 1 related record, then you can use the emptyable(false) method to hide the option to filter out "empty" relationships:

use Filament\Tables\Filters\QueryBuilder\Constraints\RelationshipConstraint;
 
RelationshipConstraint::make('categories')
    ->emptyable(false)

Nullable constraints

By default, constraints will not show an option to filter null values. If you'd like to show an option to filter null values, you can use the nullable() method:

use Filament\Tables\Filters\QueryBuilder\Constraints\TextConstraint;
 
TextConstraint::make('name')
    ->nullable()

Now, the following operators are also available:

  • Is filled - filters a column to not be empty
  • Is blank - filters a column to be empty

Scoping relationships

When you use the relationship() method on a constraint, you can scope the relationship to filter the related records using the modifyQueryUsing argument:

use Filament\Tables\Filters\QueryBuilder\Constraints\TextConstraint;
use Illuminate\Database\Eloquent\Builder;
 
TextConstraint::make('adminCreatorName')
    ->relationship(
        name: 'creator',
        titleAttribute: 'name',
        modifyQueryUsing: fn (Builder $query) => $query->where('is_admin', true),
    )

Customizing the constraint icon

Each constraint type has a default icon, which is displayed next to the label in the picker. You can customize the icon for a constraint by passing its name to the icon() method:

use Filament\Tables\Filters\QueryBuilder\Constraints\TextConstraint;
 
TextConstraint::make('author')
    ->relationship(name: 'author', titleAttribute: 'name')
    ->icon('heroicon-m-user')

Overriding the default operators

Each constraint type has a set of default operators, which you can customize by using the operators()method:

use Filament\Tables\Filters\QueryBuilder\Constraints\Operators\IsFilledOperator;
use Filament\Tables\Filters\QueryBuilder\Constraints\TextConstraint;
 
TextConstraint::make('author')
    ->relationship(name: 'author', titleAttribute: 'name')
    ->operators([
        IsFilledOperator::make(),
    ])

This will remove all operators, and register the EqualsOperator.

If you'd like to add an operator to the end of the list, use pushOperators() instead:

use Filament\Tables\Filters\QueryBuilder\Constraints\Operators\IsFilledOperator;
use Filament\Tables\Filters\QueryBuilder\Constraints\TextConstraint;
 
TextConstraint::make('author')
    ->relationship(name: 'author', titleAttribute: 'name')
    ->pushOperators([
        IsFilledOperator::class,
    ])

If you'd like to add an operator to the start of the list, use unshiftOperators() instead:

use Filament\Tables\Filters\QueryBuilder\Constraints\Operators\IsFilledOperator;
use Filament\Tables\Filters\QueryBuilder\Constraints\TextConstraint;
 
TextConstraint::make('author')
    ->relationship(name: 'author', titleAttribute: 'name')
    ->unshiftOperators([
        IsFilledOperator::class,
    ])

Creating custom constraints

Custom constraints can be created "inline" with other constraints using the Constraint::make() method. You should also pass an icon to the icon() method:

use Filament\Tables\Filters\QueryBuilder\Constraints\Constraint;
 
Constraint::make('subscribed')
    ->icon('heroicon-m-bell')
    ->operators([
        // ...
    ]),

If you want to customize the label of the constraint, you can use the label() method:

use Filament\Tables\Filters\QueryBuilder\Constraints\Constraint;
 
Constraint::make('subscribed')
    ->label('Subscribed to updates')
    ->icon('heroicon-m-bell')
    ->operators([
        // ...
    ]),

Now, you must define operators for the constraint. These are options that you can pick from to filter the column. If the column is nullable, you can also register that built-in operator for your custom constraint:

use Filament\Tables\Filters\QueryBuilder\Constraints\Constraint;
use Filament\Tables\Filters\QueryBuilder\Constraints\Operators\IsFilledOperator;
 
Constraint::make('subscribed')
    ->label('Subscribed to updates')
    ->icon('heroicon-m-bell')
    ->operators([
        // ...
        IsFilledOperator::class,
    ]),

Creating custom operators

Custom operators can be created using the Operator::make() method:

use Filament\Tables\Filters\QueryBuilder\Constraints\Operators\Operator;
 
Operator::make('subscribed')
    ->label(fn (bool $isInverse): string => $isInverse ? 'Not subscribed' : 'Subscribed')
    ->summary(fn (bool $isInverse): string => $isInverse ? 'You are not subscribed' : 'You are subscribed')
    ->baseQuery(fn (Builder $query, bool $isInverse) => $query->{$isInverse ? 'whereDoesntHave' : 'whereHas'}(
        'subscriptions.user',
        fn (Builder $query) => $query->whereKey(auth()->user()),
    )),

In this example, the operator is able to filter records based on whether or not the authenticated user is subscribed to the record. A subscription is recorded in the subscriptions relationship of the table.

The baseQuery() method is used to define the query that will be used to filter the records. The $isInverse argument is false when the "Subscribed" option is selected, and true when the "Not subscribed" option is selected. The function is applied to the base query of the table, where whereHas() can be used. If your function does not need to be applied to the base query of the table, like when you are using a simple where() or whereIn(), you can use the query() method instead, which has the bonus of being able to be used inside nested "OR" groups.

The label() method is used to render the options in the operator select. Two options are registered for each operator, one for when the operator is not inverted, and one for when it is inverted.

The summary() method is used in the header of the constraint when it is applied to the query, to provide an overview of the active constraint.

Customizing the constraint picker

Changing the number of columns in the constraint picker

The constraint picker has only 1 column. You may customize it by passing a number of columns to constraintPickerColumns():

use Filament\Tables\Filters\QueryBuilder;
 
QueryBuilder::make()
    ->constraintPickerColumns(2)
    ->constraints([
        // ...
    ])

This method can be used in a couple of different ways:

  • You can pass an integer like constraintPickerColumns(2). This integer is the number of columns used on the lg breakpoint and higher. All smaller devices will have just 1 column.
  • You can pass an array, where the key is the breakpoint and the value is the number of columns. For example, constraintPickerColumns(['md' => 2, 'xl' => 4]) will create a 2 column layout on medium devices, and a 4 column layout on extra large devices. The default breakpoint for smaller devices uses 1 column, unless you use a default array key.

Breakpoints (sm, md, lg, xl, 2xl) are defined by Tailwind, and can be found in the Tailwind documentation.

Increasing the width of the constraint picker

When you increase the number of columns, the width of the dropdown should increase incrementally to handle the additional columns. If you'd like more control, you can manually set a maximum width for the dropdown using the constraintPickerWidth() method. Options correspond to Tailwind's max-width scale. The options are xs, sm, md, lg, xl, 2xl, 3xl, 4xl, 5xl, 6xl, 7xl:

use Filament\Tables\Filters\QueryBuilder;
 
QueryBuilder::make()
    ->constraintPickerColumns(3)
    ->constraintPickerWidth('2xl')
    ->constraints([
        // ...
    ])
Edit on GitHub

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

上一页
Ternary filters
下一页
Custom filters