1. class
  2. Filament
  3. \
  4. Infolists
  5. \
  6. Components
  7. \
  8. Component

Component

class Component extends ViewComponent (View source)

Traits

CanGrow
BelongsToContainer
CanBeHidden
CanSpanColumns
Cloneable
HasActions
HasChildComponents
HasEntryWrapper
HasId
HasInlineLabel
HasKey
HasLabel
HasMaxWidth
HasMeta
HasState
HasColumns
HasExtraAttributes
CanGetStateFromRelationships
Conditionable
Configurable
EvaluatesClosures
Macroable
Tappable

Properties

protected string $evaluationIdentifier
static protected Closure>> $macros from  Macroable
protected string $view from  ViewComponent
protected string|Closure|null $defaultView from  ViewComponent
protected array<string,mixed> $viewData from  ViewComponent
protected string $viewIdentifier from  ViewComponent
protected bool|Closure|null $canGrow from  CanGrow
protected ComponentContainer $container from  BelongsToContainer
protected bool|Closure $isHidden from  CanBeHidden
protected bool|Closure $isVisible from  CanBeHidden
protected array $columnSpan from  CanSpanColumns
protected array $columnStart from  CanSpanColumns
protected Action[] $cachedActions from  HasActions
protected array $actions from  HasActions
protected Action|null $action from  HasActions
protected Component[] $childComponents from  HasChildComponents
protected string|Closure|null $entryWrapperView from  HasEntryWrapper
protected string|Closure|null $id from  HasId
protected bool|Closure|null $hasInlineLabel from  HasInlineLabel
protected string|Closure|null $key from  HasKey
protected bool|Closure $isLabelHidden from  HasLabel
protected Htmlable|Closure|null $label from  HasLabel
protected bool $shouldTranslateLabel from  HasLabel
protected MaxWidth|string|Closure|null $maxWidth from  HasMaxWidth
protected array<string,mixed> $meta from  HasMeta
protected mixed $defaultState from  HasState
protected mixed $getStateUsing from  HasState
protected string|null $statePath from  HasState
protected string|Closure|null $separator from  HasState
protected bool|Closure $isDistinctList from  HasState
protected string $cachedAbsoluteStatePath from  HasState
protected array|null $columns from  HasColumns
protected array $extraAttributes from  HasExtraAttributes

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

array
resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

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
CanGrow
grow(bool|Closure|null $condition = true)

No description

from  CanGrow
bool
canGrow(bool $default = true)

No description

from  CanGrow
BelongsToContainer
container(ComponentContainer $container)

No description

from  BelongsToContainer
ComponentContainer
getContainer()

No description

from  BelongsToContainer
Infolist
getInfolist()

No description

from  BelongsToContainer
Component|null
getLivewire()

No description

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

No description

from  CanBeHidden
CanBeHidden
hiddenWhenAllChildComponentsHidden()

No description

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

No description

from  CanBeHidden
bool
isHidden()

No description

from  CanBeHidden
bool
isVisible()

No description

from  CanBeHidden
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
Cloneable
cloneChildComponents()

No description

from  Cloneable
Cloneable
getClone()

No description

from  Cloneable
HasActions
action(Action|null $action)

No description

from  HasActions
HasActions
registerActions(array $actions)

No description

from  HasActions
Action|null
getAction(string|array|null $name = null)

No description

from  HasActions
array
getActions()

No description

from  HasActions
array
cacheActions()

No description

from  HasActions
Action
prepareAction(Action $action)

No description

from  HasActions
HasChildComponents
childComponents(array|Closure $components)

No description

from  HasChildComponents
HasChildComponents
schema(array|Closure $components)

No description

from  HasChildComponents
array
getChildComponents()

No description

from  HasChildComponents
ComponentContainer
getChildComponentContainer(array-key $key = null)

No description

from  HasChildComponents
array
getChildComponentContainers(bool $withHidden = false)

No description

from  HasChildComponents
bool
hasChildComponentContainer(bool $withHidden = false)

No description

from  HasChildComponents
HasEntryWrapper
entryWrapperView(string|Closure|null $view)

No description

from  HasEntryWrapper
string
getEntryWrapperView()

No description

from  HasEntryWrapper
string|null
getCustomEntryWrapperView()

No description

from  HasEntryWrapper
HasId
id(string|Closure|null $id)

No description

from  HasId
string|null
getId()

No description

from  HasId
HasInlineLabel
inlineLabel(bool|Closure|null $condition = true)

No description

from  HasInlineLabel
bool|null
hasInlineLabel()

No description

from  HasInlineLabel
HasKey
key(string|Closure|null $key)

No description

from  HasKey
string|null
getKey()

No description

from  HasKey
HasLabel
hiddenLabel(bool|Closure $condition = true)

No description

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

No description

from  HasLabel
HasLabel
translateLabel(bool $shouldTranslateLabel = true)

