Download the PHP package humweb/inertia-table without Composer

Inertia Table

Server-driven data tables for Laravel + Inertia.js + Vue 3. Define your columns, filters, sorts, and search on the backend — the frontend renders it all automatically with per-table partial reloads.

Installation

Publish the config (optional):

Quick Start

1. Define a Resource

A Resource declares your table's columns, filters, model, and query behavior:

2. Use in a Controller

Single table

Multiple tables on one page

Each table is a lazy closure, so when the frontend does a partial reload targeting one table (e.g. only: ['tables.members']), only that table's query runs — the other stays untouched.

3. Frontend (Vue 3)

Single table

Multiple tables

Using the composable directly

Backend API

Resource

Extend Humweb\Table\Resource to define a table. Required methods:

Key properties:

Custom parameter filters

Define filter{StudlyKey}($value) methods on your resource. Parameters set via addParameter() auto-dispatch to these methods:

Custom global search

Override globalFilter() to replace the default OR-across-searchable-fields behavior:

Runtime transforms

Fields

All fields extend Humweb\Table\Fields\Field and use the make() static constructor.

Available field types

Field modifiers

Filters

All filters extend Humweb\Table\Filters\Filter.

Filter modifiers

Sort Strategies

Sorts implement Humweb\Table\Sorts\Sort and are passed to ->sortable():

Collection sorts (client-side on server)

For sorts that require fetching all records and sorting in PHP (e.g. computed values):

Query Pipeline

The Resource builds queries through a QueryPipeline of discrete QueryStage objects. The default pipeline runs these stages in order:

1. ApplyEagerLoads — $with relationships
2. ApplyDefaultSort — fallback sort when no ?sort= param
3. ApplySorts — user-requested sort from ?sort= param
4. ApplyGlobalSearch — ?search[global]= (OR across searchable fields)
5. ApplyCustomFilters — parameter-based filter*() methods
6. ApplySearch — per-column ?search[name]=
7. ApplyFilters — FilterCollection application from ?filters[status]=

Customizing the pipeline

Override pipeline() in your resource to add, replace, or reorder stages:

Creating custom stages

Implement QueryStage:

TableRequest

TableRequest wraps the HTTP request with table-key awareness. For the default key, params are unprefixed (?sort=name). For named keys, params are prefixed (?members.sort=name).

Multi-Table Response Macro

The ->table() macro on Inertia\Response supports two signatures:

Each table is registered as a lazy closure. On the initial page visit both resolve. On partial reloads (e.g. sorting/filtering), Inertia's only parameter ensures only the targeted table re-evaluates.

Frontend API

All frontend code lives in resources/js/components/Table/v2/.

useTable(key?, options?)

The core composable. Call it with a table key to bind to a specific table's data from the Inertia page props.

Options

Return value

Methods

<DataTable> Component

The main component. Initializes useTable and provides it to child components via provide('table').

Props

Slots

Sub-components

All sub-components inject useTable via inject('table') and can be used standalone:

Imports

Configuration

Testing

Changelog

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

Credits

• ryun
• All Contributors

License

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