class IconColumn extends Column (View source)

Traits

Properties

static protected array $configurations from  Configurable
static protected array $importantConfigurations from  Configurable
protected string $evaluationIdentifier from  EvaluatesClosures
protected array $evaluationParametersToRemove from  EvaluatesClosures
protected string $view
protected array $viewData from  ViewComponent
protected string $viewIdentifier from  Column
static protected array $propertyCache from  ViewComponent
static protected array $methodCache from  ViewComponent
protected Component|null $layout from  BelongsToLayout
protected Table|null $table from  BelongsToTable
protected string|Closure|null $columnToAvg from  CanAggregateRelatedModels
protected string|Closure|null $relationshipToAvg from  CanAggregateRelatedModels
protected string|array|Closure|null $relationshipsToCount from  CanAggregateRelatedModels
protected string|array|Closure|null $relationshipsToExistenceCheck from  CanAggregateRelatedModels
protected string|Closure|null $columnToMax from  CanAggregateRelatedModels
protected string|Closure|null $relationshipToMax from  CanAggregateRelatedModels
protected string|Closure|null $columnToMin from  CanAggregateRelatedModels
protected string|Closure|null $relationshipToMin from  CanAggregateRelatedModels
protected string|Closure|null $columnToSum from  CanAggregateRelatedModels
protected string|Closure|null $relationshipToSum from  CanAggregateRelatedModels
protected bool|Closure $isDisabled from  CanBeDisabled
protected bool|Closure $isClickDisabled from  CanBeDisabled
protected string|Closure|null $hiddenFrom from  CanBeHidden
protected bool|Closure $isHidden from  CanBeHidden
protected string|Closure|null $visibleFrom 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 array|null $searchColumns from  CanBeSearchable
protected Closure|null $searchQuery from  CanBeSearchable
protected bool $isSortable from  CanBeSortable
protected array|null $sortColumns from  CanBeSortable
protected Closure|null $sortQuery from  CanBeSortable
protected bool|Closure $isToggleable from  CanBeToggled
protected bool|Closure $isToggledHiddenByDefault from  CanBeToggled
protected Action|string|null $action from  CanCallAction
protected bool|Closure $canGrow from  CanGrow
protected bool|Closure $shouldOpenUrlInNewTab from  CanOpenUrl
protected string|Closure|null $url from  CanOpenUrl
protected array $columnSpan from  CanSpanColumns
protected string|Closure|null $alignment from  HasAlignment
protected array $extraCellAttributes from  HasExtraCellAttributes
protected array $extraHeaderAttributes from  HasExtraHeaderAttributes
protected Htmlable|Closure|null $label from  HasLabel
protected bool $shouldTranslateLabel from  HasLabel
protected stdClass|null $loop from  HasRowLoopObject
protected string $name from  HasName
protected Model|null $record from  HasRecord
protected $defaultState from  HasState
protected Closure|null $getStateUsing from  HasState
protected string|Closure|null $tooltip from  HasTooltip
protected array $extraAttributes from  HasExtraAttributes
protected string|Closure|null $color from  HasColors
protected string|Closure|null $size from  HasSize
protected Arrayable|Closure $options
protected bool|Closure $isBoolean
protected string|Closure|null $falseColor
protected string|Closure|null $falseIcon
protected string|Closure|null $trueColor
protected string|Closure|null $trueIcon

Methods

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

No description

configure()

No description

void
setUp()

No description

evaluate($value, array $parameters = [], array $exceptParameters = [])

No description

array
resolveEvaluationParameter(string $parameter, Closure $value)

No description

bool
isEvaluationParameterRemoved(string $parameter)

No description

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

No description

array
extractPublicProperties()

No description

array
extractPublicMethods()

No description

viewData(array $data)

No description

string
getView()

No description

string
toHtml()

No description

View
render()

No description

layout(Component|null $layout)

No description

Component|null
getLayout()

No description

table(Table|null $table)

No description

getTable()

No description

getLivewire()

No description

avg(string|Closure|null $relationship, string|Closure|null $column)

No description

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

No description

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

No description

max(string|Closure|null $relationship, string|Closure|null $column)

No description

min(string|Closure|null $relationship, string|Closure|null $column)

No description

sum(string|Closure|null $relationship, string|Closure|null $column)

No description

string|null
getColumnToAvg()

No description

string|null
getRelationshipToAvg()

No description

string|array|null
getRelationshipsToCount()

No description

string|array|null
string|null
getColumnToMax()

No description

string|null
getRelationshipToMax()

No description

string|null
getColumnToMin()

No description

string|null
getRelationshipToMin()

No description

string|null
getColumnToSum()

No description

string|null
getRelationshipToSum()

No description

disabled(bool|Closure $condition = true)

