class Table extends ViewComponent (View source)

Traits

Constants

LOADING_TARGETS

Properties

protected string $evaluationIdentifier
static protected Closure>> $macros from  Macroable
protected string $view
protected string|Closure|null $defaultView from  ViewComponent
protected array<string,mixed> $viewData from  ViewComponent
protected string $viewIdentifier
protected HasTable $livewire from  BelongsToLivewire
protected bool|Closure $isStriped from  CanBeStriped
protected bool|Closure $isLoadingDeferred from  CanDeferLoading
protected Group|null $defaultGroup from  CanGroupRecords
protected Group> $cachedGroups from  CanGroupRecords
protected array|Closure $groups from  CanGroupRecords
protected bool|Closure $isGroupsOnly from  CanGroupRecords
protected bool|Closure $areGroupingSettingsInDropdownOnDesktop from  CanGroupRecords
protected bool|Closure $areGroupingSettingsHidden from  CanGroupRecords
protected bool|Closure $isGroupingDirectionSettingHidden from  CanGroupRecords
protected Closure|null $modifyGroupRecordsTriggerActionUsing from  CanGroupRecords
protected int|string|Closure|null $defaultPaginationPageOption from  CanPaginateRecords
protected bool|Closure $isPaginated from  CanPaginateRecords
protected bool|Closure $isPaginatedWhileReordering from  CanPaginateRecords
protected array|Closure|null $paginationPageOptions from  CanPaginateRecords
$hasExtremePaginationLinks from  CanPaginateRecords
protected string|Closure|null $pollingInterval from  CanPollRecords
protected int|Closure $reorderAnimationDuration from  HasReorderAnimationDuration
protected bool|Closure $isReorderable from  CanReorderRecords
protected bool|Closure $isReorderAuthorized from  CanReorderRecords
protected string|Closure|null $reorderColumn from  CanReorderRecords
protected Closure|null $modifyReorderRecordsTriggerActionUsing from  CanReorderRecords
protected bool|null $isSearchable from  CanSearchRecords
protected bool|Closure|null $persistsSearchInSession from  CanSearchRecords
protected bool|Closure|null $persistsColumnSearchesInSession from  CanSearchRecords
protected string|Closure|null $searchPlaceholder from  CanSearchRecords
protected string|null $searchDebounce from  CanSearchRecords
protected bool|Closure $isSearchOnBlur from  CanSearchRecords
protected string|Closure|null $defaultSort from  CanSortRecords
protected string|Closure|null $defaultSortDirection from  CanSortRecords
protected bool|Closure|null $persistsSortInSession from  CanSortRecords
protected Htmlable|Closure|null $defaultSortOptionLabel from  CanSortRecords
protected bool $hasSummary from  CanSummarizeRecords
protected int $columnToggleFormColumns from  CanToggleColumns
protected string|Closure|null $columnToggleFormMaxHeight from  CanToggleColumns
protected MaxWidth|string|Closure|null $columnToggleFormWidth from  CanToggleColumns
protected Closure|null $modifyToggleColumnsTriggerActionUsing from  CanToggleColumns
protected array $actions from  HasActions
protected Action> $flatActions from  HasActions
protected Htmlable|Closure|null $actionsColumnLabel from  HasActions
protected string|Closure|null $actionsAlignment from  HasActions
protected ActionsPosition|Closure|null $actionsPosition from  HasActions
protected array $bulkActions from  HasBulkActions
protected BulkAction> $flatBulkActions from  HasBulkActions
protected Closure|null $checkIfRecordIsSelectableUsing from  HasBulkActions
protected bool|Closure|null $selectsCurrentPageOnly from  HasBulkActions
protected RecordCheckboxPosition|Closure|null $recordCheckboxPosition from  HasBulkActions
protected bool|Closure|null $isSelectable from  HasBulkActions
protected Column> $columns from  HasColumns
protected array $columnsLayout from  HasColumns
protected Component|null $collapsibleColumnsLayout from  HasColumns
protected bool $hasColumnGroups from  HasColumns
protected bool $hasColumnsLayout from  HasColumns
protected Htmlable|Closure|null $content from  HasContent
protected Htmlable|Closure|null $contentFooter from  HasContent
protected array|Closure|null $contentGrid from  HasContent
protected Htmlable|Closure|null $emptyState from  HasEmptyState
protected Htmlable|Closure|null $emptyStateDescription from  HasEmptyState
protected Htmlable|Closure|null $emptyStateHeading from  HasEmptyState
protected string|Closure|null $emptyStateIcon from  HasEmptyState
protected array $emptyStateActions from  HasEmptyState
protected bool|Closure $areFilterIndicatorsHidden from  HasFilterIndicators
protected BaseFilter> $filters from  HasFilters
protected Closure|null $filtersFormSchema from  HasFilters
protected int $filtersFormColumns from  HasFilters
protected string|Closure|null $filtersFormMaxHeight from  HasFilters
protected MaxWidth|string|Closure|null $filtersFormWidth from  HasFilters
protected FiltersLayout|Closure|null $filtersLayout from  HasFilters
protected Closure|null $modifyFiltersTriggerActionUsing from  HasFilters
protected bool|Closure|null $persistsFiltersInSession from  HasFilters
protected bool|Closure $shouldDeselectAllRecordsWhenFiltered from  HasFilters
protected bool|Closure $hasDeferredFilters from  HasFilters
protected Closure|null $modifyFiltersApplyActionUsing from  HasFilters
protected Htmlable|Closure|null $heading from  HasHeader
protected Htmlable|Closure|null $header from  HasHeader
protected Htmlable|Closure|null $description from  HasHeader
protected array $headerActions from  HasHeaderActions
protected HeaderActionsPosition|Closure|null $headerActionsPosition from  HasHeaderActions
protected Builder|Closure|null $query from  HasQuery
protected string|Closure|null $inverseRelationship from  HasQuery
protected Closure|null $getRelationshipUsing from  HasQuery
protected Closure[] $queryScopes from  HasQuery
protected string|Closure|null $queryStringIdentifier from  HasQueryStringIdentifier
protected string|Closure|null $recordAction from  HasRecordAction
protected array|string|Closure|null $recordClasses from  HasRecordClasses
protected bool|Closure $allowsDuplicates from  HasRecords
protected string|Closure|null $modelLabel from  HasRecords
protected string|Closure|null $pluralModelLabel from  HasRecords
protected string|Closure|null $recordTitle from  HasRecords
protected string|Closure|null $recordTitleAttribute from  HasRecords
protected bool|Closure $shouldOpenRecordUrlInNewTab from  HasRecordUrl
protected string|Closure|null $recordUrl from  HasRecordUrl
static string $defaultCurrency
static string $defaultDateDisplayFormat
static string $defaultDateTimeDisplayFormat
static string|null $defaultNumberLocale
static string $defaultTimeDisplayFormat

