1. class
  2. Filament
  3. \
  4. Tables
  5. \
  6. Columns
  7. \
  8. IconColumn

IconColumn

class IconColumn extends Column (View source)

Traits

CanWrap
HasColor
HasIcon
CanAggregateRelatedModels
CanGrow
BelongsToGroup
BelongsToLayout
BelongsToTable
CanBeDisabled
CanBeHidden
CanBeInline
CanBeSearchable
CanBeSortable
CanBeSummarized
CanBeToggled
CanCallAction
CanOpenUrl
CanSpanColumns
CanWrapHeader
HasExtraCellAttributes
HasExtraHeaderAttributes
HasLabel
HasName
HasRecord
HasRowLoopObject
HasTooltip
HasWidth
InteractsWithTableQuery
Conditionable
HasAlignment
HasCellState
HasExtraAttributes
HasPlaceholder
HasVerticalAlignment
CanBeHiddenResponsively
Conditionable
Configurable
EvaluatesClosures
Macroable
Tappable

Properties

protected string $evaluationIdentifier from  EvaluatesClosures
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 from  Column
protected string|Closure|null $columnToAvg from  CanAggregateRelatedModels
protected string $relationshipToAvg from  CanAggregateRelatedModels
protected string $relationshipsToCount from  CanAggregateRelatedModels
protected string $relationshipsToExistenceCheck from  CanAggregateRelatedModels
protected string|Closure|null $columnToMax from  CanAggregateRelatedModels
protected string $relationshipToMax from  CanAggregateRelatedModels
protected string|Closure|null $columnToMin from  CanAggregateRelatedModels
protected string $relationshipToMin from  CanAggregateRelatedModels
protected string|Closure|null $columnToSum from  CanAggregateRelatedModels
protected string $relationshipToSum from  CanAggregateRelatedModels
protected bool|Closure|null $canGrow from  CanGrow
protected ColumnGroup|null $group from  BelongsToGroup
protected Component|null $layout from  BelongsToLayout
protected Table|null $table from  BelongsToTable
protected bool|Closure $isDisabled from  CanBeDisabled
protected bool|Closure $isClickDisabled from  CanBeDisabled
protected string|Closure|null $hiddenFrom from  CanBeHiddenResponsively
protected string|Closure|null $visibleFrom from  CanBeHiddenResponsively
protected bool|Closure $isHidden from  CanBeHidden
protected bool|Closure $isVisible from  CanBeHidden
protected bool|Closure $isInline from  CanBeInline
protected bool $isGloballySearchable from  CanBeSearchable
protected bool $isIndividuallySearchable from  CanBeSearchable
protected bool $isSearchable from  CanBeSearchable
protected string[] $searchColumns from  CanBeSearchable
protected Closure|null $searchQuery from  CanBeSearchable
protected bool|Closure|null $isSearchForcedCaseInsensitive from  CanBeSearchable
protected bool|Closure $isSortable from  CanBeSortable
protected string[] $sortColumns from  CanBeSortable
protected Closure|null $sortQuery from  CanBeSortable
protected array $summarizers from  CanBeSummarized
protected bool|Closure $isToggleable from  CanBeToggled
protected bool|Closure $isToggledHiddenByDefault from  CanBeToggled
protected Action|string|null $action from  CanCallAction
protected bool|Closure $shouldOpenUrlInNewTab from  CanOpenUrl
protected string|Closure|null $url from  CanOpenUrl
protected array $columnSpan from  CanSpanColumns
protected array $columnStart from  CanSpanColumns
protected bool|Closure $isHeaderWrapped from  CanWrapHeader
protected array $extraCellAttributes from  HasExtraCellAttributes
protected array $extraHeaderAttributes from  HasExtraHeaderAttributes
protected Htmlable|Closure|null $label from  HasLabel
protected bool $shouldTranslateLabel from  HasLabel
protected string $name from  HasName
protected Model|null $record from  HasRecord
protected stdClass|null $loop from  HasRowLoopObject
protected string|Closure|null $tooltip from  HasTooltip
protected int|string|Closure|null $width from  HasWidth
protected Alignment|string|Closure|null $alignment from  HasAlignment
protected mixed $defaultState from  HasCellState
protected mixed $getStateUsing from  HasCellState
protected string|Closure|null $separator from  HasCellState
protected bool|Closure $isDistinctList from  HasCellState
protected string|null $inverseRelationshipName from  HasCellState
protected array $extraAttributes from  HasExtraAttributes
protected Htmlable|Closure|null $placeholder from  HasPlaceholder
protected VerticalAlignment|string|Closure|null $verticalAlignment from  HasVerticalAlignment
protected bool|Closure $wrap from  CanWrap
protected string $color from  HasColor
protected string|bool|Closure|null $icon from  HasIcon
protected IconPosition|string|Closure|null $iconPosition from  HasIcon
protected bool|Closure|null $isBoolean
protected string $falseColor
protected string|Closure|null $falseIcon
protected string $trueColor
protected string|Closure|null $trueIcon
protected bool|Closure $isListWithLineBreaks
protected IconColumnSize|string|Closure|null $size

Methods

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

No description

from  Configurable
Configurable
configure()

No description

from  Configurable
void
setUp()

No description

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

No description

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

No description

from  EvaluatesClosures
array
resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

from  EvaluatesClosures
array
resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

