Search by

javaabu / filters

dash8xjavaabun4ff4h

Filters and sorts for Laravel index pages: define each filter once, apply it to the query from the URL, and render the filter bar, applied-filter chips and sort controls in Blade (javaabu/forms) or Inertia React (@javaabu/forms) through javaabu/stencil.

Package info

github.com/Javaabu/filters

pkg:composer/javaabu/filters

Statistics

Installs: 0

Dependents: 2

Suggesters: 1

Stars: 0

Open Issues: 2

dev-main / 1.x-dev 2026-11-10 09:59 UTC

This package is auto-updated.

Last update: 2026-11-15 10:51:38 UTC


README

Tests codecov Latest Version on Packagist License: MIT

Filters and sorts for Laravel index pages. Define each filter once: how it renders (with javaabu/stencil fields) and how it applies to the query. The filter state lives in the URL, and the filter bar, applied-filter chips and sort controls render in Blade (javaabu/forms) or Inertia React (@javaabu/forms).

class ArticleFilters extends Filters
{
    protected ?string $model = Article::class;

    protected ?string $default_sort = 'published_at';

    protected string $default_direction = 'desc';

    protected function filters(): array
    {
        return [
            TextFilter::make('search')->columns(['title', 'author.name'])->thaana(),
            SelectFilter::make('status')->options(ArticleStatuses::class)->multiple(),
            SelectFilter::make('category_id')->relationship('category', 'name'),
            DateRangeFilter::make('published_at'),
            TrashedFilter::make(),
        ];
    }

    protected function sorts(): array
    {
        return [Sort::make('title'), Sort::make('published_at')->defaultDirection('desc')];
    }
}
$filters = ArticleFilters::make();                                     // reads the query string
$articles = $filters->apply(Article::query())->paginate()->withQueryString();
{{ $filters }}                                                         {{-- the filter bar and chips --}}
<x-filters::heading :filters="$filters" sort="title" />               {{-- a sortable column --}}
<FilterBar filters={filters} />                                        // Inertia::render('Articles/Index', ['filters' => $filters])
<SortableHeading filters={filters} sort="title" />

The URL holds the state in the flat parameters javaabu/forms already uses (?search=ރާއްޖެ&status[]=draft&orderby=title&order=DESC), and values that aren't allowed are ignored.

Documentation

You'll find the documentation on https://docs.javaabu.com/filters, and in the docs folder.

AI coding assistants can start from llms.txt. The package ships a Laravel Boost skill and guideline, which Boost finds by itself. See AI assistants.

Testing

composer test
pnpm test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email info@javaabu.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.