class BadgeColumn extends TextColumn (View source)

deprecated Use `TextColumn` with the `badge()` method instead.

Traits

Properties

protected string $evaluationIdentifier from  EvaluatesClosures
static protected Closure>> $macros from  Macroable
protected string $view from  TextColumn
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 $isCopyable from  CanBeCopied
protected string|Closure|null $copyableState from  CanBeCopied
protected string|Closure|null $copyMessage from  CanBeCopied
protected int|Closure|null $copyMessageDuration from  CanBeCopied
protected Closure|null $formatStateUsing from  CanFormatState
protected int|Closure|null $characterLimit from  CanFormatState
protected string|Closure|null $characterLimitEnd from  CanFormatState
protected int|Closure|null $wordLimit from  CanFormatState
protected string|Closure|null $wordLimitEnd from  CanFormatState
protected Htmlable|Closure|null $prefix from  CanFormatState
protected Htmlable|Closure|null $suffix from  CanFormatState
protected string|Closure|null $timezone from  CanFormatState
protected bool|Closure $isHtml from  CanFormatState
protected bool|Closure $isMarkdown from  CanFormatState
protected bool $isDate from  CanFormatState
protected bool $isDateTime from  CanFormatState
protected bool $isMoney from  CanFormatState
protected bool $isNumeric from  CanFormatState
protected bool $isTime from  CanFormatState
protected string $color from  HasColor
protected Htmlable|Closure|null $descriptionAbove from  HasDescription
protected Htmlable|Closure|null $descriptionBelow from  HasDescription
protected FontFamily|string|Closure|null $fontFamily from  HasFontFamily
protected string|bool|Closure|null $icon from  HasIcon
protected IconPosition|string|Closure|null $iconPosition from  HasIcon
protected string $iconColor from  HasIconColor
protected FontWeight|string|Closure|null $weight from  HasWeight
protected int|Closure|null $lineClamp from  HasLineClamp
protected bool|Closure $canWrap from  TextColumn
protected bool|Closure $isBadge from  TextColumn
protected bool|Closure $isBulleted from  TextColumn
protected bool|Closure $isListWithLineBreaks from  TextColumn
protected int|Closure|null $listLimit from  TextColumn
protected TextColumnSize|string|Closure|null $size from  TextColumn
protected bool|Closure $isLimitedListExpandable from  TextColumn

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

avg(string|array|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|array|Closure|null $relationship, string|Closure|null $column)

No description

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

No description

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

No description

string|null
getColumnToAvg()

No description

string|array|null
getRelationshipToAvg()

No description

string|array|null
getRelationshipsToCount()

No description

string|array|null
string|null
getColumnToMax()

No description

string|array|null
getRelationshipToMax()

No description

string|null
getColumnToMin()

No description

string|array|null
getRelationshipToMin()

No description

string|null
getColumnToSum()

No description

string|array|null
getRelationshipToSum()

No description

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

No description

from  CanGrow
bool
canGrow(bool $default = true)

No description

from  CanGrow
group(ColumnGroup|null $group)

No description

ColumnGroup|null
getGroup()

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

disabled(bool|Closure $condition = true)

No description

disabledClick(bool|Closure $condition = true)

No description

disableClick(bool|Closure $condition = true) deprecated

No description

bool
isDisabled()

No description

bool
isEnabled()

No description

bool
isClickDisabled()

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

hidden(bool|Closure $condition = true)

No description

hiddenOn(string|array $livewireComponents)

No description

visible(bool|Closure $condition = true)

No description

visibleOn(string|array $livewireComponents)

No description

bool
isHidden()

No description

bool
isVisible()

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

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

No description

array
getSearchColumns()

No description

bool
isSearchable()

No description

bool
isGloballySearchable()

No description

bool
isIndividuallySearchable()

No description

bool|null
array
getDefaultSearchColumns()

No description

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

No description

array
getSortColumns()

No description

bool
isSortable()

No description

array
getDefaultSortColumns()

No description

summarize(Summarizer $summarizers)

No description

Summarizer|null
getSummarizer(string $id)

No description

array
getSummarizers()

No description

bool
hasSummary()

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

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

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

No description

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

No description

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

No description

