Skip to content

Table Settings

Pass arbitrary metadata from PHP to the frontend. The frontend can register hooks that react to specific settings keys.

Defining Settings

php
class ServerTable extends Table
{
    protected array $tableSettings = [
        'realtime' => [
            'channel' => 'servers',
            'events'  => ['ServerCreated', 'ServerUpdated', 'ServerDeleted'],
        ],
    ];
}

Dynamic Settings

php
ServerTable::make($project->servers())
    ->withSettings([
        'realtime' => [
            'channel' => "project.{$project->id}.servers",
        ],
    ])
    ->paginate();

withSettings() merges with existing class-level settings.

Frontend Consumption

See Hook System for how to register frontend hooks that respond to table settings.