catlabinteractive / laravel-table

v1.2.0 2026-08-31 09:41 UTC

Requires

• php: >=8.1
• catlabinteractive/charon: ^1.12
• laravel/framework: ^9.0 || ^10.0 || ^11.0 || ^12.0

Requires (Dev)

• orchestra/testbench: ^7.0 || ^8.0 || ^9.0 || ^10.0
• phpunit/phpunit: ^9.5.10 || ^10.5 || ^11.0 || ^12.0

MIT

• Thijs Van der Schaeghe

Published on Packagist.org on 2026-08-31 09:42 UTC

README

Renders a charon ResourceCollection as a Bootstrap table. Used by laravel-charon-frontend to build admin panels.

use CatLab\Laravel\Table\Table;

$table = (new Table($collection, $resourceDefinition, $context, $request->getRequestUri()))
    ->sortable()      // headers of ->sortable() fields link to ?sort=field / ?sort=!field
    ->filterable()    // a GET form with one input per ->filterable() field (select for enums)
    ->setResourceUrlResolver(function (RESTResource $related) {
        return '/admin/things/' . $related->getIdentifiers()->getValues()[0]->getValue(); // null suppresses the link
    })
    ->setResourceLabelResolver(function (RESTResource $related) {
        return $related->toArray()['uid'] ?? null; // null falls back to the default heuristic
    })
    ->modelAction(...)
    ->collectionAction(...);

echo $table->render();

Cells

Every visible property of a resource becomes a column; columns are the union over all rows, in first-seen order.

• Scalar fields render as-is.
• Relationships (expanded ChildValue / ChildrenValue) render as a comma separated list of related resources. Each is labelled by its name, title or label field when it has a non-empty one, otherwise by #<identifier>; override with setResourceLabelResolver(), which may return null for a resource it has no name for and leave that one to the default. When a url resolver is set and returns a url, the label becomes a link.
• Object / array fields render as JSON.

Sorting and filtering

Both are opt-in (sortable(), filterable()) and need the current url (4th constructor argument). They only build urls and forms; the actual sorting and filtering is done by charon when the resulting request reaches the API (?sort=name, ?sort=!name, ?name=value). Pagination parameters (page, before, after) are dropped from those urls; every other query parameter is preserved.

The filter form is a Bootstrap 3 form-inline bar (.table-filters): one small input group per filterable field with a humanized label (createdAt -> "Created at"), a search button and - when a filter is active - a "Clear" link back to the unfiltered url.

Views

Publish resources/views to resources/views/vendor/table to customise table, cell, filters and pagination.