No description

disableClick(bool|Closure $condition = true)

No description

bool
isDisabled()

No description

bool
isEnabled()

No description

bool
isClickDisabled()

No description

hidden(bool|Closure $condition = true)

No description

visible(bool|Closure $condition = true)

No description

hiddenFrom(string|Closure|null $breakpoint)

No description

visibleFrom(string|Closure|null $breakpoint)

No description

string|null
getHiddenFrom()

No description

string|null
getVisibleFrom()

No description

bool
isHidden()

No description

inline(bool|Closure $condition = true)

No description

bool
isInline()

No description

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

No description

array
getSearchColumns()

No description

bool
isSearchable()

No description

bool
isGloballySearchable()

No description

bool
isIndividuallySearchable()

No description

array
getDefaultSearchColumns()

No description

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

No description

array
getSortColumns()

No description

bool
isSortable()

No description

array
getDefaultSortColumns()

No description

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

No description

toggledHiddenByDefault(bool|Closure $condition = true)

No description

bool
isToggledHiddenByDefault()

No description

bool
isToggleable()

No description

bool
isToggledHidden()

No description

action(Action|string|null $action)

No description

Action|null
getAction()

No description

grow(bool|Closure $condition = true)

No description

from  CanGrow
bool
canGrow()

No description

from  CanGrow
openUrlInNewTab(bool|Closure $condition = true)

No description

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

No description

string|null
getUrl()

No description

bool
shouldOpenUrlInNewTab()

No description

columnSpan(array|int|string|Closure|null $span)

No description

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

No description

alignment(string|Closure|null $alignment)

No description

alignStart(bool|Closure $condition = true)

No description

alignCenter(bool|Closure $condition = true)

No description

alignEnd(bool|Closure $condition = true)

No description

alignJustify(bool|Closure $condition = true)

No description

alignLeft(bool|Closure $condition = true)

No description

alignRight(bool|Closure $condition = true)

No description

string|null
getAlignment()

No description

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

No description

array
getExtraCellAttributes()

No description

ComponentAttributeBag
getExtraCellAttributeBag()

No description

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

No description

ComponentAttributeBag
getExtraHeaderAttributeBag()

No description

label(Htmlable|Closure|null $label)

No description

from  HasLabel
translateLabel(bool $shouldTranslateLabel = true)

No description

from  HasLabel
Htmlable
getLabel()

No description

from  HasLabel
rowLoop(stdClass|null $loop)

No description

stdClass|null
getRowLoop()

No description

name(string $name)

No description

from  HasName
string
getName()

No description

from  HasName
record(Model $record)

No description

Model|null
getRecord()

No description

getStateUsing(Closure|null $callback)

No description

from  HasState
default($state)

No description

from  HasState
getDefaultState()

No description

from  HasState
getState()

No description

from  HasState
getStateFromRecord()

No description

from  HasState
mutateArrayState(array $state)

No description

from  HasState
tooltip(string|Closure|null $tooltip)

No description

string|null
getTooltip()

No description

Relation
applyRelationshipAggregates(Relation $query)

No description

Relation
applyEagerLoading(Relation $query)

No description

Builder
applySearchConstraint(Builder $query, string $search, bool $isFirst, bool $isIndividual = false)

No description

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

No description

bool
queriesRelationships(Model $record)

No description

Relation|null
getRelationship(Model $record)

No description

string
getRelationshipName()

No description

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

No description

array
getExtraAttributes()

No description

ComponentAttributeBag
getExtraAttributeBag()

No description

__construct(string $name)

No description

from  Column
static Column
make(string $name)

No description

from  Column
color(string|Closure|null $color)

No description

colors(array|Closure $colors)

No description

string|null
getStateColor()

No description

size(string|Closure|null $size)

No description

from  HasSize
string|null
getSize()

No description

from  HasSize
options(Arrayable|Closure $options)

No description

boolean(bool|Closure $condition = true)

No description

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

No description

falseColor(string|Closure|null $color)

No description

falseIcon(string|Closure|null $icon)

No description

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

No description

trueColor(string|Closure|null $color)

No description

trueIcon(string|Closure|null $icon)

No description

string|null
getStateIcon()

No description

array
getOptions()

No description

string
getFalseColor()

No description

string
getFalseIcon()

No description

string
getTrueColor()

No description

string
getTrueIcon()

No description

bool
isBoolean()

No description

Details

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

No description

Parameters

Closure $callback
Closure|null $during
bool $isImportant

Configurable configure()

No description

Return Value

Configurable

protected void setUp()

No description

Return Value

void

evaluate($value, array $parameters = [], array $exceptParameters = [])

No description

Parameters

$value
array $parameters
array $exceptParameters