Methods

static mixed
configureUsing(Closure $modifyUsing, Closure|null $during = null, bool $isImportant = false)

No description

configure()

No description

void
setUp()

No description

mixed
evaluate(mixed $value, array $namedInjections = [], array $typedInjections = [])

No description

mixed
resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

array
resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

array
resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

string|null
static void
macro(string $name, callable $macro)

No description

static void
mixin(object $mixin, bool $replace = true)

No description

static void
flushMacros()

No description

static mixed
__callStatic(string $method, array $parameters)

No description

mixed
__call(string $method, array $parameters)

No description

static callable|null
getMacro(string $method)

No description

view(string|null $view, array $viewData = [])

No description

defaultView(string|Closure|null $view)

No description

array
extractPublicMethods()

No description

viewData(array $data)

No description

string
getView()

No description

string|null
getDefaultView()

No description

string
toHtml()

No description

View
render()

No description

livewire(HasTable $livewire)

No description

getLivewire()

No description

TranslatableContentDriver|null
striped(bool|Closure $condition = true)

No description

bool
isStriped()

No description

deferLoading(bool|Closure $condition = true)

No description

bool
isLoadingDeferred()

No description

bool
isLoaded()

No description

groupRecordsTriggerAction(Closure|null $callback)

No description

groupingSettingsInDropdownOnDesktop(bool|Closure $condition = true)

No description

groupsInDropdownOnDesktop(bool|Closure $condition = true) deprecated

No description

groupingSettingsHidden(bool|Closure $condition = true)

No description

groupingDirectionSettingHidden(bool|Closure $condition = true)

No description

defaultGroup(Group|null $group)

No description

groups(array|Closure $groups)

No description

groupsOnly(bool|Closure $condition = true)

No description

bool
isDefaultGroupSelectable()

No description

bool
areGroupingSettingsHidden()

No description

Group|null
getDefaultGroup()

No description

array
getGroups()

No description

Group|null
getGroup(string $id)

No description

Group|null
getGrouping()

No description

bool
isGroupsOnly()

No description

defaultPaginationPageOption(int|string|Closure|null $option)

No description

paginated(bool|array|Closure $condition = true)

No description

paginatedWhileReordering(bool|Closure $condition = true)

No description

paginationPageOptions(array|Closure|null $options)

No description

extremePaginationLinks(bool|Closure $condition = true)

No description

int|string|null
array
getPaginationPageOptions()

No description

bool
isPaginated()

No description

bool
isPaginatedWhileReordering()

No description

bool
hasExtremePaginationLinks()

No description

poll(string|Closure|null $interval = '10s')

No description

string|null
getPollingInterval()

No description

reorderable(string|Closure|null $column = null, bool|Closure|null $condition = null)

No description

authorizeReorder(bool|Closure $condition = true)

No description

getReorderRecordsTriggerAction(bool $isReordering)

No description

string|null
getReorderColumn()

No description

bool
isReorderable()

No description

bool
isReordering()

No description

bool
isReorderAuthorized()

No description

persistSearchInSession(bool|Closure $condition = true)

No description

persistColumnSearchesInSession(bool|Closure $condition = true)

No description

searchable(bool|null $condition = true)

No description

searchDebounce(string|null $debounce)

No description

bool
isSearchable()

No description

bool
isSearchableByColumn()

No description

bool
persistsSearchInSession()

No description

searchPlaceholder(string|Closure|null $searchPlaceholder)

No description

string|null
getSearchPlaceholder()

No description

bool
hasSearch()

No description

array
getColumnSearchIndicators()

No description

string
getSearchDebounce()

No description

searchOnBlur(bool|Closure $condition = true)

No description

bool
isSearchOnBlur()

No description

defaultSort(string|Closure|null $column, string|Closure|null $direction = 'asc')

No description

persistSortInSession(bool|Closure $condition = true)

No description

defaultSortOptionLabel(Htmlable|Closure|null $label)