No description

from  HasLabel
Htmlable|null
getLabel()

No description

from  HasLabel
bool
isLabelHidden()

No description

from  HasLabel
HasMaxWidth
maxWidth(MaxWidth|string|Closure|null $width)

No description

from  HasMaxWidth
MaxWidth|string|null
getMaxWidth()

No description

from  HasMaxWidth
HasMeta
meta(string $key, mixed $value)

No description

from  HasMeta
mixed
getMeta(string|array|null $keys = null)

No description

from  HasMeta
bool
hasMeta(string|array $keys)

No description

from  HasMeta
bool
hasRelationship(Model $record)

No description

from  CanGetStateFromRelationships
Relation|null
getRelationship(Model $record, string|null $statePath = null)

No description

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

No description

from  CanGetStateFromRelationships
string
getRelationshipAttribute(string|null $statePath = null)

No description

from  CanGetStateFromRelationships
string|null
getRelationshipName(string|null $statePath = null)

No description

from  CanGetStateFromRelationships
HasState
getStateUsing(mixed $callback)

No description

from  HasState
HasState
state(mixed $state)

No description

from  HasState
HasState
default(mixed $state)

No description

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

No description

from  HasState
bool
isDistinctList()

No description

from  HasState
mixed
getDefaultState()

No description

from  HasState
mixed
getState()

No description

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

No description

from  HasState
HasState
statePath(string|null $path)

No description

from  HasState
string|null
getSeparator()

No description

from  HasState
Model|null
getRecord()

No description

from  HasState
bool
hasStatePath()

No description

from  HasState
string
getStatePath(bool $isAbsolute = true)

No description

from  HasState
mixed
getStateFromRecord(Model $record)

No description

from  HasState
void
flushCachedAbsoluteStatePath()

No description

from  HasState
HasColumns
columns(array|int|null $columns = 2)

No description

from  HasColumns
array|int|null
getColumns(string|null $breakpoint = null)

No description

from  HasColumns
array
getColumnsConfig()

No description

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

No description

from  HasExtraAttributes
array
getExtraAttributes()

No description

from  HasExtraAttributes
ComponentAttributeBag
getExtraAttributeBag()

No description

from  HasExtraAttributes

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

at line 36
protected array resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

Parameters

string $parameterName

Return Value

array

at line 48
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 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 BelongsToContainer at line 13
BelongsToContainer container(ComponentContainer $container)

No description

Parameters

ComponentContainer $container

Return Value

BelongsToContainer

in BelongsToContainer at line 20
ComponentContainer getContainer()

No description

Return Value

ComponentContainer

in BelongsToContainer at line 25
Infolist getInfolist()

No description

Return Value

Infolist

in BelongsToContainer at line 30
Component|null getLivewire()

No description

Return Value

Component|null

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

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

in CanBeHidden at line 21
CanBeHidden hiddenWhenAllChildComponentsHidden()

No description

Return Value

CanBeHidden

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

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

in CanBeHidden at line 43
bool isHidden()

No description

Return Value

bool

in CanBeHidden at line 52
bool isVisible()

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 Cloneable at line 9
protected Cloneable cloneChildComponents()

No description

Return Value

Cloneable

in Cloneable at line 21
Cloneable getClone()

No description

Return Value

Cloneable

in HasActions at line 27
HasActions action(Action|null $action)

No description

Parameters

Action|null $action

Return Value

HasActions

in HasActions at line 41
HasActions registerActions(array $actions)

No description

Parameters

array $actions

Return Value

HasActions

in HasActions at line 54
Action|null getAction(string|array|null $name = null)

No description

Parameters

string|array|null $name

Return Value

Action|null

in HasActions at line 99
array getActions()

No description

Return Value

array

in HasActions at line 107
array cacheActions()

No description

Return Value

array

in HasActions at line 149
Action prepareAction(Action $action)

No description

Parameters

Action $action

Return Value

Action

in HasChildComponents at line 19
HasChildComponents childComponents(array|Closure $components)

No description

Parameters

array|Closure $components

Return Value

HasChildComponents

in HasChildComponents at line 29
HasChildComponents schema(array|Closure $components)

No description

Parameters

array|Closure $components

Return Value

HasChildComponents

in HasChildComponents at line 39
array getChildComponents()

No description

Return Value

array

in HasChildComponents at line 47
ComponentContainer getChildComponentContainer(array-key $key = null)

No description

Parameters

array-key $key

Return Value

ComponentContainer

in HasChildComponents at line 61
array getChildComponentContainers(bool $withHidden = false)

No description

Parameters

bool $withHidden

Return Value

array

in HasChildComponents at line 70
bool hasChildComponentContainer(bool $withHidden = false)

No description

Parameters

bool $withHidden

Return Value

bool

in HasEntryWrapper at line 11
HasEntryWrapper entryWrapperView(string|Closure|null $view)