protected array getDefaultEvaluationParameters()

No description

Return Value

array

protected resolveEvaluationParameter(string $parameter, Closure $value)

No description

Parameters

string $parameter
Closure $value

protected bool isEvaluationParameterRemoved(string $parameter)

No description

Parameters

string $parameter

Return Value

bool

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

No description

Parameters

string $view
array $viewData

Return Value

ViewComponent

protected array extractPublicProperties()

No description

Return Value

array

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 toHtml()

No description

Return Value

string

View render()

No description

Return Value

View

BelongsToLayout layout(Component|null $layout)

No description

Parameters

Component|null $layout

Return Value

BelongsToLayout

Component|null getLayout()

No description

Return Value

Component|null

BelongsToTable table(Table|null $table)

No description

Parameters

Table|null $table

Return Value

BelongsToTable

Table getTable()

No description

Return Value

Table

HasTable getLivewire()

No description

Return Value

HasTable

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

No description

Parameters

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

Return Value

CanAggregateRelatedModels

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

No description

Parameters

string|array|Closure|null $relationships

Return Value

CanAggregateRelatedModels

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

No description

Parameters

string|array|Closure|null $relationships

Return Value

CanAggregateRelatedModels

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

No description

Parameters

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

Return Value

CanAggregateRelatedModels

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

No description

Parameters

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

Return Value

CanAggregateRelatedModels

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

No description

Parameters

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

Return Value

CanAggregateRelatedModels

string|null getColumnToAvg()

No description

Return Value

string|null

string|null getRelationshipToAvg()

No description

Return Value

string|null

string|array|null getRelationshipsToCount()

No description

Return Value

string|array|null

string|array|null getRelationshipsToExistenceCheck()

No description

Return Value

string|array|null

string|null getColumnToMax()

No description

Return Value

string|null

string|null getRelationshipToMax()

No description

Return Value

string|null

string|null getColumnToMin()

No description

Return Value

string|null

string|null getRelationshipToMin()

No description

Return Value

string|null

string|null getColumnToSum()

No description

Return Value

string|null

string|null getRelationshipToSum()

No description

Return Value

string|null