from  EvaluatesClosures
string|null
getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

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

No description

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

No description

from  Macroable
static void
flushMacros()

No description

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

No description

from  Macroable
mixed
__call(string $method, array $parameters)

No description

from  Macroable
static callable|null
getMacro(string $method)

No description

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

No description

from  ViewComponent
ViewComponent
defaultView(string|Closure|null $view)

No description

from  ViewComponent
array
extractPublicMethods()

No description

from  ViewComponent
ViewComponent
viewData(array $data)

No description

from  ViewComponent
string
getView()

No description

from  ViewComponent
string|null
getDefaultView()

No description

from  ViewComponent
string
toHtml()

No description

from  ViewComponent
View
render()

No description

from  ViewComponent
CanAggregateRelatedModels
avg(string|array|Closure|null $relationship, string|Closure|null $column)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
counts(string|array|Closure|null $relationships)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
exists(string|array|Closure|null $relationships)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
max(string|array|Closure|null $relationship, string|Closure|null $column)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
min(string|array|Closure|null $relationship, string|Closure|null $column)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
sum(string|array|Closure|null $relationship, string|Closure|null $column)

No description

from  CanAggregateRelatedModels
string|null
getColumnToAvg()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipToAvg()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipsToCount()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipsToExistenceCheck()

No description

from  CanAggregateRelatedModels
string|null
getColumnToMax()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipToMax()

No description

from  CanAggregateRelatedModels
string|null
getColumnToMin()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipToMin()

No description

from  CanAggregateRelatedModels
string|null
getColumnToSum()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipToSum()

No description

from  CanAggregateRelatedModels
CanGrow
grow(bool|Closure|null $condition = true)

No description

from  CanGrow
bool
canGrow(bool $default = true)

No description

from  CanGrow
BelongsToGroup
group(ColumnGroup|null $group)

No description

from  BelongsToGroup
ColumnGroup|null
getGroup()

No description

from  BelongsToGroup
BelongsToLayout
layout(Component|null $layout)

No description

from  BelongsToLayout
Component|null
getLayout()

No description

from  BelongsToLayout
BelongsToTable
table(Table|null $table)

No description

from  BelongsToTable
Table
getTable()

No description

from  BelongsToTable
HasTable
getLivewire()

No description

from  BelongsToTable
CanBeDisabled
disabled(bool|Closure $condition = true)

No description

from  CanBeDisabled
CanBeDisabled
disabledClick(bool|Closure $condition = true)

No description

from  CanBeDisabled
CanBeDisabled
disableClick(bool|Closure $condition = true) deprecated

No description

from  CanBeDisabled
bool
isDisabled()

No description

from  CanBeDisabled
bool
isEnabled()

No description

from  CanBeDisabled
bool
isClickDisabled()

No description

from  CanBeDisabled
CanBeHiddenResponsively
hiddenFrom(string|Closure|null $breakpoint)

No description

from  CanBeHiddenResponsively
CanBeHiddenResponsively
visibleFrom(string|Closure|null $breakpoint)

No description

from  CanBeHiddenResponsively
string|null
getHiddenFrom()

No description

from  CanBeHiddenResponsively
string|null
getVisibleFrom()

No description

from  CanBeHiddenResponsively
CanBeHidden
hidden(bool|Closure $condition = true)

No description

from  CanBeHidden
CanBeHidden
hiddenOn(string|array $livewireComponents)

No description

from  CanBeHidden
CanBeHidden
visible(bool|Closure $condition = true)

No description

from  CanBeHidden
CanBeHidden
visibleOn(string|array $livewireComponents)

No description

from  CanBeHidden
bool
isHidden()

No description

from  CanBeHidden
bool
isVisible()

No description

from  CanBeHidden
CanBeInline
inline(bool|Closure $condition = true)

No description

from  CanBeInline
bool
isInline()

No description

from  CanBeInline
CanBeSearchable
searchable(bool|array|string $condition = true, Closure|null $query = null, bool $isIndividual = false, bool $isGlobal = true)

No description

from  CanBeSearchable
CanBeSearchable
forceSearchCaseInsensitive(bool|Closure|null $condition = true)

No description

from  CanBeSearchable
array
getSearchColumns()

No description

from  CanBeSearchable
bool
isSearchable()

No description

from  CanBeSearchable
bool
isGloballySearchable()

No description

from  CanBeSearchable
bool
isIndividuallySearchable()

No description

from  CanBeSearchable
bool|null
isSearchForcedCaseInsensitive()

No description

from  CanBeSearchable
array
getDefaultSearchColumns()

No description

from  CanBeSearchable
CanBeSortable
sortable(bool|array|Closure $condition = true, Closure|null $query = null)

No description

from  CanBeSortable
array
getSortColumns()

No description

from  CanBeSortable
bool
isSortable()

No description

from  CanBeSortable
array
getDefaultSortColumns()

No description

from  CanBeSortable
CanBeSummarized
summarize(Summarizer $summarizers)

No description

from  CanBeSummarized
Summarizer|null
getSummarizer(string $id)

No description

from  CanBeSummarized
array
getSummarizers()

No description

from  CanBeSummarized
bool
hasSummary()

No description

from  CanBeSummarized
CanBeToggled
toggleable(bool|Closure $condition = true, bool|Closure $isToggledHiddenByDefault = false)

No description