wrapHeader(bool|Closure $condition = true)

No description

bool
isHeaderWrapped()

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
name(string $name)

No description

from  HasName
string
getName()

No description

from  HasName
record(Model $record)

No description

Model|null
getRecord()

No description

rowLoop(stdClass|null $loop)

No description

stdClass|null
getRowLoop()

No description

tooltip(string|Closure|null $tooltip)

No description

string|null
getTooltip()

No description

width(int|string|Closure|null $width)

No description

from  HasWidth
string|null
getWidth()

No description

from  HasWidth
Relation
applyRelationshipAggregates(Relation $query)

No description

Relation
applyEagerLoading(Relation $query)

No description

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

No description

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

No description

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

No description

alignment(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

alignBetween(bool|Closure $condition = true)

No description

alignLeft(bool|Closure $condition = true)

No description

alignRight(bool|Closure $condition = true)

No description

Alignment|string|null
getAlignment()

No description

inverseRelationship(string|null $name)

No description

distinctList(bool|Closure $condition = true)

No description

getStateUsing(mixed $callback)

No description

state(mixed $state)

No description

default(mixed $state)

No description

bool
isDistinctList()

No description

mixed
getDefaultState()

No description

mixed
getState()

No description

mixed
getStateFromRecord()

No description

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

No description

string|null
getSeparator()

No description

bool
hasRelationship(Model $record)

No description

bool
queriesRelationships(Model $record) deprecated

No description

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

No description

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

No description

string
getRelationshipAttribute(string|null $name = null)

No description

string
getInverseRelationshipName(Model $record)

No description

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

No description

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

No description

array
getExtraAttributes()

No description

ComponentAttributeBag
getExtraAttributeBag()

No description

placeholder(Htmlable|Closure|null $placeholder)

No description

Htmlable|null
getPlaceholder()

No description

verticalAlignment(VerticalAlignment|string|Closure|null $alignment)

No description

verticallyAlignStart(bool|Closure $condition = true)

No description

verticallyAlignCenter(bool|Closure $condition = true)

No description

verticallyAlignEnd(bool|Closure $condition = true)

No description

VerticalAlignment|string|null
getVerticalAlignment()

No description

__construct(string $name)

No description

from  Column
static Column
make(string $name)

No description

from  Column
copyable(bool|Closure $condition = true)

No description

copyableState(string|Closure|null $state)

No description

copyMessage(string|Closure|null $message)

No description

copyMessageDuration(int|Closure|null $duration)

No description

bool
isCopyable(mixed $state)

No description

string|null
getCopyableState(mixed $state)

No description

string
getCopyMessage(mixed $state)

No description

int
getCopyMessageDuration(mixed $state)

No description

markdown(bool|Closure $condition = true)

No description

date(string|Closure|null $format = null, string|null $timezone = null)

No description

dateTime(string|Closure|null $format = null, string|null $timezone = null)

No description

since(string|null $timezone = null)

No description

dateTooltip(string|Closure|null $format = null, string|null $timezone = null)

No description

dateTimeTooltip(string|Closure|null $format = null, string|null $timezone = null)

No description

timeTooltip(string|Closure|null $format = null, string|null $timezone = null)

No description

sinceTooltip(string|null $timezone = null)

No description

money(string|Closure|null $currency = null, int $divideBy = 0, string|Closure|null $locale = null)

No description

numeric(int|Closure|null $decimalPlaces = null, ArgumentValue $decimalSeparator = ArgumentValue::Default, ArgumentValue $thousandsSeparator = ArgumentValue::Default, int|Closure|null $maxDecimalPlaces = null, string|Closure|null $locale = null)

No description

time(string|Closure|null $format = null, string|null $timezone = null)

No description

timezone(string|Closure|null $timezone)

No description

limit(int|Closure|null $length = 100, string|Closure|null $end = '...')

No description

words(int|Closure|null $words = 100, string|Closure|null $end = '...')

No description

prefix(Htmlable|Closure|null $prefix)

No description

suffix(Htmlable|Closure|null $suffix)

No description

html(bool|Closure $condition = true)

No description

formatStateUsing(Closure|null $callback)

No description

mixed
formatState(mixed $state)

No description

int|null
getCharacterLimit()

No description

string|null
getCharacterLimitEnd()

No description

int|null
getWordLimit()

No description

string|null
getWordLimitEnd()

No description

string
getTimezone()

No description

bool
isHtml()

No description

Htmlable|null
getPrefix()

No description

Htmlable|null
getSuffix()

No description

bool
isMarkdown()

No description

bool
isDate()

No description

bool
isDateTime()

No description

bool
isMoney()

No description

bool
isNumeric()

No description

bool
isTime()

No description

color(string|array|bool|Closure|null $color)

No description

from  HasColor
colors(array|Closure $colors)

No description

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

No description

from  HasColor
description(Htmlable|Closure|null $description, string|Closure|null $position = 'below')

No description

Htmlable|null
getDescriptionAbove()

No description

Htmlable|null
getDescriptionBelow()

No description

fontFamily(FontFamily|string|Closure|null $family)

No description

FontFamily|string|null
getFontFamily(mixed $state)

No description

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

No description

from  HasIcon
icons(array|Closure $icons)

No description

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

No description

from  HasIcon
string|null
getIcon(mixed $state)

No description

from  HasIcon
IconPosition|string
getIconPosition()

No description

from  HasIcon
iconColor(string|array|Closure|null $color)

No description

string|array|null
getIconColor(mixed $state)

No description

weight(FontWeight|string|Closure|null $weight)

No description

FontWeight|string|null
getWeight(mixed $state)

No description

lineClamp(int|Closure|null $lineClamp)

No description

int|null
getLineClamp()

No description

badge(bool|Closure $condition = true)

No description

bulleted(bool|Closure $condition = true)

No description

listWithLineBreaks(bool|Closure $condition = true)

No description

limitList(int|Closure|null $limit = 3)

No description

rowIndex(bool $isFromZero = false)

No description

wrap(bool|Closure $condition = true)

No description

size(TextColumnSize|string|Closure|null $size)

No description

TextColumnSize|string|null
getSize(mixed $state)

No description

bool
canWrap()

No description

bool
isBadge()

No description

bool
isBulleted()

No description

bool
isListWithLineBreaks()

No description

int|null
getListLimit()

No description

expandableLimitedList(bool|Closure $condition = true)

No description

bool
isLimitedListExpandable()

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

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

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|array|Closure|null $relationship, string|Closure|null $column)