CanBeDisabled disabled(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

CanBeDisabled disableClick(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

bool isDisabled()

No description

Return Value

bool

bool isEnabled()

No description

Return Value

bool

bool isClickDisabled()

No description

Return Value

bool

CanBeHidden hidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

CanBeHidden visible(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

CanBeHidden hiddenFrom(string|Closure|null $breakpoint)

No description

Parameters

string|Closure|null $breakpoint

Return Value

CanBeHidden

CanBeHidden visibleFrom(string|Closure|null $breakpoint)

No description

Parameters

string|Closure|null $breakpoint

Return Value

CanBeHidden

string|null getHiddenFrom()

No description

Return Value

string|null

string|null getVisibleFrom()

No description

Return Value

string|null

bool isHidden()

No description

Return Value

bool

CanBeInline inline(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeInline

bool isInline()

No description

Return Value

bool

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

array getSearchColumns()

No description

Return Value

array

bool isSearchable()

No description

Return Value

bool

bool isGloballySearchable()

No description

Return Value

bool

bool isIndividuallySearchable()

No description

Return Value

bool

protected array getDefaultSearchColumns()

No description

Return Value

array

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

No description

Parameters

bool|array $condition
Closure|null $query

Return Value

CanBeSortable

array getSortColumns()

No description

Return Value

array

bool isSortable()

No description

Return Value

bool

protected array getDefaultSortColumns()

No description

Return Value

array

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

No description

Parameters

bool|Closure $condition
bool|Closure $isToggledHiddenByDefault

Return Value

CanBeToggled

CanBeToggled toggledHiddenByDefault(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeToggled

bool isToggledHiddenByDefault()

No description

Return Value

bool

bool isToggleable()

No description

Return Value

bool

bool isToggledHidden()

No description

Return Value

bool

CanCallAction action(Action|string|null $action)

No description

Parameters

Action|string|null $action

Return Value

CanCallAction

Action|null getAction()

No description

Return Value

Action|null

CanGrow grow(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanGrow

bool canGrow()

No description

Return Value

bool

CanOpenUrl openUrlInNewTab(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanOpenUrl

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

No description

Parameters

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

Return Value

CanOpenUrl

string|null getUrl()

No description

Return Value

string|null

bool shouldOpenUrlInNewTab()

No description

Return Value

bool

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

No description

Parameters

array|int|string|Closure|null $span

Return Value

CanSpanColumns

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

No description

Parameters

int|string|null $breakpoint

Return Value

array|int|string|null

HasAlignment alignment(string|Closure|null $alignment)

No description

Parameters

string|Closure|null $alignment

Return Value

HasAlignment

HasAlignment alignStart(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

HasAlignment alignCenter(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

HasAlignment alignEnd(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

HasAlignment alignJustify(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

HasAlignment alignLeft(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

HasAlignment alignRight(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAlignment

string|null getAlignment()

No description

Return Value

string|null

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

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraCellAttributes

array getExtraCellAttributes()

No description

Return Value

array

ComponentAttributeBag getExtraCellAttributeBag()

No description

Return Value

ComponentAttributeBag

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

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraHeaderAttributes

array getExtraHeaderAttributes()

No description

Return Value

array

ComponentAttributeBag getExtraHeaderAttributeBag()

No description

Return Value

ComponentAttributeBag

HasLabel label(Htmlable|Closure|null $label)

No description

Parameters

Htmlable|Closure|null $label

Return Value

HasLabel

HasLabel translateLabel(bool $shouldTranslateLabel = true)

No description

Parameters

bool $shouldTranslateLabel

Return Value

HasLabel

Htmlable getLabel()

No description

Return Value

Htmlable

HasRowLoopObject rowLoop(stdClass|null $loop)

No description

Parameters

stdClass|null $loop

Return Value

HasRowLoopObject

stdClass|null getRowLoop()

No description

Return Value

stdClass|null

HasName name(string $name)

No description

Parameters

string $name

Return Value

HasName

string getName()

No description

Return Value

string

HasRecord record(Model $record)

No description

Parameters

Model $record

Return Value

HasRecord

Model|null getRecord()

No description

Return Value

Model|null

HasState getStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

HasState default($state)

No description

Parameters

$state

Return Value

HasState

getDefaultState()

No description

getState()

No description

protected getStateFromRecord()

No description

protected mutateArrayState(array $state)

No description

Parameters

array $state

HasTooltip tooltip(string|Closure|null $tooltip)

No description

Parameters

string|Closure|null $tooltip

Return Value

HasTooltip

string|null getTooltip()

No description

Return Value

string|null

Relation applyRelationshipAggregates(Relation $query)

No description

Parameters

Relation $query

Return Value

Relation

Relation applyEagerLoading(Relation $query)

No description

Parameters

Relation $query

Return Value

Relation

Builder applySearchConstraint(Builder $query, string $search, bool $isFirst, bool $isIndividual = false)

No description

Parameters

Builder $query
string $search
bool $isFirst
bool $isIndividual

Return Value

Builder

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

No description

Parameters

Builder $query
string $direction

Return Value

Builder

bool queriesRelationships(Model $record)

No description

Parameters

Model $record

Return Value

bool

Relation|null getRelationship(Model $record)

No description

Parameters

Model $record

Return Value

Relation|null

string getRelationshipTitleColumnName()

No description

Return Value

string

string getRelationshipName()

No description

Return Value

string

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

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraAttributes

array getExtraAttributes()

No description

Return Value

array

ComponentAttributeBag getExtraAttributeBag()

No description

Return Value

ComponentAttributeBag

final __construct(string $name)

No description

Parameters

string $name

static Column make(string $name)

No description

Parameters

string $name

Return Value

Column

HasColors color(string|Closure|null $color)

No description

Parameters

string|Closure|null $color

Return Value

HasColors

HasColors colors(array|Closure $colors)

No description

Parameters

array|Closure $colors

Return Value

HasColors

string|null getStateColor()

No description

Return Value

string|null

HasSize size(string|Closure|null $size)

No description

Parameters

string|Closure|null $size

Return Value

HasSize

string|null getSize()

No description

Return Value

string|null

IconColumn options(Arrayable|Closure $options)

No description

Parameters

Arrayable|Closure $options

Return Value

IconColumn

IconColumn boolean(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

IconColumn

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

No description

Parameters

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

Return Value

IconColumn

IconColumn falseColor(string|Closure|null $color)

No description

Parameters

string|Closure|null $color

Return Value

IconColumn

IconColumn falseIcon(string|Closure|null $icon)

No description

Parameters

string|Closure|null $icon

Return Value

IconColumn

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

No description

Parameters

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

Return Value

IconColumn

IconColumn trueColor(string|Closure|null $color)

No description

Parameters

string|Closure|null $color

Return Value

IconColumn

IconColumn trueIcon(string|Closure|null $icon)

No description

Parameters

string|Closure|null $icon

Return Value

IconColumn

string|null getStateIcon()

No description

Return Value

string|null

array getOptions()

No description

Return Value

array

string getFalseColor()

No description

Return Value

string

string getFalseIcon()

No description

Return Value

string

string getTrueColor()

No description

Return Value

string

string getTrueIcon()

No description

Return Value

string

bool isBoolean()

No description

Return Value

bool