Filters

Filters render as select dropdowns above the table. The selected value is applied to the query automatically.

Select Filter

A standard dropdown filter applied directly as a WHERE clause on the column matching $key:

$table->selectFilter(
    key: 'status',
    options: [
        'active' => 'Active',
        'inactive' => 'Inactive',
        'pending' => 'Pending',
    ],
);

Signature

selectFilter(
    string $key,
    array $options,
    ?string $label = null,
    ?string $defaultValue = null,
    bool $noFilterOption = true,
    ?string $noFilterOptionLabel = null,
): self

Parameters

Parameter	Type	Default	Description
`key`	`string`	-	Column name to filter on; also the query param key (`filter[key]`)
`options`	`array`	-	Associative array of `value => label`
`label`	`string\|null`	auto from key	Label shown above the dropdown
`defaultValue`	`string\|null`	`null`	Pre-selected value
`noFilterOption`	`bool`	`true`	Show a "show all" option at the top
`noFilterOptionLabel`	`string\|null`	`'-'`	Label for the "show all" option

Callback Filter

A filter where you control the WHERE logic via a callback. Useful for filters that don't map 1:1 to a column name:

$table->callbackFilter(
    key: 'verified',
    options: [
        '1' => 'Verified',
        '0' => 'Unverified',
    ],
    callback: function ($query, string $value) {
        $query->where('email_verified_at', $value === '1' ? '!=' : '=', null);
    },
);

Signature

callbackFilter(
    string $key,
    array $options,
    callable $callback,
    ?string $label = null,
    ?string $defaultValue = null,
    bool $noFilterOption = true,
    ?string $noFilterOptionLabel = null,
): self

The $callback receives:

$query - the Eloquent query builder
$value - the selected option value

Query Parameter

Active filters are stored as filter[key]=value:

?filter[status]=active&filter[verified]=1

For named tables: ?users_filter[status]=active.

Default Value

Pre-select a filter value on first load:

$table->selectFilter('status', ['active' => 'Active', 'inactive' => 'Inactive'], defaultValue: 'active');

Multiple Filters

Chain as many filters as needed:

$table
    ->selectFilter('status', ['active' => 'Active', 'inactive' => 'Inactive'])
    ->selectFilter('role', Role::pluck('name', 'id')->toArray())
    ->callbackFilter('has_orders', ['1' => 'Has orders', '0' => 'No orders'], function ($query, $value) {
        $value === '1'
            ? $query->has('orders')
            : $query->doesntHave('orders');
    });

Checking Filter State

$table->hasFilters();         // true if any filters are defined
$table->hasFiltersEnabled();  // true if any filter has an active value