No description

Column|null
getSortableVisibleColumn(string $name)

No description

Builder|null
getDefaultSort(Builder $query, string $direction)

No description

string|null
getDefaultSortColumn() deprecated

No description

Closure|null
getDefaultSortQuery() deprecated

No description

string|null
getDefaultSortDirection()

No description

string|null
getSortColumn()

No description

string|null
getSortDirection()

No description

bool
persistsSortInSession()

No description

Htmlable|null
getDefaultSortOptionLabel()

No description

bool
hasSummary()

No description

columnToggleFormColumns(int|array|Closure $columns)

No description

columnToggleFormMaxHeight(string|Closure|null $height)

No description

columnToggleFormWidth(MaxWidth|string|Closure|null $width)

No description

getColumnToggleForm()

No description

int|array
getColumnToggleFormColumns()

No description

string|null
getColumnToggleFormMaxHeight()

No description

MaxWidth|string|null
getColumnToggleFormWidth()

No description

bool
hasToggleableColumns()

No description

actions(ActionGroup $actions, ActionsPosition|string|Closure|null $position = null)

No description

pushActions(ActionGroup $actions)

No description

actionsColumnLabel(Htmlable|Closure|null $label)

No description

actionsAlignment(string|Closure|null $alignment = null)

No description

actionsPosition(ActionsPosition|Closure|null $position = null)

No description

array
getActions()

No description

Action|null
getAction(string|array $name)

No description

array
getFlatActions()

No description

bool
hasAction(string $name)

No description

void
cacheAction(Action $action, bool $shouldOverwriteExistingAction = true)

No description

void
mergeCachedFlatActions(array $actions, bool $shouldOverwriteExistingActions = true)

No description

Action|null
getMountableModalActionFromAction(Action $action, array $modalActionNames, Model|null $mountedRecord = null)

No description

ActionsPosition
getActionsPosition()

No description

string|null
getActionsAlignment()

No description

Htmlable|null
getActionsColumnLabel()

No description

bulkActions(ActionGroup $actions)

No description

pushBulkActions(ActionGroup $actions)

No description

groupedBulkActions(array $actions)

No description

void
cacheBulkAction(BulkAction $action)

No description

void
mergeCachedFlatBulkActions(array $actions)

No description

void
removeCachedBulkActions(array $actions)

No description

selectCurrentPageOnly(bool|Closure $condition = true)

No description

array
getBulkActions()

No description

array
getFlatBulkActions()

No description

BulkAction|null
getBulkAction(string $name)

No description

bool
isRecordSelectable(Model $record)

No description

int
getAllSelectableRecordsCount()

No description

selectable(bool|Closure|null $condition = true)

No description

bool
isSelectionEnabled()

No description

bool
selectsCurrentPageOnly()

No description

bool
checksIfRecordIsSelectable()

No description

recordCheckboxPosition(RecordCheckboxPosition|Closure|null $position = null)

No description

RecordCheckboxPosition
getRecordCheckboxPosition()

No description

columns(array $components)

No description

pushColumns(array $components)

No description

array
getColumns()

No description

array
getVisibleColumns()

No description

Column|null
getColumn(string $name)

No description

array
getColumnsLayout()

No description

Component|null
getCollapsibleColumnsLayout()

No description

bool
hasColumnGroups()

No description

bool
hasColumnsLayout()

No description

content(Htmlable|Closure|null $content)

No description

contentFooter(Htmlable|Closure|null $footer)

No description

contentGrid(array|Closure|null $grid)

No description

Htmlable|null
getContent()

No description

array|null
getContentGrid()

No description

Htmlable|null
getContentFooter()

No description

emptyStateDescription(Htmlable|Closure|null $description)

No description

emptyState(Htmlable|Closure|null $emptyState)

No description

emptyStateActions(ActionGroup $actions, bool $shouldOverwriteExistingActions = false)

No description

pushEmptyStateActions(ActionGroup $actions, bool $shouldOverwriteExistingActions = false)

No description

emptyStateHeading(Htmlable|Closure|null $heading)

No description

emptyStateIcon(string|Closure|null $icon)

No description

Htmlable|null
getEmptyState()

No description

array
getEmptyStateActions()

No description

Htmlable|null
getEmptyStateDescription()

No description

Htmlable
getEmptyStateHeading()

No description

string
getEmptyStateIcon()

No description

array
getFilterIndicators()

No description

hiddenFilterIndicators(bool|Closure $condition = true)

No description

deferFilters(bool|Closure $condition = true)

No description

bool
hasDeferredFilters()

No description

filtersApplyAction(Closure|null $callback)

No description

deselectAllRecordsWhenFiltered(bool|Closure $condition = true)

No description

filters(array $filters, FiltersLayout|string|Closure|null $layout = null)

No description

pushFilters(array $filters)

No description

filtersFormColumns(int|array|Closure|null $columns)

No description

filtersFormMaxHeight(string|Closure|null $height)

No description

filtersFormWidth(MaxWidth|string|Closure|null $width)

No description

filtersLayout(FiltersLayout|Closure|null $filtersLayout)

No description

filtersTriggerAction(Closure|null $callback)

No description

persistFiltersInSession(bool|Closure $condition = true)

No description

array
getFilters()

No description

BaseFilter|null
getFilter(string $name)

No description

getFiltersForm()

No description

filtersFormSchema(Closure|null $schema)

No description

