Filters.md

Full Documentation

Filtering

You can extend the filter method to add some filtering to your query.

This example will add a basic search input to your table.

public string $searched = "";

public function filter(Builder $query): Builder
{
    return $query->when(
        !empty($this->searched ?? ''),
        fn ($q) => $q->where('name', 'like', "{$this->searched}%")
            ->orWhere('email', 'like', "{$this->searched}%")
    );
}

<input type="search" class="form-control"
       wire:model.debounce.300ms="searched"
       aria-label="Search"
       placeholder="Search by name or email"/>

Reset page on filtering

When a filter changes, it's usually recommended to reset the page number and return to the first table page.

This can be done in two ways:

The ResetPageOnUpdate trait:

This trait is included by default since v1.1.0 when you use the artisan make:wiretable command.

use \WireTable\Traits\ResetPageOnUpdate;

class RandomTable extends WireTable {
    use ResetPageOnUpdate;
    ...

This trait automatically listens for any updating hook and reset the page. This works as long as the only component properties using wire:model are used for filtering. If you have some binded properties that should not reset the page at every update, go for the second option.

Call resetPage() directly

Whenever you appy a different filter inside your table (e.g. when a property updates or when you submit a form), you can call $this->resetPage() directly.

public function updatingSearched() 
{
    $this->resetPage();
}

Persist filters

WireTable comes with a WithPersistence trait that will persist your filters in the Laravel session.

use WireTable\Traits\WithPersistence;
use WireTable\WireTable;

class LayoutTable extends WireTable
{
    use WithPersistence;

    protected array $persist = [
        'search',
        'role',
    ];
    
    public string $search = '';
    public string $role = 'default-value';
    
    ...
}

By default, wire-table will use the table namespace as the session data key. You can force a custom session key by overriding the sessionKey property:

public string $sessionKey = "custom:session:key"

You can also clear the filters with the clearPersistence method.