Configuration

You can configure TableKit in two places:

• the config file, config/tablekit.php, for app-wide defaults;
• the plugin, TableKitPlugin::make(), per panel.

The plugin wins over the config file. Every option is optional. The favorites bar also works without the plugin (config only).

Publish the config file if you want to change it:

php artisan vendor:publish --tag=tablekit-config

Plugin options#

All options are optional. Options marked bool|Closure also accept a closure that returns a boolean. The chain below shows many options at once. Use only the ones you need. connection() is commented out because it throws an error when the connection you name does not exist.

use App\Models\User;
use TableKit\TableKitPlugin;

$panel->plugin(
    TableKitPlugin::make()
        ->favoritesBar()
        ->quickSaveSlideOver()
        ->colors(['primary', 'success', 'rose'])
        ->icons(['star', 'flag'])
        ->userModel(User::class)
        ->persistActiveViewInSession()
        // ->connection('reporting')   // only if a "reporting" connection exists in config/database.php
        ->maxViewsPerTable(100)
        ->viewManager(enabled: true, slideOver: false, position: 'end')
        ->presetViewsManageable(true)
        ->newPresetViewSortPosition('after')
        ->presetViewLockIcon(true)
        ->favoritesBarDivider(true)
        ->managedDefaultViews(false)
        ->createFromPresetWithQuery(false)
        ->multiSort(true, max: 5)
        ->quickFilters(false)
        ->limitIndicatorLabels(2)
        ->columnReordering(true)
);

Config file#

These keys are in config/tablekit.php.

Turn features off for one table#

Override a static method on the page, relation manager or widget that uses the trait. These methods can only turn a feature off for that table. They default to true, and the result is combined with the global setting: a feature runs only when both say yes. Returning true does not turn a feature on when the config or plugin has it off.

public static function multiSortTableViews(): bool
{
    return false;
}

public static function quickFiltersTableViews(): bool
{
    return false;
}

public static function columnOrderTableViews(): bool
{
    return false;
}

To use a feature on only some tables, turn it on globally and return false on the others.

Other hooks on the component#

Table-wide notes#

• Views are stored per user, per tenant (Filament::getTenant()) and per component class.
• ListRecords, relation managers and TableWidget already have everything TableKit needs.
• A custom Livewire component needs the table, actions and schemas contracts and traits (the example below).
• Without the actions contract and trait, Quick Save and the other modal actions fail with a "property not found" error.
• Declare InteractsWithTable before HasTableKit. This is advice: it has not been proven to matter, but the remembered-view restore is skipped when the table is not ready yet.

use Filament\Actions\Concerns\InteractsWithActions;
use Filament\Actions\Contracts\HasActions;
use Filament\Schemas\Concerns\InteractsWithSchemas;
use Filament\Schemas\Contracts\HasSchemas;
use Filament\Tables\Concerns\InteractsWithTable;
use Filament\Tables\Contracts\HasTable;
use Livewire\Component;
use TableKit\Concerns\HasTableKit;

class OrdersTable extends Component implements HasActions, HasSchemas, HasTable
{
    use InteractsWithActions;
    use InteractsWithSchemas;
    use InteractsWithTable;
    use HasTableKit;
}