from  CanBeToggled
CanBeToggled
toggledHiddenByDefault(bool|Closure $condition = true)

No description

from  CanBeToggled
bool
isToggledHiddenByDefault()

No description

from  CanBeToggled
bool
isToggleable()

No description

from  CanBeToggled
bool
isToggledHidden()

No description

from  CanBeToggled
CanCallAction
action(Action|string|null $action)

No description

from  CanCallAction
Action|null
getAction()

No description

from  CanCallAction
CanOpenUrl
openUrlInNewTab(bool|Closure $condition = true)

No description

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

No description

from  CanOpenUrl
string|null
getUrl()

No description

from  CanOpenUrl
bool
shouldOpenUrlInNewTab()

No description

from  CanOpenUrl
CanSpanColumns
columnSpan(array|int|string|Closure|null $span)

No description

from  CanSpanColumns
CanSpanColumns
columnSpanFull()

No description

from  CanSpanColumns
CanSpanColumns
columnStart(array|int|string|Closure|null $start)

No description

from  CanSpanColumns
array|int|string|null
getColumnSpan(int|string|null $breakpoint = null)

No description

from  CanSpanColumns
array|int|string|null
getColumnStart(int|string|null $breakpoint = null)

No description

from  CanSpanColumns
CanWrapHeader
wrapHeader(bool|Closure $condition = true)

No description

from  CanWrapHeader
bool
isHeaderWrapped()

No description

from  CanWrapHeader
HasExtraCellAttributes
extraCellAttributes(array|Closure $attributes, bool $merge = false)

No description

from  HasExtraCellAttributes
array
getExtraCellAttributes()

No description

from  HasExtraCellAttributes
ComponentAttributeBag
getExtraCellAttributeBag()

No description

from  HasExtraCellAttributes
HasExtraHeaderAttributes
extraHeaderAttributes(array|Closure $attributes, bool $merge = false)

No description

from  HasExtraHeaderAttributes
array
getExtraHeaderAttributes()

No description

from  HasExtraHeaderAttributes
ComponentAttributeBag
getExtraHeaderAttributeBag()

No description

from  HasExtraHeaderAttributes
HasLabel
label(Htmlable|Closure|null $label)

No description

from  HasLabel
HasLabel
translateLabel(bool $shouldTranslateLabel = true)

No description

from  HasLabel
Htmlable
getLabel()

No description

from  HasLabel
HasName
name(string $name)

No description

from  HasName
string
getName()

No description

from  HasName
HasRecord
record(Model $record)

No description

from  HasRecord
Model|null
getRecord()

No description

from  HasRecord
HasRowLoopObject
rowLoop(stdClass|null $loop)

No description

from  HasRowLoopObject
stdClass|null
getRowLoop()

No description

from  HasRowLoopObject
HasTooltip
tooltip(string|Closure|null $tooltip)

No description

from  HasTooltip
string|null
getTooltip()

No description

from  HasTooltip
HasWidth
width(int|string|Closure|null $width)

No description

from  HasWidth
string|null
getWidth()

No description

from  HasWidth
Relation
applyRelationshipAggregates(Relation $query)

No description

from  InteractsWithTableQuery
Relation
applyEagerLoading(Relation $query)

No description

from  InteractsWithTableQuery
Builder
applySearchConstraint(Builder $query, string $search, bool $isFirst)

No description

from  InteractsWithTableQuery
Builder
applySort(Builder $query, string $direction = 'asc')

No description

from  InteractsWithTableQuery
Builder
getSortColumnForQuery(Builder $query, string $sortColumn, array|null $relationships = null)

No description

from  InteractsWithTableQuery
HasAlignment
alignment(Alignment|string|Closure|null $alignment)

No description

from  HasAlignment
HasAlignment
alignStart(bool|Closure $condition = true)

No description

from  HasAlignment
HasAlignment
alignCenter(bool|Closure $condition = true)

No description

from  HasAlignment
HasAlignment
alignEnd(bool|Closure $condition = true)

No description

from  HasAlignment
HasAlignment
alignJustify(bool|Closure $condition = true)

No description

from  HasAlignment
HasAlignment
alignBetween(bool|Closure $condition = true)

No description

from  HasAlignment
HasAlignment
alignLeft(bool|Closure $condition = true)

No description

from  HasAlignment
HasAlignment
alignRight(bool|Closure $condition = true)

No description

from  HasAlignment
Alignment|string|null
getAlignment()

No description

from  HasAlignment
HasCellState
inverseRelationship(string|null $name)

No description

from  HasCellState
HasCellState
distinctList(bool|Closure $condition = true)

No description

from  HasCellState
HasCellState
getStateUsing(mixed $callback)

No description

from  HasCellState
HasCellState
state(mixed $state)

No description

from  HasCellState
HasCellState
default(mixed $state)

No description

from  HasCellState
bool
isDistinctList()

No description

from  HasCellState
mixed
getDefaultState()

No description

from  HasCellState
mixed
getState()

No description

from  HasCellState
mixed
getStateFromRecord()

No description

from  HasCellState
HasCellState
separator(string|Closure|null $separator = ',')

No description

from  HasCellState
string|null
getSeparator()

No description

from  HasCellState
bool
hasRelationship(Model $record)

No description

from  HasCellState
bool
queriesRelationships(Model $record) deprecated

No description

from  HasCellState
Relation|null
getRelationship(Model $record, string|null $name = null)

