imer/laravel-query-table

Laravel plugin for displaying query results as a table with built-in filtering/sorting/pagination

dev-master 2023-06-29 03:50 UTC

Requires

• php: >=8.0.0
• illuminate/http: ^6|^7|^8|^9|^10
• illuminate/support: ^6|^7|^8|^9|^10

MIT

• Robin Rolf

• log
• logging

README

A laravel plugin for displaying query results as a table with built-in filtering/sorting/pagination. Views use bootstrap and font-awesome, but can be published and modified via php artisan vendor:publish --provider="imer\QueryTable\QueryTableProvider" command While this package is still in early stages the api might still change for better usability

Example:

use imer\QueryTable;
use imer\QueryTable\HtmlString;

// ...

$countries = ["de" => "Germany", "gb" => "United Kingdom", "us" => "United States"];
$customers = (new QueryTable($request, Customer::query()))
    ->addField(
        (new QueryTable\Field("customer_number"))
            ->sortable()
            ->filter(new QueryTable\TextFilter())
            ->formatAsLink(function (Customer $r) {
                return route("customer.show", ["id" => $r->id]);
            })
    )
    ->addField(
        (new QueryTable\Field("company"))
            ->sortable()
            ->filter(new QueryTable\TextFilter())
    )
    ->addField((new QueryTable\Field("name"))->sortable()->filter(new QueryTable\TextFilter()))
    ->addField((new QueryTable\Field("email"))->sortable()->filter(new QueryTable\TextFilter()))
    ->addField(
    // Filter by yes/no
        (new QueryTable\Field("tax_exempt"))
            ->sortable()
            ->filter(new QueryTable\BoolFilter())
            ->formatter(function ($v) {
                return $v ? trans("misc.yes") : trans("misc.no");
            })
    )
    ->addField(
    // Country field with a dropdown filter
        (new QueryTable\Field("country"))
            ->sortable()
            ->filter(new QueryTable\DropdownFilter($countries))
            ->formatter(function ($v) use ($countries) {
                return $countries[$v] ?? "n/a";
            })
    )
    ->addField((new QueryTable\ViewField("customer._table_actions"))
        ->nameText(new HtmlString('<a href="' . e(route("customer.create")). '" class="btn btn-success"><i class="fa fa-plus"></i></a>')));

// pass $customers to your view and simply output the table:
// {!! $customers !!}

Turns into:

Filter demo: https://github.com/imerr/laravel-query-table/assets/1426904/000197cf-09ff-41bc-acf6-eb01bd1a98e8