Skip to content
InertiaX Docs

Defaults

Override these protected static properties in a Table subclass, or use the corresponding fluent method for one instance. A fluent override wins over the inherited class default.

For example, configure advanced filtering with:

use InertiaX\Table\Enums\FilterMode;
use InertiaX\Table\Table;


class UsersTable extends Table
{
    protected static FilterMode $defaultFilterMode = FilterMode::Advanced;
}

Child classes inherit this default and can override it with the same protected static property. UsersTable::make('users')->filterMode('basic') overrides it only for that use. An uninitialized static declaration falls back to the nearest initialized ancestor. Explicit false, 0, and a nullable default’s null are values, not missing declarations.

Table settings

Section titled “Table settings”
$defaultPageSize Link to $defaultPageSize
Type int
Default 10
Fluent method pageSize()
$defaultPageSizeOptions Link to $defaultPageSizeOptions
Type array
Default [10, 25, 50, 100]
Fluent method pageSizeOptions()
$defaultPagination Link to $defaultPagination
Type bool
Default true
Fluent method pagination()
$defaultSorting Link to $defaultSorting
Type bool
Default true
Fluent method sorting()
$defaultMultiSort Link to $defaultMultiSort
Type bool
Default true
Fluent method multiSort()
$defaultSelection Link to $defaultSelection
Type bool
Default false
Fluent method selection()
$defaultSelectionMode Link to $defaultSelectionMode
Type SelectionMode
Default SelectionMode::Multiple
Fluent method selectionMode()
$defaultAutoColumns Link to $defaultAutoColumns
Type bool
Default false
Fluent method autoColumns()
$defaultAutoColumnsExcept Link to $defaultAutoColumnsExcept
Type array
Default []
Fluent method autoColumns(except: [...])
$defaultAutoFilters Link to $defaultAutoFilters
Type bool
Default true
Fluent method autoFilters()
$defaultFilterMode Link to $defaultFilterMode
Type FilterMode
Default FilterMode::Basic
Fluent method filterMode()
$defaultRefreshButton Link to $defaultRefreshButton
Type bool
Default true
Fluent method refreshButton()
$defaultRowKey Link to $defaultRowKey
Type string
Default Uninitialized; inferred from source
Fluent method rowKey()

SelectionMode and FilterMode are in InertiaX\Table\Enums. For example, inside a subclass:

protected static int $defaultPageSize = 25;
protected static bool $defaultRefreshButton = false;

Column settings

Section titled “Column settings”

Explicit column options override these table-wide defaults.

$defaultSortableColumns Link to $defaultSortableColumns
Type bool
Default false
Fluent method sortableColumns()
$defaultSearchableColumns Link to $defaultSearchableColumns
Type bool
Default false
Fluent method searchableColumns()
$defaultFilterableColumns Link to $defaultFilterableColumns
Type bool
Default false
Fluent method filterableColumns()
$defaultCopyableColumns Link to $defaultCopyableColumns
Type bool
Default false
Fluent method copyableColumns()
$defaultToggleableColumns Link to $defaultToggleableColumns
Type bool
Default false
Fluent method toggleableColumns()
$defaultVisibleColumns Link to $defaultVisibleColumns
Type bool
Default true
Fluent method visibleColumns()
$defaultWrapColumns Link to $defaultWrapColumns
Type bool
Default false
Fluent method wrapColumns()
$defaultTruncateColumns Link to $defaultTruncateColumns
Type ?int
Default 0 (disabled)
Fluent method truncateColumns()

When true, $defaultSearchableColumns follows the table-wide search eligibility rules.

Laravel package configuration

Section titled “Laravel package configuration”

Standard setup needs no published configuration. To customize internal metadata caching:

Terminal window
php artisan vendor:publish --tag=inertiax-table-config

This creates config/inertiax-table.php. Its cache settings use the inertiax-table.cache configuration key:

enabled Link to enabled
Environment variable INERTIAX_TABLE_CACHE_ENABLED
Default true
store Link to store
Environment variable INERTIAX_TABLE_CACHE_STORE
Default Laravel’s default cache store
prefix Link to prefix
Environment variable INERTIAX_TABLE_CACHE_PREFIX
Default inertiax-table
ttl Link to ttl
Environment variable INERTIAX_TABLE_CACHE_TTL
Default 3600 seconds

cache.disable_in_local defaults to true, bypassing this cache in the local environment.

React settings

Section titled “React settings”

Search and filter requests share a 300 ms debounce. Set debounceMs on <AppTable> to override it. Unknown custom renderers use a diagnosed fallback unless the runtime’s diagnostics.fallback is 'error'. See Custom type diagnostics.

View Markdown