No description

Parameters

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

Return Value

CanAggregateRelatedModels

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

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

string|null getColumnToAvg()

No description

Return Value

string|null

string|array|null getRelationshipToAvg()

No description

Return Value

string|array|null

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

string|array|null getRelationshipsToCount()

No description

Return Value

string|array|null

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

string|array|null getRelationshipsToExistenceCheck()

No description

Return Value

string|array|null

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

string|null getColumnToMax()

No description

Return Value

string|null

string|array|null getRelationshipToMax()

No description

Return Value

string|array|null

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

string|null getColumnToMin()

No description

Return Value

string|null

string|array|null getRelationshipToMin()

No description

Return Value

string|array|null

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

string|null getColumnToSum()

No description

Return Value

string|null

string|array|null getRelationshipToSum()

No description

Return Value

string|array|null

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

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

No description

Parameters

bool|Closure|null $condition

Return Value

CanGrow

bool canGrow(bool $default = true)

No description

Parameters

bool $default

Return Value

bool

BelongsToGroup group(ColumnGroup|null $group)

No description

Parameters

ColumnGroup|null $group

Return Value

BelongsToGroup

ColumnGroup|null getGroup()

No description

Return Value

ColumnGroup|null

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

CanBeDisabled disabled(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

CanBeDisabled disabledClick(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

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

deprecated Use `disabledClick()` instead.

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

CanBeHiddenResponsively hiddenFrom(string|Closure|null $breakpoint)

No description

Parameters

string|Closure|null $breakpoint

Return Value

CanBeHiddenResponsively

CanBeHiddenResponsively visibleFrom(string|Closure|null $breakpoint)

No description

Parameters

string|Closure|null $breakpoint

Return Value

CanBeHiddenResponsively

string|null getHiddenFrom()

No description

Return Value

string|null

string|null getVisibleFrom()

No description

Return Value

string|null

CanBeHidden hidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

CanBeHidden hiddenOn(string|array $livewireComponents)

No description

Parameters

string|array $livewireComponents

Return Value

CanBeHidden

CanBeHidden visible(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

CanBeHidden visibleOn(string|array $livewireComponents)

No description

Parameters

string|array $livewireComponents

Return Value

CanBeHidden

bool isHidden()

No description

Return Value

bool

bool isVisible()

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

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

No description

Parameters

bool|Closure|null $condition

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

bool|null isSearchForcedCaseInsensitive()

No description

Return Value

bool|null

array getDefaultSearchColumns()

No description

Return Value

array

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

No description

Parameters

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

Return Value

CanBeSortable

array getSortColumns()

No description

Return Value

array

bool isSortable()

No description

Return Value

bool

array getDefaultSortColumns()

No description

Return Value

array

CanBeSummarized summarize(Summarizer $summarizers)

No description

Parameters

Summarizer $summarizers

Return Value

CanBeSummarized

Summarizer|null getSummarizer(string $id)

No description

Parameters

string $id

Return Value

Summarizer|null

array getSummarizers()

No description

Return Value

array

bool hasSummary()

No description

Return Value

bool

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

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

CanSpanColumns columnSpanFull()

No description

Return Value

CanSpanColumns

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

No description

Parameters

array|int|string|Closure|null $start

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

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

No description

Parameters

int|string|null $breakpoint

Return Value

array|int|string|null

CanWrapHeader wrapHeader(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanWrapHeader

bool isHeaderWrapped()

No description

Return Value

bool

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

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

HasRowLoopObject rowLoop(stdClass|null $loop)

No description

Parameters

stdClass|null $loop

Return Value

HasRowLoopObject

stdClass|null getRowLoop()

No description

Return Value

stdClass|null

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

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

No description

Parameters

int|string|Closure|null $width

Return Value

HasWidth

string|null getWidth()

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)

No description

Parameters

Builder $query
string $search
bool $isFirst

Return Value

Builder

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

No description

Parameters

Builder $query
string $direction

Return Value

Builder

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

No description

Parameters

Builder $query
string $sortColumn
array|null $relationships

Return Value

Builder

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

No description

Parameters

Alignment|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 alignBetween(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

Alignment|string|null getAlignment()

No description

Return Value

Alignment|string|null

HasCellState inverseRelationship(string|null $name)

No description

Parameters

string|null $name

Return Value

HasCellState

HasCellState distinctList(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasCellState

HasCellState getStateUsing(mixed $callback)

No description

Parameters

mixed $callback

Return Value

HasCellState

HasCellState state(mixed $state)

No description

Parameters

mixed $state

Return Value

HasCellState

HasCellState default(mixed $state)

No description

Parameters

mixed $state

Return Value

HasCellState

bool isDistinctList()

No description

Return Value

bool

mixed getDefaultState()

No description

Return Value

mixed

mixed getState()

No description

Return Value

mixed

mixed getStateFromRecord()

No description

Return Value

mixed

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

No description

Parameters

string|Closure|null $separator

Return Value

HasCellState

string|null getSeparator()

No description

Return Value

string|null

bool hasRelationship(Model $record)

No description

Parameters

Model $record

Return Value

bool

bool queriesRelationships(Model $record) deprecated

deprecated Use `hasRelationship()` instead.

No description

Parameters

Model $record

Return Value

bool

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

No description

Parameters

Model $record
string|null $name

Return Value

Relation|null

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

No description

Parameters

Model $record
array|null $relationships

Return Value

array

string getRelationshipAttribute(string|null $name = null)

No description

Parameters

string|null $name

Return Value

string

string getInverseRelationshipName(Model $record)

No description

Parameters

Model $record

Return Value

string

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

No description

Parameters

string|null $name

Return Value

string|null

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

HasPlaceholder placeholder(Htmlable|Closure|null $placeholder)

No description

Parameters

Htmlable|Closure|null $placeholder

Return Value

HasPlaceholder

Htmlable|null getPlaceholder()

No description

Return Value

Htmlable|null

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

No description

Parameters

VerticalAlignment|string|Closure|null $alignment

Return Value

HasVerticalAlignment

HasVerticalAlignment verticallyAlignStart(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasVerticalAlignment

HasVerticalAlignment verticallyAlignCenter(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasVerticalAlignment

HasVerticalAlignment verticallyAlignEnd(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasVerticalAlignment

VerticalAlignment|string|null getVerticalAlignment()

No description

Return Value

VerticalAlignment|string|null

final __construct(string $name)

No description

Parameters

string $name

static Column make(string $name)

No description

Parameters

string $name

Return Value

Column

CanBeCopied copyable(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeCopied

CanBeCopied copyableState(string|Closure|null $state)

No description

Parameters

string|Closure|null $state

Return Value

CanBeCopied

CanBeCopied copyMessage(string|Closure|null $message)

No description

Parameters

string|Closure|null $message

Return Value

CanBeCopied

CanBeCopied copyMessageDuration(int|Closure|null $duration)

No description

Parameters

int|Closure|null $duration

Return Value

CanBeCopied

bool isCopyable(mixed $state)

No description

Parameters

mixed $state

Return Value

bool

string|null getCopyableState(mixed $state)

No description

Parameters

mixed $state

Return Value

string|null

string getCopyMessage(mixed $state)

No description

Parameters

mixed $state

Return Value

string

int getCopyMessageDuration(mixed $state)

No description

Parameters

mixed $state

Return Value

int

CanFormatState markdown(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanFormatState

CanFormatState date(string|Closure|null $format = null, string|null $timezone = null)

No description

Parameters

string|Closure|null $format
string|null $timezone

Return Value

CanFormatState

CanFormatState dateTime(string|Closure|null $format = null, string|null $timezone = null)

No description

Parameters

string|Closure|null $format
string|null $timezone

Return Value

CanFormatState

CanFormatState since(string|null $timezone = null)

No description

Parameters

string|null $timezone

Return Value

CanFormatState

CanFormatState dateTooltip(string|Closure|null $format = null, string|null $timezone = null)

No description

Parameters

string|Closure|null $format
string|null $timezone

Return Value

CanFormatState

CanFormatState dateTimeTooltip(string|Closure|null $format = null, string|null $timezone = null)

No description

Parameters

string|Closure|null $format
string|null $timezone

Return Value

CanFormatState

CanFormatState timeTooltip(string|Closure|null $format = null, string|null $timezone = null)

No description

Parameters

string|Closure|null $format
string|null $timezone

Return Value

CanFormatState

CanFormatState sinceTooltip(string|null $timezone = null)

No description

Parameters

string|null $timezone

Return Value

CanFormatState

CanFormatState money(string|Closure|null $currency = null, int $divideBy = 0, string|Closure|null $locale = null)

No description

Parameters

string|Closure|null $currency
int $divideBy
string|Closure|null $locale

Return Value

CanFormatState

CanFormatState numeric(int|Closure|null $decimalPlaces = null, ArgumentValue $decimalSeparator = ArgumentValue::Default, ArgumentValue $thousandsSeparator = ArgumentValue::Default, int|Closure|null $maxDecimalPlaces = null, string|Closure|null $locale = null)

No description

Parameters

int|Closure|null $decimalPlaces
ArgumentValue $decimalSeparator
ArgumentValue $thousandsSeparator
int|Closure|null $maxDecimalPlaces
string|Closure|null $locale

Return Value

CanFormatState

CanFormatState time(string|Closure|null $format = null, string|null $timezone = null)

No description

Parameters

string|Closure|null $format
string|null $timezone

Return Value

CanFormatState

CanFormatState timezone(string|Closure|null $timezone)

No description

Parameters

string|Closure|null $timezone

Return Value

CanFormatState

CanFormatState limit(int|Closure|null $length = 100, string|Closure|null $end = '...')

No description

Parameters

int|Closure|null $length
string|Closure|null $end

Return Value

CanFormatState

CanFormatState words(int|Closure|null $words = 100, string|Closure|null $end = '...')

No description

Parameters

int|Closure|null $words
string|Closure|null $end

Return Value

CanFormatState

CanFormatState prefix(Htmlable|Closure|null $prefix)

No description

Parameters

Htmlable|Closure|null $prefix

Return Value

CanFormatState

CanFormatState suffix(Htmlable|Closure|null $suffix)

No description

Parameters

Htmlable|Closure|null $suffix

Return Value

CanFormatState

CanFormatState html(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanFormatState

CanFormatState formatStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

CanFormatState

mixed formatState(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

int|null getCharacterLimit()

No description

Return Value

int|null

string|null getCharacterLimitEnd()

No description

Return Value

string|null

int|null getWordLimit()

No description

Return Value

int|null

string|null getWordLimitEnd()

No description

Return Value

string|null

string getTimezone()

No description

Return Value

string

bool isHtml()

No description

Return Value

bool

Htmlable|null getPrefix()

No description

Return Value

Htmlable|null

Htmlable|null getSuffix()

No description

Return Value

Htmlable|null

bool isMarkdown()

No description

Return Value

bool

bool isDate()

No description

Return Value

bool

bool isDateTime()

No description

Return Value

bool

bool isMoney()

No description

Return Value

bool

bool isNumeric()

No description

Return Value

bool

bool isTime()

No description

Return Value

bool

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

No description

Parameters

string|array|bool|Closure|null $color

Return Value

HasColor

HasColor colors(array|Closure $colors)

No description

Parameters

array|Closure $colors

Return Value

HasColor

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

HasDescription description(Htmlable|Closure|null $description, string|Closure|null $position = 'below')

No description

Parameters

Htmlable|Closure|null $description
string|Closure|null $position

Return Value

HasDescription

Htmlable|null getDescriptionAbove()

No description

Return Value

Htmlable|null

Htmlable|null getDescriptionBelow()

No description

Return Value

Htmlable|null

HasFontFamily fontFamily(FontFamily|string|Closure|null $family)

No description

Parameters

FontFamily|string|Closure|null $family

Return Value

HasFontFamily

FontFamily|string|null getFontFamily(mixed $state)

No description

Parameters

mixed $state

Return Value

FontFamily|string|null

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

No description

Parameters

string|bool|Closure|null $icon

Return Value

HasIcon

HasIcon icons(array|Closure $icons)

No description

Parameters

array|Closure $icons

Return Value

HasIcon

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

No description

Parameters

IconPosition|string|Closure|null $iconPosition

Return Value

HasIcon

string|null getIcon(mixed $state)

No description

Parameters

mixed $state

Return Value

string|null

IconPosition|string getIconPosition()

No description

Return Value

IconPosition|string

HasIconColor iconColor(string|array|Closure|null $color)

No description

Parameters

string|array|Closure|null $color

Return Value

HasIconColor

string|array|null getIconColor(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

HasWeight weight(FontWeight|string|Closure|null $weight)

No description

Parameters

FontWeight|string|Closure|null $weight

Return Value

HasWeight

FontWeight|string|null getWeight(mixed $state)

No description

Parameters

mixed $state

Return Value

FontWeight|string|null

HasLineClamp lineClamp(int|Closure|null $lineClamp)

No description

Parameters

int|Closure|null $lineClamp

Return Value

HasLineClamp

int|null getLineClamp()

No description

Return Value

int|null

TextColumn badge(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

TextColumn

TextColumn bulleted(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

TextColumn

TextColumn listWithLineBreaks(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

TextColumn

TextColumn limitList(int|Closure|null $limit = 3)

No description

Parameters

int|Closure|null $limit

Return Value

TextColumn

TextColumn rowIndex(bool $isFromZero = false)

No description

Parameters

bool $isFromZero

Return Value

TextColumn

TextColumn wrap(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

TextColumn

TextColumn size(TextColumnSize|string|Closure|null $size)

No description

Parameters

TextColumnSize|string|Closure|null $size

Return Value

TextColumn

TextColumnSize|string|null getSize(mixed $state)

No description

Parameters

mixed $state

Return Value

TextColumnSize|string|null

bool canWrap()

No description

Return Value

bool

bool isBadge()

No description

Return Value

bool

bool isBulleted()

No description

Return Value

bool

bool isListWithLineBreaks()

No description

Return Value

bool

int|null getListLimit()

No description

Return Value

int|null

TextColumn expandableLimitedList(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

TextColumn

bool isLimitedListExpandable()

No description

Return Value

bool