Download the PHP package power-components/turbine without Composer

Turbine

The framework-agnostic data engine behind the Turbine table component.

It runs search, filters, sort, pagination, and row transformations over Eloquent, Query Builder, Collections, or Scout, and returns a typed JSON envelope. There is no Blade and no JavaScript in the box — feed Inertia (React / Vue), Livewire, REST APIs, or plain AJAX with the exact same engine.

You describe the grid once in PHP. The engine does the rest. Your front-end just renders JSON.

Contents

• Requirements & Install
• How it fits together
• Quickstart
• Portable Grid Definitions
• The Request Contract
• The Response Envelope
• Actions & Rules
• Filters
• Datasources
• Exporting Data
• State Persistence
• Reusing Components & Low-Level API
• Credits
• License

Requirements & Install

• PHP 8.3+
• Laravel 12 / 13 (illuminate/* components)

How it fits together

The front-end owns rendering and interaction; the core owns data and rules. State travels in the request; results travel in the envelope.

Quickstart

Describe your grid in PHP using the Turbine builder:

Builder reference

Portable Grid Definitions

The builder is fluent, but you can also describe a grid as a single framework-neutral class by extending GridDefinition. The same class drives an Inertia controller, a REST endpoint, or a Livewire PowerGrid component — write it once, switch front-ends without rewriting the grid.

Build fields and SetUp components with the static factories — Fields::make() and Turbine::header() / footer() / detail() / exportable($file) / cache() / filterBuilder() / responsive(). These are the same construction calls the Livewire PowerGrid facade exposes (PowerGrid::footer()), so a definition reads identically on both stacks.

Consume it from an Inertia controller:

Every builder option has a matching overridable method — datasource, fields, columns, filters, actions, actionRules, relationSearch, searchMorphs, transformQuery, setUp — plus the $tableName, $primaryKey, $perPage, $pageName properties. envelope($request), toArray($request), toResponse($request) and context($request) (for exporting) feed the request in for you. Only datasource() is required.

The class implements PowerComponents\Turbine\Contracts\GridSchema, the shared declaration surface both Turbine and Livewire PowerGrid understand.

Migrating between Livewire and Inertia? Keep the UsersGrid class untouched and swap only the adapter. Inertia calls ->envelope($request) (or ->toArray($request) for a plain array); a Livewire PowerGrid component points its definition() at the same class (see the PowerGrid README). Columns, fields, filters, actions and setUp are identical on both sides — the difference is purely the wiring.

The Request Contract

Grid state (search, sort, filters) is read from the turbine query parameter on the incoming request. Pagination uses the standard Laravel page parameter.

The Response Envelope

->envelope() returns a GridResponse DTO. ->toArray() returns a plain array. ->toResponse() wraps it in a JsonResponse. All properties are typed:

DTO classes

Every DTO implements JsonSerializable and exposes ->all() for array access.

Actions & Rules

Actions use the Button DSL and resolve on the server:

The ActionDescriptor resolves into the attributes bag:

Event types: link, dispatch, dispatchTo, dispatchSelf, modal, toggleDetail, call.

Conditional Rules

Apply server-side rules per row, button, or cell:

Supported rule target classes: RuleActions, RuleRows, RuleCheckbox, RuleRadio, RuleToggleable, RuleEditOnClick.

Filters

Turbine provides built-in filter components in PowerComponents\Turbine\Components\Filters\*:

Datasources

Pass any supported data source to datasource():

Custom Datasources

Implement DataSourceProcessor to handle custom APIs or repositories:

Exporting Data

Generate CSV or Excel (.xlsx) files directly from your grid context:

State Persistence

Save grid state (filters, sorting, column visibility) across requests:

Reusing Components & Low-Level API

Re-use an existing Turbine component as a data engine endpoint:

Or drop down to low-level context primitives:

Credits

Originally extracted from versions 6.x and 7.x of Livewire PowerGrid. Special thanks to all contributors!

License

MIT