No description

from  HasCellState
array
getRelationshipResults(Model $record, array|null $relationships = null)

No description

from  HasCellState
string
getRelationshipAttribute(string|null $name = null)

No description

from  HasCellState
string
getInverseRelationshipName(Model $record)

No description

from  HasCellState
string|null
getRelationshipName(string|null $name = null)

No description

from  HasCellState
HasExtraAttributes
extraAttributes(array|Closure $attributes, bool $merge = false)

No description

from  HasExtraAttributes
array
getExtraAttributes()

No description

from  HasExtraAttributes
ComponentAttributeBag
getExtraAttributeBag()

No description

from  HasExtraAttributes
HasPlaceholder
placeholder(Htmlable|Closure|null $placeholder)

No description

from  HasPlaceholder
Htmlable|null
getPlaceholder()

No description

from  HasPlaceholder
HasVerticalAlignment
verticalAlignment(VerticalAlignment|string|Closure|null $alignment)

No description

from  HasVerticalAlignment
HasVerticalAlignment
verticallyAlignStart(bool|Closure $condition = true)

No description

from  HasVerticalAlignment
HasVerticalAlignment
verticallyAlignCenter(bool|Closure $condition = true)

No description

from  HasVerticalAlignment
HasVerticalAlignment
verticallyAlignEnd(bool|Closure $condition = true)

No description

from  HasVerticalAlignment
VerticalAlignment|string|null
getVerticalAlignment()

No description

from  HasVerticalAlignment
__construct(string $name)

No description

from  Column
static Column
make(string $name)

No description

from  Column
CanWrap
wrap(bool|Closure $condition = true)

No description

from  CanWrap
bool|null
canWrap()

No description

from  CanWrap
HasColor
color(string|array|bool|Closure|null $color)

No description

from  HasColor
HasColor
colors(array|Closure $colors)

No description

from  HasColor
string|array|null
getColor(mixed $state)

No description

HasIcon
icon(string|bool|Closure|null $icon)

No description

from  HasIcon
HasIcon
icons(array|Closure $icons)

No description

from  HasIcon
HasIcon
iconPosition(IconPosition|string|Closure|null $iconPosition)

No description

from  HasIcon
string|null
getIcon(mixed $state)

No description

IconPosition|string
getIconPosition()

No description

from  HasIcon
IconColumn
boolean(bool|Closure $condition = true)

No description

IconColumn
listWithLineBreaks(bool|Closure $condition = true)

No description

IconColumn
false(string|Closure|null $icon = null, string|array|Closure|null $color = null)

No description

IconColumn
falseColor(string|array|Closure|null $color)

No description

IconColumn
falseIcon(string|Closure|null $icon)

No description

IconColumn
true(string|Closure|null $icon = null, string|array|Closure|null $color = null)

No description

IconColumn
trueColor(string|array|Closure|null $color)

No description

IconColumn
trueIcon(string|Closure|null $icon)

No description

IconColumn
options(Arrayable|Closure $options) deprecated

No description

IconColumn
size(IconColumnSize|string|Closure|null $size)

No description

IconColumnSize|string|null
getSize(mixed $state)

No description

string|array
getFalseColor()

No description

string
getFalseIcon()

No description

string|array
getTrueColor()

No description

string
getTrueIcon()

No description

bool
isBoolean()

No description

bool
isListWithLineBreaks()

No description

Details

in Configurable at line 10
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

in Configurable at line 20
Configurable configure()

No description

Return Value

Configurable

in Configurable at line 30
protected void setUp()

No description

Return Value

void

in EvaluatesClosures at line 23
mixed evaluate(mixed $value, array $namedInjections = [], array $typedInjections = [])

No description

Parameters

mixed $value
array $namedInjections
array $typedInjections

Return Value

mixed

in EvaluatesClosures at line 42
protected mixed resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

Parameters

ReflectionParameter $parameter
array $namedInjections
array $typedInjections

Return Value

mixed

in EvaluatesClosures at line 104
protected array resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

Parameters

string $parameterName

Return Value

array

in EvaluatesClosures at line 112
protected array resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

Parameters

string $parameterType

Return Value

array

in EvaluatesClosures at line 117
protected string|null getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

Parameters

ReflectionParameter $parameter

Return Value

string|null

in Macroable at line 17
static void macro(string $name, callable $macro)

No description

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line 22
static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

in Macroable at line 37
static void flushMacros()

No description

Return Value

void