array
getFiltersFormSchema()

No description

getFiltersTriggerAction()

No description

getFiltersApplyAction()

No description

int|array
getFiltersFormColumns()

No description

string|null
getFiltersFormMaxHeight()

No description

MaxWidth|string|null
getFiltersFormWidth()

No description

FiltersLayout
getFiltersLayout()

No description

bool
isFilterable()

No description

bool
persistsFiltersInSession()

No description

int
getActiveFiltersCount()

No description

bool
isFiltered()

No description

description(Htmlable|Closure|null $description)

No description

header(Htmlable|Closure|null $header)

No description

heading(Htmlable|Closure|null $heading)

No description

Htmlable|null
getHeader()

No description

Htmlable|null
getHeading()

No description

Htmlable|null
getDescription()

No description

headerActionsPosition(HeaderActionsPosition|Closure|null $position = null)

No description

headerActions(ActionGroup $actions, HeaderActionsPosition|Closure|null $position = null)

No description

pushHeaderActions(ActionGroup $actions)

No description

HeaderActionsPosition
getHeaderActionsPosition()

No description

array
getHeaderActions()

No description

query(Builder|Closure|null $query)

No description

from  HasQuery
modifyQueryUsing(Closure $callback)

No description

from  HasQuery
relationship(Closure|null $relationship)

No description

from  HasQuery
inverseRelationship(string|Closure|null $name)

No description

from  HasQuery
Builder
applyQueryScopes(Builder $query)

No description

from  HasQuery
Relation
getQuery()

No description

from  HasQuery
Builder|null
getRelationshipQuery()

No description

from  HasQuery
Relation
selectPivotDataInQuery(Relation $query)

No description

from  HasQuery
Builder|null
getRelationship()

No description

from  HasQuery
string|null
getInverseRelationship()

No description

from  HasQuery
Builder
getInverseRelationshipFor(Model $record)

No description

from  HasQuery
queryStringIdentifier(string|Closure|null $identifier)

No description

string|null
getQueryStringIdentifier()

No description

recordAction(string|Closure|null $action)

No description

string|null
getRecordAction(Model $record)

No description

recordClasses(array|string|Closure|null $classes)

No description

array
getRecordClasses(Model $record)

No description

allowDuplicates(bool|Closure $condition = true)

No description

modelLabel(string|Closure|null $label)

No description

pluralModelLabel(string|Closure|null $label)

No description

recordTitle(string|Closure|null $title)

No description

recordTitleAttribute(string|Closure|null $attribute)

No description

CursorPaginator
getRecords()

No description

string
getRecordKey(Model $record)

No description

string
getModel()

No description

bool
allowsDuplicates()

No description

string
getModelLabel()

No description

string
getPluralModelLabel()

No description

string
getRecordTitle(Model $record)

No description

bool
hasCustomRecordTitle()

No description

string|null
getRecordTitleAttribute()

No description

openRecordUrlInNewTab(bool|Closure $condition = true)

No description

recordUrl(string|Closure|null $url, bool|Closure $shouldOpenInNewTab = false)

No description

string|null
getRecordUrl(Model $record)

No description

bool
shouldOpenRecordUrlInNewTab(Model $record)

No description

__construct(HasTable $livewire)

No description

static Table
make(HasTable $livewire)

No description

Details

static mixed configureUsing(Closure $modifyUsing, Closure|null $during = null, bool $isImportant = false)

No description

Parameters

Closure $modifyUsing
Closure|null $during
bool $isImportant

Return Value

mixed

Configurable configure()

No description

Return Value

Configurable

protected void setUp()

No description

Return Value

void

mixed evaluate(mixed $value, array $namedInjections = [], array $typedInjections = [])

No description

Parameters

mixed $value
array $namedInjections
array $typedInjections

Return Value

mixed

protected mixed resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

Parameters

ReflectionParameter $parameter
array $namedInjections
array $typedInjections

Return Value

mixed

protected array resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

Parameters

string $parameterName

Return Value

array

protected array resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

Parameters

string $parameterType

Return Value

array

protected string|null getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

Parameters

ReflectionParameter $parameter

Return Value

string|null

static void macro(string $name, callable $macro)

No description

Parameters

string $name
callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

static void flushMacros()

No description

Return Value

void