No description

Parameters

string|Closure|null $view

Return Value

HasEntryWrapper

in HasEntryWrapper at line 18
string getEntryWrapperView()

No description

Return Value

string

in HasEntryWrapper at line 25
string|null getCustomEntryWrapperView()

No description

Return Value

string|null

in HasId at line 11
HasId id(string|Closure|null $id)

No description

Parameters

string|Closure|null $id

Return Value

HasId

in HasId at line 18
string|null getId()

No description

Return Value

string|null

in HasInlineLabel at line 11
HasInlineLabel inlineLabel(bool|Closure|null $condition = true)

No description

Parameters

bool|Closure|null $condition

Return Value

HasInlineLabel

in HasInlineLabel at line 18
bool|null hasInlineLabel()

No description

Return Value

bool|null

in HasKey at line 11
HasKey key(string|Closure|null $key)

No description

Parameters

string|Closure|null $key

Return Value

HasKey

in HasKey at line 18
string|null getKey()

No description

Return Value

string|null

in HasLabel at line 16
HasLabel hiddenLabel(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasLabel

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

No description

Parameters

Htmlable|Closure|null $label

Return Value

HasLabel

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

No description

Parameters

bool $shouldTranslateLabel

Return Value

HasLabel

in HasLabel at line 37
Htmlable|null getLabel()

No description

Return Value

Htmlable|null

in HasLabel at line 46
bool isLabelHidden()

No description

Return Value

bool

in HasMaxWidth at line 12
HasMaxWidth maxWidth(MaxWidth|string|Closure|null $width)

No description

Parameters

MaxWidth|string|Closure|null $width

Return Value

HasMaxWidth

in HasMaxWidth at line 19
MaxWidth|string|null getMaxWidth()

No description

Return Value

MaxWidth|string|null

in HasMeta at line 14
HasMeta meta(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

HasMeta

in HasMeta at line 24
mixed getMeta(string|array|null $keys = null)

No description

Parameters

string|array|null $keys

Return Value

mixed

in HasMeta at line 40
bool hasMeta(string|array $keys)

No description

Parameters

string|array $keys

Return Value

bool

in CanGetStateFromRelationships at line 11
bool hasRelationship(Model $record)

No description

Parameters

Model $record

Return Value

bool

in CanGetStateFromRelationships at line 16
Relation|null getRelationship(Model $record, string|null $statePath = null)

No description

Parameters

Model $record
string|null $statePath

Return Value

Relation|null

in CanGetStateFromRelationships at line 42
array getRelationshipResults(Model $record, array|null $relationships = null)

No description

Parameters

Model $record
array|null $relationships

Return Value

array

in CanGetStateFromRelationships at line 92
string getRelationshipAttribute(string|null $statePath = null)

No description

Parameters

string|null $statePath

Return Value

string

in CanGetStateFromRelationships at line 103
string|null getRelationshipName(string|null $statePath = null)

No description

Parameters

string|null $statePath

Return Value

string|null

in HasState at line 25
HasState getStateUsing(mixed $callback)

No description

Parameters

mixed $callback

Return Value

HasState

in HasState at line 32
HasState state(mixed $state)

No description

Parameters

mixed $state

Return Value

HasState

in HasState at line 39
HasState default(mixed $state)

No description

Parameters

mixed $state

Return Value

HasState

in HasState at line 46
HasState distinctList(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasState

in HasState at line 53
bool isDistinctList()

No description

Return Value

bool

in HasState at line 58
mixed getDefaultState()

No description

Return Value

mixed

in HasState at line 63
mixed getState()

No description

Return Value

mixed

in HasState at line 89
HasState separator(string|Closure|null $separator = ',')

No description

Parameters

string|Closure|null $separator

Return Value

HasState

in HasState at line 96
HasState statePath(string|null $path)

No description

Parameters

string|null $path

Return Value

HasState

in HasState at line 103
string|null getSeparator()

No description

Return Value

string|null

in HasState at line 108
Model|null getRecord()

No description

Return Value

Model|null

in HasState at line 113
bool hasStatePath()

No description

Return Value

bool

in HasState at line 118
string getStatePath(bool $isAbsolute = true)

No description

Parameters

bool $isAbsolute

Return Value

string

in HasState at line 137
mixed getStateFromRecord(Model $record)

No description

Parameters

Model $record

Return Value

mixed

in HasState at line 171
protected void flushCachedAbsoluteStatePath()

No description

Return Value

void

in HasColumns at line 17
HasColumns columns(array|int|null $columns = 2)

No description

Parameters

array|int|null $columns

Return Value

HasColumns

in HasColumns at line 36
array|int|null getColumns(string|null $breakpoint = null)

No description

Parameters

string|null $breakpoint

Return Value

array|int|null

in HasColumns at line 50
array getColumnsConfig()

No description

Return Value

array

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