in Macroable at line 45
static mixed __callStatic(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

in Macroable at line 67
mixed __call(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

in Macroable at line 86
static protected callable|null getMacro(string $method)

No description

Parameters

string $method

Return Value

callable|null

in ViewComponent at line 34
ViewComponent view(string|null $view, array $viewData = [])

No description

Parameters

string|null $view
array $viewData

Return Value

ViewComponent

in ViewComponent at line 52
ViewComponent defaultView(string|Closure|null $view)

No description

Parameters

string|Closure|null $view

Return Value

ViewComponent

in ViewComponent at line 62
protected array extractPublicMethods()

No description

Return Value

array

in ViewComponent at line 70
ViewComponent viewData(array $data)

No description

Parameters

array $data

Return Value

ViewComponent

in ViewComponent at line 83
string getView()

No description

Return Value

string

in ViewComponent at line 99
string|null getDefaultView()

No description

Return Value

string|null

in ViewComponent at line 104
string toHtml()

No description

Return Value

string

in ViewComponent at line 109
View render()

No description

Return Value

View

in CanAggregateRelatedModels at line 50
CanAggregateRelatedModels avg(string|array|Closure|null $relationship, string|Closure|null $column)

No description

Parameters

string|array|Closure|null $relationship
string|Closure|null $column

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 61
CanAggregateRelatedModels counts(string|array|Closure|null $relationships)

No description

Parameters

string|array|Closure|null $relationships

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 71
CanAggregateRelatedModels exists(string|array|Closure|null $relationships)

No description

Parameters

string|array|Closure|null $relationships

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 81
CanAggregateRelatedModels max(string|array|Closure|null $relationship, string|Closure|null $column)

No description

Parameters

string|array|Closure|null $relationship
string|Closure|null $column

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 92
CanAggregateRelatedModels min(string|array|Closure|null $relationship, string|Closure|null $column)

No description

Parameters

string|array|Closure|null $relationship
string|Closure|null $column

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 103
CanAggregateRelatedModels sum(string|array|Closure|null $relationship, string|Closure|null $column)

No description

Parameters

string|array|Closure|null $relationship
string|Closure|null $column

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 111
string|null getColumnToAvg()

No description

Return Value

string|null

in CanAggregateRelatedModels at line 119
string|array|null getRelationshipToAvg()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 127
string|array|null getRelationshipsToCount()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 135
string|array|null getRelationshipsToExistenceCheck()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 140
string|null getColumnToMax()

No description

Return Value

string|null

in CanAggregateRelatedModels at line 148
string|array|null getRelationshipToMax()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 153
string|null getColumnToMin()

No description

Return Value

string|null

in CanAggregateRelatedModels at line 161
string|array|null getRelationshipToMin()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 166
string|null getColumnToSum()

No description

Return Value

string|null

in CanAggregateRelatedModels at line 174
string|array|null getRelationshipToSum()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanGrow at line 11
CanGrow grow(bool|Closure|null $condition = true)

No description

Parameters

bool|Closure|null $condition

Return Value

CanGrow

in CanGrow at line 18
bool canGrow(bool $default = true)

No description

Parameters

bool $default

Return Value

bool

in BelongsToGroup at line 11
BelongsToGroup group(ColumnGroup|null $group)

No description

Parameters

ColumnGroup|null $group

Return Value

BelongsToGroup

in BelongsToGroup at line 18
ColumnGroup|null getGroup()

No description

Return Value

ColumnGroup|null

in BelongsToLayout at line 11
BelongsToLayout layout(Component|null $layout)

No description

Parameters

Component|null $layout

Return Value

BelongsToLayout

in BelongsToLayout at line 18
Component|null getLayout()

No description

Return Value

Component|null

in BelongsToTable at line 12
BelongsToTable table(Table|null $table)

No description

Parameters

Table|null $table

Return Value

BelongsToTable

in BelongsToTable at line 19
Table getTable()

No description

Return Value

Table

in BelongsToTable at line 24
HasTable getLivewire()

No description

Return Value

HasTable

in CanBeDisabled at line 13
CanBeDisabled disabled(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

in CanBeDisabled at line 20
CanBeDisabled disabledClick(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

in CanBeDisabled at line 30
CanBeDisabled disableClick(bool|Closure $condition = true) deprecated

deprecated Use `disabledClick()` instead.

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

in CanBeDisabled at line 37
bool isDisabled()

No description

Return Value

bool

in CanBeDisabled at line 42
bool isEnabled()

No description

Return Value

bool

in CanBeDisabled at line 47
bool isClickDisabled()

No description

Return Value

bool

in CanBeHiddenResponsively at line 13
CanBeHiddenResponsively hiddenFrom(string|Closure|null $breakpoint)

No description

Parameters

string|Closure|null $breakpoint

Return Value

CanBeHiddenResponsively

in CanBeHiddenResponsively at line 20
CanBeHiddenResponsively visibleFrom(string|Closure|null $breakpoint)

No description

Parameters

string|Closure|null $breakpoint

Return Value

CanBeHiddenResponsively

in CanBeHiddenResponsively at line 27
string|null getHiddenFrom()

No description

Return Value

string|null

in CanBeHiddenResponsively at line 32
string|null getVisibleFrom()

No description

Return Value

string|null

in CanBeHidden at line 17
CanBeHidden hidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

in CanBeHidden at line 27
CanBeHidden hiddenOn(string|array $livewireComponents)

No description

Parameters

string|array $livewireComponents

Return Value

CanBeHidden

in CanBeHidden at line 42
CanBeHidden visible(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

in CanBeHidden at line 52
CanBeHidden visibleOn(string|array $livewireComponents)

No description

Parameters

string|array $livewireComponents

Return Value

CanBeHidden

in CanBeHidden at line 67
bool isHidden()

No description

Return Value

bool

in CanBeHidden at line 76
bool isVisible()

No description

Return Value

bool

in CanBeInline at line 11
CanBeInline inline(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeInline

in CanBeInline at line 18
bool isInline()

No description

Return Value

bool

in CanBeSearchable at line 28
CanBeSearchable searchable(bool|array|string $condition = true, Closure|null $query = null, bool $isIndividual = false, bool $isGlobal = true)

No description

Parameters

bool|array|string $condition
Closure|null $query
bool $isIndividual
bool $isGlobal

Return Value

CanBeSearchable

in CanBeSearchable at line 49
CanBeSearchable forceSearchCaseInsensitive(bool|Closure|null $condition = true)

No description

Parameters

bool|Closure|null $condition

Return Value

CanBeSearchable

in CanBeSearchable at line 59
array getSearchColumns()

No description

Return Value

array

in CanBeSearchable at line 64
bool isSearchable()

No description

Return Value

bool

in CanBeSearchable at line 69
bool isGloballySearchable()

No description

Return Value

bool

in CanBeSearchable at line 74
bool isIndividuallySearchable()

No description

Return Value

bool

in CanBeSearchable at line 79
bool|null isSearchForcedCaseInsensitive()

No description

Return Value

bool|null

in CanBeSearchable at line 87
array getDefaultSearchColumns()

No description

Return Value

array

in CanBeSortable at line 21
CanBeSortable sortable(bool|array|Closure $condition = true, Closure|null $query = null)

No description

Parameters

bool|array|Closure $condition
Closure|null $query

Return Value

CanBeSortable

in CanBeSortable at line 39
array getSortColumns()

No description

Return Value

array

in CanBeSortable at line 44
bool isSortable()

No description

Return Value

bool

in CanBeSortable at line 52
array getDefaultSortColumns()

No description

Return Value

array

in CanBeSummarized at line 18
CanBeSummarized summarize(Summarizer $summarizers)

No description

Parameters

Summarizer $summarizers

Return Value

CanBeSummarized

in CanBeSummarized at line 33
Summarizer|null getSummarizer(string $id)

No description

Parameters

string $id

Return Value

Summarizer|null

in CanBeSummarized at line 41
array getSummarizers()

No description

Return Value

array

in CanBeSummarized at line 49
bool hasSummary()

No description

Return Value

bool

in CanBeToggled at line 13
CanBeToggled toggleable(bool|Closure $condition = true, bool|Closure $isToggledHiddenByDefault = false)

No description

Parameters

bool|Closure $condition
bool|Closure $isToggledHiddenByDefault

Return Value

CanBeToggled

in CanBeToggled at line 21
CanBeToggled toggledHiddenByDefault(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeToggled

in CanBeToggled at line 28
bool isToggledHiddenByDefault()

No description

Return Value

bool

in CanBeToggled at line 33
bool isToggleable()

No description

Return Value

bool

in CanBeToggled at line 42
bool isToggledHidden()

No description

Return Value

bool

in CanCallAction at line 14
CanCallAction action(Action|string|null $action)

No description

Parameters

Action|string|null $action

Return Value

CanCallAction

in CanCallAction at line 31
Action|null getAction()

No description

Return Value

Action|null

in CanOpenUrl at line 13
CanOpenUrl openUrlInNewTab(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanOpenUrl

in CanOpenUrl at line 20
CanOpenUrl url(string|Closure|null $url, bool|Closure $shouldOpenInNewTab = false)

No description

Parameters

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

Return Value

CanOpenUrl

in CanOpenUrl at line 28
string|null getUrl()

No description

Return Value

string|null

in CanOpenUrl at line 33
bool shouldOpenUrlInNewTab()

No description

Return Value

bool

in CanSpanColumns at line 36
CanSpanColumns columnSpan(array|int|string|Closure|null $span)

No description

Parameters

array|int|string|Closure|null $span

Return Value

CanSpanColumns

in CanSpanColumns at line 52
CanSpanColumns columnSpanFull()

No description

Return Value

CanSpanColumns

in CanSpanColumns at line 62
CanSpanColumns columnStart(array|int|string|Closure|null $start)

No description

Parameters

array|int|string|Closure|null $start

Return Value

CanSpanColumns

in CanSpanColumns at line 81
array|int|string|null getColumnSpan(int|string|null $breakpoint = null)

No description

Parameters

int|string|null $breakpoint

Return Value

array|int|string|null

in CanSpanColumns at line 98
array|int|string|null getColumnStart(int|string|null $breakpoint = null)

No description

Parameters

int|string|null $breakpoint

Return Value

array|int|string|null

in CanWrapHeader at line 11
CanWrapHeader wrapHeader(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanWrapHeader

in CanWrapHeader at line 18
bool isHeaderWrapped()

No description

Return Value

bool

in HasExtraCellAttributes at line 18
HasExtraCellAttributes extraCellAttributes(array|Closure $attributes, bool $merge = false)

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraCellAttributes

in HasExtraCellAttributes at line 32
array getExtraCellAttributes()

No description

Return Value

array

in HasExtraCellAttributes at line 43
ComponentAttributeBag getExtraCellAttributeBag()

No description

Return Value

ComponentAttributeBag

in HasExtraHeaderAttributes at line 18
HasExtraHeaderAttributes extraHeaderAttributes(array|Closure $attributes, bool $merge = false)

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraHeaderAttributes

in HasExtraHeaderAttributes at line 32
array getExtraHeaderAttributes()

No description

Return Value

array

in HasExtraHeaderAttributes at line 43
ComponentAttributeBag getExtraHeaderAttributeBag()

No description

Return Value

ComponentAttributeBag

in HasLabel at line 14
HasLabel label(Htmlable|Closure|null $label)

No description

Parameters

Htmlable|Closure|null $label

Return Value

HasLabel

in HasLabel at line 21
HasLabel translateLabel(bool $shouldTranslateLabel = true)

No description

Parameters

bool $shouldTranslateLabel

Return Value

HasLabel

in HasLabel at line 28
Htmlable getLabel()

No description

Return Value

Htmlable

in HasName at line 9
HasName name(string $name)

No description

Parameters

string $name

Return Value

HasName

in HasName at line 16
string getName()

No description

Return Value

string

in HasRecord at line 11
HasRecord record(Model $record)

No description

Parameters

Model $record

Return Value

HasRecord

in HasRecord at line 18
Model|null getRecord()

No description

Return Value

Model|null

in HasRowLoopObject at line 11
HasRowLoopObject rowLoop(stdClass|null $loop)

No description

Parameters

stdClass|null $loop

Return Value

HasRowLoopObject

in HasRowLoopObject at line 18
stdClass|null getRowLoop()

No description

Return Value

stdClass|null

in HasTooltip at line 11
HasTooltip tooltip(string|Closure|null $tooltip)

No description

Parameters

string|Closure|null $tooltip

Return Value

HasTooltip

in HasTooltip at line 18
string|null getTooltip()

No description

Return Value

string|null

in HasWidth at line 11
HasWidth width(int|string|Closure|null $width)

No description

Parameters

int|string|Closure|null $width

Return Value

HasWidth

in HasWidth at line 18
string|null getWidth()

No description

Return Value

string|null

in InteractsWithTableQuery at line 16
Relation applyRelationshipAggregates(Relation $query)

No description

Parameters

Relation $query

Return Value

Relation

in InteractsWithTableQuery at line 39
Relation applyEagerLoading(Relation $query)

No description

Parameters

Relation $query

Return Value

Relation

in InteractsWithTableQuery at line 54
Builder applySearchConstraint(Builder $query, string $search, bool $isFirst)

No description

Parameters

Builder $query
string $search
bool $isFirst

Return Value

Builder

in InteractsWithTableQuery at line 121
Builder applySort(Builder $query, string $direction = 'asc')

No description

Parameters

Builder $query
string $direction

Return Value

Builder

in InteractsWithTableQuery at line 142
protected Builder getSortColumnForQuery(Builder $query, string $sortColumn, array|null $relationships = null)

No description

Parameters

Builder $query
string $sortColumn
array|null $relationships

Return Value

Builder

in HasAlignment at line 12
HasAlignment alignment(Alignment|string|Closure|null $alignment)

No description

Parameters

Alignment|string|Closure|null $alignment

Return Value

HasAlignment

in HasAlignment at line 19
HasAlignment alignStart(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

in HasAlignment at line 24
HasAlignment alignCenter(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

in HasAlignment at line 29
HasAlignment alignEnd(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

in HasAlignment at line 34
HasAlignment alignJustify(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

in HasAlignment at line 39
HasAlignment alignBetween(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

in HasAlignment at line 44
HasAlignment alignLeft(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

in HasAlignment at line 49
HasAlignment alignRight(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

in HasAlignment at line 54
Alignment|string|null getAlignment()

No description

Return Value

Alignment|string|null

in HasCellState at line 27
HasCellState inverseRelationship(string|null $name)

No description

Parameters

string|null $name

Return Value

HasCellState

in HasCellState at line 34
HasCellState distinctList(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasCellState

in HasCellState at line 41
HasCellState getStateUsing(mixed $callback)

No description

Parameters

mixed $callback

Return Value

HasCellState

in HasCellState at line 48
HasCellState state(mixed $state)

No description

Parameters

mixed $state

Return Value

HasCellState

in HasCellState at line 55
HasCellState default(mixed $state)

No description

Parameters

mixed $state

Return Value

HasCellState

in HasCellState at line 62
bool isDistinctList()

No description

Return Value

bool

in HasCellState at line 67
mixed getDefaultState()

No description

Return Value

mixed

in HasCellState at line 72
mixed getState()

No description

Return Value

mixed

in HasCellState at line 96
mixed getStateFromRecord()

No description

Return Value

mixed

in HasCellState at line 132
HasCellState separator(string|Closure|null $separator = ',')

No description

Parameters

string|Closure|null $separator

Return Value

HasCellState

in HasCellState at line 139
string|null getSeparator()

No description

Return Value

string|null

in HasCellState at line 144
bool hasRelationship(Model $record)

No description

Parameters

Model $record

Return Value

bool

in HasCellState at line 152
bool queriesRelationships(Model $record) deprecated

deprecated Use `hasRelationship()` instead.

No description

Parameters

Model $record

Return Value

bool

in HasCellState at line 157
Relation|null getRelationship(Model $record, string|null $name = null)

No description

Parameters

Model $record
string|null $name

Return Value

Relation|null

in HasCellState at line 183
array getRelationshipResults(Model $record, array|null $relationships = null)

No description

Parameters

Model $record
array|null $relationships

Return Value

array

in HasCellState at line 233
string getRelationshipAttribute(string|null $name = null)

No description

Parameters

string|null $name

Return Value

string

in HasCellState at line 244
string getInverseRelationshipName(Model $record)

No description

Parameters

Model $record

Return Value

string

in HasCellState at line 284
string|null getRelationshipName(string|null $name = null)

No description

Parameters

string|null $name

Return Value

string|null

in HasExtraAttributes at line 18
HasExtraAttributes extraAttributes(array|Closure $attributes, bool $merge = false)

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraAttributes

in HasExtraAttributes at line 32
array getExtraAttributes()

No description

Return Value

array

in HasExtraAttributes at line 43
ComponentAttributeBag getExtraAttributeBag()

No description

Return Value

ComponentAttributeBag

in HasPlaceholder at line 12
HasPlaceholder placeholder(Htmlable|Closure|null $placeholder)

No description

Parameters

Htmlable|Closure|null $placeholder

Return Value

HasPlaceholder

in HasPlaceholder at line 19
Htmlable|null getPlaceholder()

No description

Return Value

Htmlable|null

in HasVerticalAlignment at line 12
HasVerticalAlignment verticalAlignment(VerticalAlignment|string|Closure|null $alignment)

No description

Parameters

VerticalAlignment|string|Closure|null $alignment

Return Value

HasVerticalAlignment

in HasVerticalAlignment at line 19
HasVerticalAlignment verticallyAlignStart(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasVerticalAlignment

in HasVerticalAlignment at line 24
HasVerticalAlignment verticallyAlignCenter(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasVerticalAlignment

in HasVerticalAlignment at line 29
HasVerticalAlignment verticallyAlignEnd(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasVerticalAlignment

in HasVerticalAlignment at line 34
VerticalAlignment|string|null getVerticalAlignment()

No description

Return Value

VerticalAlignment|string|null

in Column at line 56
final __construct(string $name)

No description

Parameters

string $name

in Column at line 61
static Column make(string $name)

No description

Parameters

string $name

Return Value

Column

in CanWrap at line 11
CanWrap wrap(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanWrap

in CanWrap at line 18
bool|null canWrap()

No description

Return Value

bool|null

in HasColor at line 19
HasColor color(string|array|bool|Closure|null $color)

No description

Parameters

string|array|bool|Closure|null $color

Return Value

HasColor

in HasColor at line 29
HasColor colors(array|Closure $colors)

No description

Parameters

array|Closure $colors

Return Value

HasColor

at line 165
string|array|null getColor(mixed $state)

No description

Parameters

mixed $state

Return Value

string|array|null

| array{50: string, 100: string, 200: string, 300: string, 400: string, 500: string, 600: string, 700: string, 800: string, 900: string, 950: string} | null

in HasIcon at line 16
HasIcon icon(string|bool|Closure|null $icon)

No description

Parameters

string|bool|Closure|null $icon

Return Value

HasIcon

in HasIcon at line 26
HasIcon icons(array|Closure $icons)

No description

Parameters

array|Closure $icons

Return Value

HasIcon

in HasIcon at line 49
HasIcon iconPosition(IconPosition|string|Closure|null $iconPosition)

No description

Parameters

IconPosition|string|Closure|null $iconPosition

Return Value

HasIcon

at line 145
string|null getIcon(mixed $state)

No description

Parameters

mixed $state

Return Value

string|null

in HasIcon at line 77
IconPosition|string getIconPosition()

No description

Return Value

IconPosition|string

at line 45
IconColumn boolean(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

IconColumn

at line 52
IconColumn listWithLineBreaks(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

IconColumn

at line 62
IconColumn false(string|Closure|null $icon = null, string|array|Closure|null $color = null)

No description

Parameters

string|Closure|null $icon
string|array|Closure|null $color

Return Value

IconColumn

at line 73
IconColumn falseColor(string|array|Closure|null $color)

No description

Parameters

string|array|Closure|null $color

Return Value

IconColumn

at line 81
IconColumn falseIcon(string|Closure|null $icon)

No description

Parameters

string|Closure|null $icon

Return Value

IconColumn

at line 92
IconColumn true(string|Closure|null $icon = null, string|array|Closure|null $color = null)

No description

Parameters

string|Closure|null $icon
string|array|Closure|null $color

Return Value

IconColumn

at line 103
IconColumn trueColor(string|array|Closure|null $color)

No description

Parameters

string|array|Closure|null $color

Return Value

IconColumn

at line 111
IconColumn trueIcon(string|Closure|null $icon)

No description

Parameters

string|Closure|null $icon

Return Value

IconColumn

at line 124
IconColumn options(Arrayable|Closure $options) deprecated

deprecated Use `icons()` instead.

No description

Parameters

Arrayable|Closure $options

Return Value

IconColumn

at line 131
IconColumn size(IconColumnSize|string|Closure|null $size)

No description

Parameters

IconColumnSize|string|Closure|null $size

Return Value

IconColumn

at line 138
IconColumnSize|string|null getSize(mixed $state)

No description

Parameters

mixed $state

Return Value

IconColumnSize|string|null

at line 185
string|array getFalseColor()

No description

Return Value

string|array

| array{50: string, 100: string, 200: string, 300: string, 400: string, 500: string, 600: string, 700: string, 800: string, 900: string, 950: string}

at line 190
string getFalseIcon()

No description

Return Value

string

at line 200
string|array getTrueColor()

No description

Return Value

string|array

| array{50: string, 100: string, 200: string, 300: string, 400: string, 500: string, 600: string, 700: string, 800: string, 900: string, 950: string}

at line 205
string getTrueIcon()

No description

Return Value

string

at line 212
bool isBoolean()

No description

Return Value

bool

at line 221
bool isListWithLineBreaks()

No description

Return Value

bool