static mixed __callStatic(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

mixed __call(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

static protected callable|null getMacro(string $method)

No description

Parameters

string $method

Return Value

callable|null

ViewComponent view(string|null $view, array $viewData = [])

No description

Parameters

string|null $view
array $viewData

Return Value

ViewComponent

ViewComponent defaultView(string|Closure|null $view)

No description

Parameters

string|Closure|null $view

Return Value

ViewComponent

protected array extractPublicMethods()

No description

Return Value

array

ViewComponent viewData(array $data)

No description

Parameters

array $data

Return Value

ViewComponent

string getView()

No description

Return Value

string

string|null getDefaultView()

No description

Return Value

string|null

string toHtml()

No description

Return Value

string

View render()

No description

Return Value

View

BelongsToLivewire livewire(HasTable $livewire)

No description

Parameters

HasTable $livewire

Return Value

BelongsToLivewire

HasTable getLivewire()

No description

Return Value

HasTable

TranslatableContentDriver|null makeTranslatableContentDriver()

No description

Return Value

TranslatableContentDriver|null

CanBeStriped striped(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeStriped

bool isStriped()

No description

Return Value

bool

CanDeferLoading deferLoading(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanDeferLoading

bool isLoadingDeferred()

No description

Return Value

bool

bool isLoaded()

No description

Return Value

bool

CanGroupRecords groupRecordsTriggerAction(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

CanGroupRecords

CanGroupRecords groupingSettingsInDropdownOnDesktop(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanGroupRecords

CanGroupRecords groupsInDropdownOnDesktop(bool|Closure $condition = true) deprecated

deprecated Use the `groupingSettingsInDropdownOnDesktop()` method instead.

No description

Parameters

bool|Closure $condition

Return Value

CanGroupRecords

CanGroupRecords groupingSettingsHidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanGroupRecords

CanGroupRecords groupingDirectionSettingHidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanGroupRecords

CanGroupRecords defaultGroup(Group|null $group)

No description

Parameters

Group|null $group

Return Value

CanGroupRecords

CanGroupRecords groups(array|Closure $groups)

No description

Parameters

array|Closure $groups

Return Value

CanGroupRecords

CanGroupRecords groupsOnly(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanGroupRecords

Action getGroupRecordsTriggerAction()

No description

Return Value

Action

bool isDefaultGroupSelectable()

No description

Return Value

bool

bool areGroupingSettingsInDropdownOnDesktop()

No description

Return Value

bool

bool areGroupingSettingsHidden()

No description

Return Value

bool

bool isGroupingDirectionSettingHidden()

No description

Return Value

bool

Group|null getDefaultGroup()

No description

Return Value

Group|null

array getGroups()

No description

Return Value

array

Group|null getGroup(string $id)

No description

Parameters

string $id

Return Value

Group|null

Group|null getGrouping()

No description

Return Value

Group|null

bool isGroupsOnly()

No description

Return Value

bool

CanPaginateRecords defaultPaginationPageOption(int|string|Closure|null $option)

No description

Parameters

int|string|Closure|null $option

Return Value

CanPaginateRecords

CanPaginateRecords paginated(bool|array|Closure $condition = true)

No description

Parameters

bool|array|Closure $condition

Return Value

CanPaginateRecords

CanPaginateRecords paginatedWhileReordering(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanPaginateRecords

CanPaginateRecords paginationPageOptions(array|Closure|null $options)

No description

Parameters

array|Closure|null $options

Return Value

CanPaginateRecords

No description

Parameters

bool|Closure $condition

Return Value

CanPaginateRecords

int|string|null getDefaultPaginationPageOption()

No description

Return Value

int|string|null

array getPaginationPageOptions()

No description

Return Value

array

bool isPaginated()

No description

Return Value

bool

bool isPaginatedWhileReordering()

No description

Return Value

bool

No description

Return Value

bool

CanPollRecords poll(string|Closure|null $interval = '10s')

No description

Parameters

string|Closure|null $interval

Return Value

CanPollRecords

string|null getPollingInterval()

No description

Return Value

string|null

HasReorderAnimationDuration reorderAnimationDuration(int|Closure $animation)

No description

Parameters

int|Closure $animation

Return Value

HasReorderAnimationDuration

int getReorderAnimationDuration()

No description

Return Value

int

CanReorderRecords reorderRecordsTriggerAction(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

CanReorderRecords

CanReorderRecords reorderable(string|Closure|null $column = null, bool|Closure|null $condition = null)

No description

Parameters

string|Closure|null $column
bool|Closure|null $condition

Return Value

CanReorderRecords

CanReorderRecords authorizeReorder(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanReorderRecords

Action getReorderRecordsTriggerAction(bool $isReordering)

No description

Parameters

bool $isReordering

Return Value

Action

string|null getReorderColumn()

No description

Return Value

string|null

bool isReorderable()

No description

Return Value

bool

bool isReordering()

No description

Return Value

bool

bool isReorderAuthorized()

No description

Return Value

bool

CanSearchRecords persistSearchInSession(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanSearchRecords

CanSearchRecords persistColumnSearchesInSession(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanSearchRecords

CanSearchRecords searchable(bool|null $condition = true)

No description

Parameters

bool|null $condition

Return Value

CanSearchRecords

CanSearchRecords searchDebounce(string|null $debounce)

No description

Parameters

string|null $debounce

Return Value

CanSearchRecords

bool isSearchable()

No description

Return Value

bool

bool isSearchableByColumn()

No description

Return Value

bool

bool persistsSearchInSession()

No description

Return Value

bool

bool persistsColumnSearchesInSession()

No description

Return Value

bool

CanSearchRecords searchPlaceholder(string|Closure|null $searchPlaceholder)

No description

Parameters

string|Closure|null $searchPlaceholder

Return Value

CanSearchRecords

string|null getSearchPlaceholder()

No description

Return Value

string|null

bool hasSearch()

No description

Return Value

bool

Indicator getSearchIndicator()

No description

Return Value

Indicator

array getColumnSearchIndicators()

No description

Return Value

array

| array<string, string>

string getSearchDebounce()

No description

Return Value

string

CanSearchRecords searchOnBlur(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanSearchRecords

bool isSearchOnBlur()

No description

Return Value

bool

CanSortRecords defaultSort(string|Closure|null $column, string|Closure|null $direction = 'asc')

No description

Parameters

string|Closure|null $column
string|Closure|null $direction

Return Value

CanSortRecords

CanSortRecords persistSortInSession(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanSortRecords

CanSortRecords defaultSortOptionLabel(Htmlable|Closure|null $label)

No description

Parameters

Htmlable|Closure|null $label

Return Value

CanSortRecords

Column|null getSortableVisibleColumn(string $name)

No description

Parameters

string $name

Return Value

Column|null

Builder|null getDefaultSort(Builder $query, string $direction)

No description

Parameters

Builder $query
string $direction

Return Value

Builder|null

string|null getDefaultSortColumn() deprecated

deprecated Use `getDefaultSort()` instead.

No description

Return Value

string|null

Closure|null getDefaultSortQuery() deprecated

deprecated Use `getDefaultSort()` instead.

No description

Return Value

Closure|null

string|null getDefaultSortDirection()

No description

Return Value

string|null

string|null getSortColumn()

No description

Return Value

string|null

string|null getSortDirection()

No description

Return Value

string|null

bool persistsSortInSession()

No description

Return Value

bool

Htmlable|null getDefaultSortOptionLabel()

No description

Return Value

Htmlable|null

bool hasSummary()

No description

Return Value

bool

CanToggleColumns toggleColumnsTriggerAction(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

CanToggleColumns

CanToggleColumns columnToggleFormColumns(int|array|Closure $columns)

No description

Parameters

int|array|Closure $columns

Return Value

CanToggleColumns

CanToggleColumns columnToggleFormMaxHeight(string|Closure|null $height)

No description

Parameters

string|Closure|null $height

Return Value

CanToggleColumns

CanToggleColumns columnToggleFormWidth(MaxWidth|string|Closure|null $width)

No description

Parameters

MaxWidth|string|Closure|null $width

Return Value

CanToggleColumns

Action getToggleColumnsTriggerAction()

No description

Return Value

Action

Form getColumnToggleForm()

No description

Return Value

Form

int|array getColumnToggleFormColumns()

No description

Return Value

int|array

| array<string, int | null>

string|null getColumnToggleFormMaxHeight()

No description

Return Value

string|null

MaxWidth|string|null getColumnToggleFormWidth()

No description

Return Value

MaxWidth|string|null

bool hasToggleableColumns()

No description

Return Value

bool

HasActions actions(ActionGroup $actions, ActionsPosition|string|Closure|null $position = null)

No description

Parameters

ActionGroup $actions
ActionsPosition|string|Closure|null $position

Return Value

HasActions

HasActions pushActions(ActionGroup $actions)

No description

Parameters

ActionGroup $actions

Return Value

HasActions

HasActions actionsColumnLabel(Htmlable|Closure|null $label)

No description

Parameters

Htmlable|Closure|null $label

Return Value

HasActions

HasActions actionsAlignment(string|Closure|null $alignment = null)

No description

Parameters

string|Closure|null $alignment

Return Value

HasActions

HasActions actionsPosition(ActionsPosition|Closure|null $position = null)

No description

Parameters

ActionsPosition|Closure|null $position

Return Value

HasActions

array getActions()

No description

Return Value

array

Action|null getAction(string|array $name)

No description

Parameters

string|array $name

Return Value

Action|null

array getFlatActions()

No description

Return Value

array

bool hasAction(string $name)

No description

Parameters

string $name

Return Value

bool

protected void cacheAction(Action $action, bool $shouldOverwriteExistingAction = true)

No description

Parameters

Action $action
bool $shouldOverwriteExistingAction

Return Value

void

protected void mergeCachedFlatActions(array $actions, bool $shouldOverwriteExistingActions = true)

No description

Parameters

array $actions
bool $shouldOverwriteExistingActions

Return Value

void

protected Action|null getMountableModalActionFromAction(Action $action, array $modalActionNames, Model|null $mountedRecord = null)

No description

Parameters

Action $action
array $modalActionNames
Model|null $mountedRecord

Return Value

Action|null

ActionsPosition getActionsPosition()

No description

Return Value

ActionsPosition

string|null getActionsAlignment()

No description

Return Value

string|null

Htmlable|null getActionsColumnLabel()

No description

Return Value

Htmlable|null

HasBulkActions bulkActions(ActionGroup $actions)

No description

Parameters

ActionGroup $actions

Return Value

HasBulkActions

HasBulkActions pushBulkActions(ActionGroup $actions)

No description

Parameters

ActionGroup $actions

Return Value

HasBulkActions

HasBulkActions groupedBulkActions(array $actions)

No description

Parameters

array $actions

Return Value

HasBulkActions

protected void cacheBulkAction(BulkAction $action)

No description

Parameters

BulkAction $action

Return Value

void

protected void mergeCachedFlatBulkActions(array $actions)

No description

Parameters

array $actions

Return Value

void

protected void removeCachedBulkActions(array $actions)

No description

Parameters

array $actions

Return Value

void

HasBulkActions checkIfRecordIsSelectableUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasBulkActions

HasBulkActions selectCurrentPageOnly(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasBulkActions

array getBulkActions()

No description

Return Value

array

array getFlatBulkActions()

No description

Return Value

array

BulkAction|null getBulkAction(string $name)

No description

Parameters

string $name

Return Value

BulkAction|null

bool isRecordSelectable(Model $record)

No description

Parameters

Model $record

Return Value

bool

int getAllSelectableRecordsCount()

No description

Return Value

int

HasBulkActions selectable(bool|Closure|null $condition = true)

No description

Parameters

bool|Closure|null $condition

Return Value

HasBulkActions

bool isSelectionEnabled()

No description

Return Value

bool

bool selectsCurrentPageOnly()

No description

Return Value

bool

bool checksIfRecordIsSelectable()

No description

Return Value

bool

HasBulkActions recordCheckboxPosition(RecordCheckboxPosition|Closure|null $position = null)

No description

Parameters

RecordCheckboxPosition|Closure|null $position

Return Value

HasBulkActions

RecordCheckboxPosition getRecordCheckboxPosition()

No description

Return Value

RecordCheckboxPosition

HasColumns columns(array $components)

No description

Parameters

array $components

Return Value

HasColumns

HasColumns pushColumns(array $components)

No description

Parameters

array $components

Return Value

HasColumns

array getColumns()

No description

Return Value

array

array getVisibleColumns()

No description

Return Value

array

Column|null getColumn(string $name)

No description

Parameters

string $name

Return Value

Column|null

array getColumnsLayout()

No description

Return Value

array

Component|null getCollapsibleColumnsLayout()

No description

Return Value

Component|null

bool hasColumnGroups()

No description

Return Value

bool

bool hasColumnsLayout()

No description

Return Value

bool

HasContent content(Htmlable|Closure|null $content)

No description

Parameters

Htmlable|Closure|null $content

Return Value

HasContent

HasContent contentFooter(Htmlable|Closure|null $footer)

No description

Parameters

Htmlable|Closure|null $footer

Return Value

HasContent

HasContent contentGrid(array|Closure|null $grid)

No description

Parameters

array|Closure|null $grid

Return Value

HasContent

Htmlable|null getContent()

No description

Return Value

Htmlable|null

array|null getContentGrid()

No description

Return Value

array|null

Htmlable|null getContentFooter()

No description

Return Value

Htmlable|null

HasEmptyState emptyStateDescription(Htmlable|Closure|null $description)

No description

Parameters

Htmlable|Closure|null $description

Return Value

HasEmptyState

HasEmptyState emptyState(Htmlable|Closure|null $emptyState)

No description

Parameters

Htmlable|Closure|null $emptyState

Return Value

HasEmptyState

HasEmptyState emptyStateActions(ActionGroup $actions, bool $shouldOverwriteExistingActions = false)

No description

Parameters

ActionGroup $actions
bool $shouldOverwriteExistingActions

Return Value

HasEmptyState

HasEmptyState pushEmptyStateActions(ActionGroup $actions, bool $shouldOverwriteExistingActions = false)

No description

Parameters

ActionGroup $actions
bool $shouldOverwriteExistingActions

Return Value

HasEmptyState

HasEmptyState emptyStateHeading(Htmlable|Closure|null $heading)

No description

Parameters

Htmlable|Closure|null $heading

Return Value

HasEmptyState

HasEmptyState emptyStateIcon(string|Closure|null $icon)

No description

Parameters

string|Closure|null $icon

Return Value

HasEmptyState

Htmlable|null getEmptyState()

No description

Return Value

Htmlable|null

array getEmptyStateActions()

No description

Return Value

array

Htmlable|null getEmptyStateDescription()

No description

Return Value

Htmlable|null

Htmlable getEmptyStateHeading()

No description

Return Value

Htmlable

string getEmptyStateIcon()

No description

Return Value

string

array getFilterIndicators()

No description

Return Value

array

HasFilterIndicators hiddenFilterIndicators(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasFilterIndicators

HasFilters deferFilters(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasFilters

bool hasDeferredFilters()

No description

Return Value

bool

HasFilters filtersApplyAction(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasFilters

HasFilters deselectAllRecordsWhenFiltered(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasFilters

HasFilters filters(array $filters, FiltersLayout|string|Closure|null $layout = null)

No description

Parameters

array $filters
FiltersLayout|string|Closure|null $layout

Return Value

HasFilters

HasFilters pushFilters(array $filters)

No description

Parameters

array $filters

Return Value

HasFilters

HasFilters filtersFormColumns(int|array|Closure|null $columns)

No description

Parameters

int|array|Closure|null $columns

Return Value

HasFilters

HasFilters filtersFormMaxHeight(string|Closure|null $height)

No description

Parameters

string|Closure|null $height

Return Value

HasFilters

HasFilters filtersFormWidth(MaxWidth|string|Closure|null $width)

No description

Parameters

MaxWidth|string|Closure|null $width

Return Value

HasFilters

HasFilters filtersLayout(FiltersLayout|Closure|null $filtersLayout)

No description

Parameters

FiltersLayout|Closure|null $filtersLayout

Return Value

HasFilters

HasFilters filtersTriggerAction(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasFilters

HasFilters persistFiltersInSession(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasFilters

array getFilters()

No description

Return Value

array

BaseFilter|null getFilter(string $name)

No description

Parameters

string $name

Return Value

BaseFilter|null

Form getFiltersForm()

No description

Return Value

Form

HasFilters filtersFormSchema(Closure|null $schema)

No description

Parameters

Closure|null $schema

Return Value

HasFilters

array getFiltersFormSchema()

No description

Return Value

array

Action getFiltersTriggerAction()

No description

Return Value

Action

Action getFiltersApplyAction()

No description

Return Value

Action

int|array getFiltersFormColumns()

No description

Return Value

int|array

| array<string, int | null>

string|null getFiltersFormMaxHeight()

No description

Return Value

string|null

MaxWidth|string|null getFiltersFormWidth()

No description

Return Value

MaxWidth|string|null

FiltersLayout getFiltersLayout()

No description

Return Value

FiltersLayout

bool isFilterable()

No description

Return Value

bool

bool persistsFiltersInSession()

No description

Return Value

bool

bool shouldDeselectAllRecordsWhenFiltered()

No description

Return Value

bool

int getActiveFiltersCount()

No description

Return Value

int

bool isFiltered()

No description

Return Value

bool

HasHeader description(Htmlable|Closure|null $description)

No description

Parameters

Htmlable|Closure|null $description

Return Value

HasHeader

HasHeader header(Htmlable|Closure|null $header)

No description

Parameters

Htmlable|Closure|null $header

Return Value

HasHeader

HasHeader heading(Htmlable|Closure|null $heading)

No description

Parameters

Htmlable|Closure|null $heading

Return Value

HasHeader

Htmlable|null getHeader()

No description

Return Value

Htmlable|null

Htmlable|null getHeading()

No description

Return Value

Htmlable|null

Htmlable|null getDescription()

No description

Return Value

Htmlable|null

HasHeaderActions headerActionsPosition(HeaderActionsPosition|Closure|null $position = null)

No description

Parameters

HeaderActionsPosition|Closure|null $position

Return Value

HasHeaderActions

HasHeaderActions headerActions(ActionGroup $actions, HeaderActionsPosition|Closure|null $position = null)

No description

Parameters

ActionGroup $actions
HeaderActionsPosition|Closure|null $position

Return Value

HasHeaderActions

HasHeaderActions pushHeaderActions(ActionGroup $actions)

No description

Parameters

ActionGroup $actions

Return Value

HasHeaderActions

HeaderActionsPosition getHeaderActionsPosition()

No description

Return Value

HeaderActionsPosition

array getHeaderActions()

No description

Return Value

array

HasQuery query(Builder|Closure|null $query)

No description

Parameters

Builder|Closure|null $query

Return Value

HasQuery

HasQuery modifyQueryUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

HasQuery

HasQuery relationship(Closure|null $relationship)

No description

Parameters

Closure|null $relationship

Return Value

HasQuery

HasQuery inverseRelationship(string|Closure|null $name)

No description

Parameters

string|Closure|null $name

Return Value

HasQuery

protected Builder applyQueryScopes(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

Relation getQuery()

No description

Return Value

Relation

Builder|null getRelationshipQuery()

No description

Return Value

Builder|null

Relation selectPivotDataInQuery(Relation $query)

No description

Parameters

Relation $query

Return Value

Relation

Builder|null getRelationship()

No description

Return Value

Builder|null

string|null getInverseRelationship()

No description

Return Value

string|null

Builder getInverseRelationshipFor(Model $record)

No description

Parameters

Model $record

Return Value

Builder

HasQueryStringIdentifier queryStringIdentifier(string|Closure|null $identifier)

No description

Parameters

string|Closure|null $identifier

Return Value

HasQueryStringIdentifier

string|null getQueryStringIdentifier()

No description

Return Value

string|null

HasRecordAction recordAction(string|Closure|null $action)

No description

Parameters

string|Closure|null $action

Return Value

HasRecordAction

string|null getRecordAction(Model $record)

No description

Parameters

Model $record

Return Value

string|null

HasRecordClasses recordClasses(array|string|Closure|null $classes)

No description

Parameters

array|string|Closure|null $classes

Return Value

HasRecordClasses

array getRecordClasses(Model $record)

No description

Parameters

Model $record

Return Value

array

HasRecords allowDuplicates(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasRecords

HasRecords modelLabel(string|Closure|null $label)

No description

Parameters

string|Closure|null $label

Return Value

HasRecords

HasRecords pluralModelLabel(string|Closure|null $label)

No description

Parameters

string|Closure|null $label

Return Value

HasRecords

HasRecords recordTitle(string|Closure|null $title)

No description

Parameters

string|Closure|null $title

Return Value

HasRecords

HasRecords recordTitleAttribute(string|Closure|null $attribute)

No description

Parameters

string|Closure|null $attribute

Return Value

HasRecords

CursorPaginator getRecords()

No description

Return Value

CursorPaginator

string getRecordKey(Model $record)

No description

Parameters

Model $record

Return Value

string

string getModel()

No description

Return Value

string

bool allowsDuplicates()

No description

Return Value

bool

string getModelLabel()

No description

Return Value

string

string getPluralModelLabel()

No description

Return Value

string

string getRecordTitle(Model $record)

No description

Parameters

Model $record

Return Value

string

bool hasCustomRecordTitle()

No description

Return Value

bool

string|null getRecordTitleAttribute()

No description

Return Value

string|null

HasRecordUrl openRecordUrlInNewTab(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasRecordUrl

HasRecordUrl recordUrl(string|Closure|null $url, bool|Closure $shouldOpenInNewTab = false)

No description

Parameters

string|Closure|null $url
bool|Closure $shouldOpenInNewTab

Return Value

HasRecordUrl

string|null getRecordUrl(Model $record)

No description

Parameters

Model $record

Return Value

string|null

bool shouldOpenRecordUrlInNewTab(Model $record)

No description

Parameters

Model $record

Return Value

bool

final __construct(HasTable $livewire)

No description

Parameters

HasTable $livewire

static Table make(HasTable $livewire)

No description

Parameters

HasTable $livewire

Return Value

Table