class Field extends Component implements HasHintActions, HasValidationRules (View source)

Traits

Properties

protected string $evaluationIdentifier from  EvaluatesClosures
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
protected bool|Closure|null $canGrow from  CanGrow
protected ComponentContainer $container from  BelongsToContainer
protected Model|string|Closure|null $model from  BelongsToModel
protected Closure|null $loadStateFromRelationshipsUsing from  BelongsToModel
protected Closure|null $saveRelationshipsUsing from  BelongsToModel
protected Closure|null $saveRelationshipsBeforeChildrenUsing from  BelongsToModel
protected bool|Closure $shouldSaveRelationshipsWhenDisabled from  BelongsToModel
protected bool|Closure $shouldSaveRelationshipsWhenHidden from  BelongsToModel
protected Component|bool|null $cachedConcealingComponent from  CanBeConcealed
protected bool|Closure $isDisabled from  CanBeDisabled
protected bool|Closure $isHidden from  CanBeHidden
protected bool|Closure $isVisible from  CanBeHidden
protected Repeater|bool|null $cachedParentRepeater from  CanBeRepeated
protected array $columnSpan from  CanSpanColumns
protected array $columnStart from  CanSpanColumns
protected Action[] $cachedActions from  HasActions
protected array $actions from  HasActions
protected Model|string|null $actionFormModel from  HasActions
protected Component[] $childComponents from  HasChildComponents
protected string|Closure|null $fieldWrapperView from  HasFieldWrapper
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 Closure|null $afterStateHydrated from  HasState
protected Closure[] $afterStateUpdated from  HasState
protected Closure|null $beforeStateDehydrated from  HasState
protected mixed $defaultState from  HasState
protected Closure|null $dehydrateStateUsing from  HasState
protected Closure|null $mutateDehydratedStateUsing from  HasState
protected Closure|null $mutateStateForValidationUsing from  HasState
protected bool $hasDefaultState from  HasState
protected bool|Closure $isDehydrated from  HasState
protected bool|Closure $isDehydratedWhenHidden from  HasState
protected string|null $statePath from  HasState
protected string $cachedAbsoluteStatePath from  HasState
protected string $stripCharacters from  HasState
protected string[] $cachedStripCharacters from  HasState
protected Closure[]> $listeners from  ListensToEvents
protected array|null $columns from  HasColumns
protected array $extraAttributes from  HasExtraAttributes
protected string[] $stateBindingModifiers from  HasStateBindingModifiers
protected int|string|null $liveDebounce from  HasStateBindingModifiers
protected bool|Closure|null $isLive from  HasStateBindingModifiers
protected bool $isLiveOnBlur from  HasStateBindingModifiers
protected bool|Closure $isAutofocused from  CanBeAutofocused
protected bool|Closure|null $isMarkedAsRequired from  CanBeMarkedAsRequired
protected bool|Closure $isRequired from  CanBeValidated
protected string|Closure|null $regexPattern from  CanBeValidated
protected array $rules from  CanBeValidated
protected array $validationMessages from  CanBeValidated
protected string|Closure|null $validationAttribute from  CanBeValidated
protected bool|Closure $isGrammarlyDisabled from  CanDisableGrammarly
protected array $extraFieldWrapperAttributes from  HasExtraFieldWrapperAttributes
protected Htmlable|Closure|null $helperText from  HasHelperText
protected Htmlable|Closure|null $hint from  HasHint
protected Action[] $cachedHintActions from  HasHint
protected array $hintActions from  HasHint
protected string $hintColor from  HasHint
protected string|Closure|null $hintIcon from  HasHint
protected string|Closure|null $hintIconTooltip from  HasHint
protected string $name from  HasName

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

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

No description

from  CanGrow
bool
canGrow(bool $default = true)

No description

from  CanGrow
getLivewire()

No description

model(Model|string|Closure|null $model = null)

No description

void
saveRelationships()

No description

void
void
loadStateFromRelationships(bool $andHydrate = false)

No description

saveRelationshipsUsing(Closure|null $callback)

No description

saveRelationshipsWhenDisabled(bool|Closure $condition = true)

No description

saveRelationshipsWhenHidden(bool|Closure $condition = true)

No description

string|null
getModel()

No description

Model|null
getRecord()

No description

Model|null
getModelInstance()

No description

Component|null
getConcealingComponent()

No description

bool
isConcealed()

No description

disabled(bool|Closure $condition = true)

No description

disabledOn(string|array $operations)

No description

bool
isDisabled()

No description

bool
isEnabled()

No description

hidden(bool|Closure $condition = true)

No description

hiddenOn(string|array $operations)

No description

whenTruthy(string|array $paths)

No description

whenFalsy(string|array $paths)

No description

visible(bool|Closure $condition = true)

No description

visibleOn(string|array $operations)

No description

bool
isHidden()

No description

bool
isVisible()

No description

Repeater|null
getParentRepeater()

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

cloneChildComponents()

No description

getClone()

No description

registerActions(array $actions)

No description

Action|null
getAction(string $name)

No description

array
getActions()

No description

array
cacheActions()

No description

prepareAction(Action $action)

No description

actionFormModel(Model|string|null $model)

No description

Model|string|null
getActionFormModel()

No description

bool
hasAction(string $name)

No description

childComponents(array|Closure $components)

No description

schema(array|Closure $components)

No description

array
getChildComponents()

No description

getChildComponentContainer(array-key $key = null)

No description

array
getChildComponentContainers(bool $withHidden = false)

No description

bool
hasChildComponentContainer(bool $withHidden = false)

No description

fieldWrapperView(string|Closure|null $view)

No description

string
getFieldWrapperView()

No description

string|null
getCustomFieldWrapperView()

No description

id(string|Closure|null $id)

No description

from  HasId
string|null
getId()

No description

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

No description

bool|null
hasInlineLabel()

No description

key(string|Closure|null $key)

No description

from  HasKey
string|null
getKey()

No description

disableLabel(bool|Closure $condition = true) deprecated

No description

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

No description

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

No description

from  HasLabel
translateLabel(bool $shouldTranslateLabel = true)

No description

from  HasLabel
Htmlable|null
getLabel()

No description

from  HasLabel
bool
isLabelHidden()

No description

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

No description

MaxWidth|string|null
getMaxWidth()

No description

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
afterStateHydrated(Closure|null $callback)

No description

from  HasState
afterStateUpdated(Closure|null $callback)

No description

from  HasState
beforeStateDehydrated(Closure|null $callback)

No description

from  HasState
callAfterStateHydrated()

No description

from  HasState
callAfterStateUpdated()

No description

from  HasState
void
callAfterStateUpdatedHook(Closure $hook)

No description

from  HasState
default(mixed $state)

No description

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

No description

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

No description

from  HasState
formatStateUsing(Closure|null $callback)

No description

from  HasState
array
getStateToDehydrate()

No description

from  HasState
void
dehydrateState(array $state, bool $isDehydrated = true)

No description

from  HasState
dehydrateStateUsing(Closure|null $callback)

No description

from  HasState
void
hydrateState(array|null $hydratedDefaultState, bool $andCallHydrationHooks = true)

No description

from  HasState
void
fill()

No description

from  HasState
void
hydrateDefaultState(array|null $hydratedDefaultState)

No description

from  HasState
void
fillStateWithNull()

No description

from  HasState
mixed
mutateDehydratedState(mixed $state)

No description

from  HasState
mixed
mutateStateForValidation(mixed $state)

No description

from  HasState
mixed
stripCharactersFromState(mixed $state)

No description

from  HasState
bool
mutatesDehydratedState()

No description

from  HasState
bool
mutatesStateForValidation()

No description

from  HasState
bool
hasStripCharacters()

No description

from  HasState
mutateDehydratedStateUsing(Closure|null $callback)

No description

from  HasState
mutateStateForValidationUsing(Closure|null $callback)

No description

from  HasState
state(mixed $state)

No description

from  HasState
statePath(string|null $path)

No description

from  HasState
mixed
getDefaultState()

No description

from  HasState
mixed
getState()

No description

from  HasState
mixed
getOldState()

No description

from  HasState
string
getStatePath(bool $isAbsolute = true)

No description

from  HasState
bool
hasStatePath()

No description

from  HasState
bool
hasDefaultState()

No description

from  HasState
bool
isDehydrated()

No description

from  HasState
bool
isDehydratedWhenHidden()

No description

from  HasState
bool
isHiddenAndNotDehydrated()

No description

from  HasState
Get
getGetCallback()

No description

from  HasState
Set
getSetCallback()

No description

from  HasState
string
generateRelativeStatePath(Component $path = '', bool $isAbsolute = false)

No description

from  HasState
void
flushCachedAbsoluteStatePath()

No description

from  HasState
stripCharacters(string|array|Closure|null $characters)

No description

from  HasState
array
getStripCharacters()

No description

from  HasState
dispatchEvent(string $event, mixed ...$parameters)

No description

registerListeners(array $listeners)

No description

array
getListeners(string|null $event = null)

No description

columns(array|int|string|null $columns = 2)

No description

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

No description

array
getColumnsConfig()

No description

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

No description

array
getExtraAttributes()

No description

ComponentAttributeBag
getExtraAttributeBag()

No description

live(bool $onBlur = false, int|string|null $debounce = null, bool|Closure|null $condition = true)

No description

debounce(int|string|null $delay = 500)

No description

stateBindingModifiers(array|null $modifiers)

No description

string
applyStateBindingModifiers(string $expression, bool $isOptimisticallyLive = true)

No description

array
getStateBindingModifiers(bool $withBlur = true, bool $withDebounce = true, bool $isOptimisticallyLive = true)

No description

bool
isLive()

No description

bool
isLiveOnBlur()

No description

bool
isLazy()

No description

bool
isLiveDebounced()

No description

int|string|null
getLiveDebounce()

No description

int|null
getNormalizedLiveDebounce()

No description

autofocus(bool|Closure $condition = true)

No description

bool
isAutofocused()

No description

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

No description

bool
isMarkedAsRequired()

No description

activeUrl(bool|Closure $condition = true)

No description

alpha(bool|Closure $condition = true)

No description

alphaDash(bool|Closure $condition = true)

No description

alphaNum(bool|Closure $condition = true)

No description

ascii(bool|Closure $condition = true)

No description

confirmed(bool|Closure $condition = true)

No description

doesntStartWith(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

doesntEndWith(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

endsWith(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

enum(string|Closure $enum)

No description

exists(string|Closure|null $table = null, string|Closure|null $column = null, Closure|null $modifyRuleUsing = null)

No description

filled(bool|Closure $condition = true)

No description

hexColor(bool|Closure $condition = true)

No description

in(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

ip(bool|Closure $condition = true)

No description

ipv4(bool|Closure $condition = true)

No description

ipv6(bool|Closure $condition = true)

No description

json(bool|Closure $condition = true)

No description

macAddress(bool|Closure $condition = true)

No description

multipleOf(int|float|Closure $value)

No description

notIn(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

notRegex(string|Closure|null $pattern)

No description

nullable(bool|Closure $condition = true)

No description

prohibited(bool|Closure $condition = true)

No description

prohibitedIf(string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

prohibitedUnless(string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

prohibits(array|string|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

required(bool|Closure $condition = true)

No description

requiredIf(string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

requiredIfAccepted(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

requiredUnless(string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

requiredWith(string|array|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

requiredWithAll(string|array|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

requiredWithout(string|array|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

requiredWithoutAll(string|array|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

regex(string|Closure|null $pattern)

No description

startsWith(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

string(bool|Closure $condition = true)

No description

ulid(bool|Closure $condition = true)

No description

uuid(bool|Closure $condition = true)

No description

rule(mixed $rule, bool|Closure $condition = true)

No description

rules(string|array|Closure $rules, bool|Closure $condition = true)

No description

after(string|Closure $date, bool $isStatePathAbsolute = false)

No description

afterOrEqual(string|Closure $date, bool $isStatePathAbsolute = false)

No description

before(string|Closure $date, bool $isStatePathAbsolute = false)

No description

beforeOrEqual(string|Closure $date, bool $isStatePathAbsolute = false)

No description

different(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

gt(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

gte(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

lt(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

lte(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

same(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

unique(string|Closure|null $table = null, string|Closure|null $column = null, Model|Closure|null $ignorable = null, bool $ignoreRecord = false, Closure|null $modifyRuleUsing = null)

No description

distinct(bool|Closure $condition = true)

No description

validationAttribute(string|Closure|null $label)

No description

validationMessages(array $messages)

No description

string|null
getRegexPattern()

No description

string
getRequiredValidationRule()

No description

string
getValidationAttribute()

No description

array
getValidationMessages()

No description

array
getValidationRules()

No description

void
dehydrateValidationMessages(array $messages)

No description

void
dehydrateValidationRules(array $rules)

No description

void
dehydrateValidationAttributes(array $attributes)

No description

bool
isRequired()

No description

dateComparisonRule(string $rule, string|Closure $date, bool $isStatePathAbsolute = false)

No description

fieldComparisonRule(string $rule, string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

multiFieldComparisonRule(string $rule, array|string|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

multiFieldValueComparisonRule(string $rule, string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

disableGrammarly(bool|Closure $condition = true)

No description

bool
isGrammarlyDisabled()

No description

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

No description

ComponentAttributeBag
helperText(Htmlable|Closure|null $text)

No description

Htmlable|null
getHelperText()

No description

hint(Htmlable|Closure|null $hint)

No description

from  HasHint
hintColor(string|array|Closure|null $color)

No description

from  HasHint
hintIcon(string|Closure|null $icon, string|Closure|null $tooltip = null)

No description

from  HasHint
hintIconTooltip(string|Closure|null $tooltip)

No description

from  HasHint
hintAction(Action|Closure $action)

No description

from  HasHint
hintActions(array $actions)

No description

from  HasHint
Htmlable|null
getHint()

No description

from  HasHint
string|array|null
getHintColor()

No description

from  HasHint
string|null
getHintIcon()

No description

from  HasHint
string|null
getHintIconTooltip()

No description

from  HasHint
array
getHintActions()

No description

from  HasHint
array
cacheHintActions()

No description

from  HasHint
name(string $name)

No description

from  HasName
string
getName()

No description

from  HasName
__construct(string $name)

No description

static Field
make(string $name)

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

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

BelongsToContainer container(ComponentContainer $container)

No description

Parameters

ComponentContainer $container

Return Value

BelongsToContainer

ComponentContainer getContainer()

No description

Return Value

ComponentContainer

HasForms getLivewire()

No description

Return Value

HasForms

BelongsToModel model(Model|string|Closure|null $model = null)

No description

Parameters

Model|string|Closure|null $model

Return Value

BelongsToModel

void saveRelationships()

No description

Return Value

void

void saveRelationshipsBeforeChildren()

No description

Return Value

void

void loadStateFromRelationships(bool $andHydrate = false)

No description

Parameters

bool $andHydrate

Return Value

void

BelongsToModel saveRelationshipsUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

BelongsToModel

BelongsToModel saveRelationshipsBeforeChildrenUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

BelongsToModel

BelongsToModel saveRelationshipsWhenDisabled(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

BelongsToModel

bool shouldSaveRelationshipsWhenDisabled()

No description

Return Value

bool

BelongsToModel saveRelationshipsWhenHidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

BelongsToModel

bool shouldSaveRelationshipsWhenHidden()

No description

Return Value

bool

BelongsToModel loadStateFromRelationshipsUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

BelongsToModel

string|null getModel()

No description

Return Value

string|null

Model|null getRecord()

No description

Return Value

Model|null

Model|null getModelInstance()

No description

Return Value

Model|null

Component|null getConcealingComponent()

No description

Return Value

Component|null

bool isConcealed()

No description

Return Value

bool

CanBeDisabled disabled(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

CanBeDisabled disabledOn(string|array $operations)

No description

Parameters

string|array $operations

Return Value

CanBeDisabled

bool isDisabled()

No description

Return Value

bool

bool isEnabled()

No description

Return Value

bool

CanBeHidden hidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

CanBeHidden hiddenOn(string|array $operations)

No description

Parameters

string|array $operations

Return Value

CanBeHidden

CanBeHidden hiddenWhenAllChildComponentsHidden()

No description

Return Value

CanBeHidden

CanBeHidden whenTruthy(string|array $paths)

No description

Parameters

string|array $paths

Return Value

CanBeHidden

CanBeHidden whenFalsy(string|array $paths)

No description

Parameters

string|array $paths

Return Value

CanBeHidden

CanBeHidden visible(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

CanBeHidden visibleOn(string|array $operations)

No description

Parameters

string|array $operations

Return Value

CanBeHidden

bool isHidden()

No description

Return Value

bool

bool isVisible()

No description

Return Value

bool

Repeater|null getParentRepeater()

No description

Return Value

Repeater|null

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

protected Cloneable cloneChildComponents()

No description

Return Value

Cloneable

Cloneable getClone()

No description

Return Value

Cloneable

HasActions registerActions(array $actions)

No description

Parameters

array $actions

Return Value

HasActions

Action|null getAction(string $name)

No description

Parameters

string $name

Return Value

Action|null

array getActions()

No description

Return Value

array

array cacheActions()

No description

Return Value

array

Action prepareAction(Action $action)

No description

Parameters

Action $action

Return Value

Action

HasActions actionFormModel(Model|string|null $model)

No description

Parameters

Model|string|null $model

Return Value

HasActions

Model|string|null getActionFormModel()

No description

Return Value

Model|string|null

bool hasAction(string $name)

No description

Parameters

string $name

Return Value

bool

HasChildComponents childComponents(array|Closure $components)

No description

Parameters

array|Closure $components

Return Value

HasChildComponents

HasChildComponents schema(array|Closure $components)

No description

Parameters

array|Closure $components

Return Value

HasChildComponents

array getChildComponents()

No description

Return Value

array

ComponentContainer getChildComponentContainer(array-key $key = null)

No description

Parameters

array-key $key

Return Value

ComponentContainer

array getChildComponentContainers(bool $withHidden = false)

No description

Parameters

bool $withHidden

Return Value

array

bool hasChildComponentContainer(bool $withHidden = false)

No description

Parameters

bool $withHidden

Return Value

bool

HasFieldWrapper fieldWrapperView(string|Closure|null $view)

No description

Parameters

string|Closure|null $view

Return Value

HasFieldWrapper

string getFieldWrapperView()

No description

Return Value

string

string|null getCustomFieldWrapperView()

No description

Return Value

string|null

HasId id(string|Closure|null $id)

No description

Parameters

string|Closure|null $id

Return Value

HasId

string|null getId()

No description

Return Value

string|null

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

No description

Parameters

bool|Closure|null $condition

Return Value

HasInlineLabel

bool|null hasInlineLabel()

No description

Return Value

bool|null

HasKey key(string|Closure|null $key)

No description

Parameters

string|Closure|null $key

Return Value

HasKey

string|null getKey()

No description

Return Value

string|null

HasLabel disableLabel(bool|Closure $condition = true) deprecated

deprecated Use `hiddenLabel()` instead.

No description

Parameters

bool|Closure $condition

Return Value

HasLabel

HasLabel hiddenLabel(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasLabel

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|null getLabel()

No description

Return Value

Htmlable|null

bool isLabelHidden()

No description

Return Value

bool

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

No description

Parameters

MaxWidth|string|Closure|null $width

Return Value

HasMaxWidth

MaxWidth|string|null getMaxWidth()

No description

Return Value

MaxWidth|string|null

HasMeta meta(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

HasMeta

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

No description

Parameters

string|array|null $keys

Return Value

mixed

bool hasMeta(string|array $keys)

No description

Parameters

string|array $keys

Return Value

bool

HasState afterStateHydrated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

HasState clearAfterStateUpdatedHooks()

No description

Return Value

HasState

HasState afterStateUpdated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

HasState beforeStateDehydrated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

HasState callAfterStateHydrated()

No description

Return Value

HasState

HasState callAfterStateUpdated()

No description

Return Value

HasState

protected void callAfterStateUpdatedHook(Closure $hook)

No description

Parameters

Closure $hook

Return Value

void

HasState callBeforeStateDehydrated()

No description

Return Value

HasState

HasState default(mixed $state)

No description

Parameters

mixed $state

Return Value

HasState

HasState dehydrated(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasState

HasState dehydratedWhenHidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasState

HasState formatStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

array getStateToDehydrate()

No description

Return Value

array

void dehydrateState(array $state, bool $isDehydrated = true)

No description

Parameters

array $state
bool $isDehydrated

Return Value

void

HasState dehydrateStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

void hydrateState(array|null $hydratedDefaultState, bool $andCallHydrationHooks = true)

No description

Parameters

array|null $hydratedDefaultState
bool $andCallHydrationHooks

Return Value

void

void fill()

No description

Return Value

void

void hydrateDefaultState(array|null $hydratedDefaultState)

No description

Parameters

array|null $hydratedDefaultState

Return Value

void

void fillStateWithNull()

No description

Return Value

void

mixed mutateDehydratedState(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

mixed mutateStateForValidation(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

protected mixed stripCharactersFromState(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

bool mutatesDehydratedState()

No description

Return Value

bool

bool mutatesStateForValidation()

No description

Return Value

bool

bool hasStripCharacters()

No description

Return Value

bool

HasState mutateDehydratedStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

HasState mutateStateForValidationUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

HasState state(mixed $state)

No description

Parameters

mixed $state

Return Value

HasState

HasState statePath(string|null $path)

No description

Parameters

string|null $path

Return Value

HasState

mixed getDefaultState()

No description

Return Value

mixed

mixed getState()

No description

Return Value

mixed

mixed getOldState()

No description

Return Value

mixed

string getStatePath(bool $isAbsolute = true)

No description

Parameters

bool $isAbsolute

Return Value

string

bool hasStatePath()

No description

Return Value

bool

protected bool hasDefaultState()

No description

Return Value

bool

bool isDehydrated()

No description

Return Value

bool

bool isDehydratedWhenHidden()

No description

Return Value

bool

bool isHiddenAndNotDehydrated()

No description

Return Value

bool

Get getGetCallback()

No description

Return Value

Get

Set getSetCallback()

No description

Return Value

Set

string generateRelativeStatePath(Component $path = '', bool $isAbsolute = false)

No description

Parameters

Component $path
bool $isAbsolute

Return Value

string

protected void flushCachedAbsoluteStatePath()

No description

Return Value

void

HasState stripCharacters(string|array|Closure|null $characters)

No description

Parameters

string|array|Closure|null $characters

Return Value

HasState

array getStripCharacters()

No description

Return Value

array

ListensToEvents dispatchEvent(string $event, mixed ...$parameters)

No description

Parameters

string $event
mixed ...$parameters

Return Value

ListensToEvents

ListensToEvents registerListeners(array $listeners)

No description

Parameters

array $listeners

Return Value

ListensToEvents

array getListeners(string|null $event = null)

No description

Parameters

string|null $event

Return Value

array

HasColumns columns(array|int|string|null $columns = 2)

No description

Parameters

array|int|string|null $columns

Return Value

HasColumns

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

No description

Parameters

string|null $breakpoint

Return Value

array|int|string|null

array getColumnsConfig()

No description

Return Value

array

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

HasStateBindingModifiers live(bool $onBlur = false, int|string|null $debounce = null, bool|Closure|null $condition = true)

No description

Parameters

bool $onBlur
int|string|null $debounce
bool|Closure|null $condition

Return Value

HasStateBindingModifiers

HasStateBindingModifiers debounce(int|string|null $delay = 500)

No description

Parameters

int|string|null $delay

Return Value

HasStateBindingModifiers

HasStateBindingModifiers stateBindingModifiers(array|null $modifiers)

No description

Parameters

array|null $modifiers

Return Value

HasStateBindingModifiers

string applyStateBindingModifiers(string $expression, bool $isOptimisticallyLive = true)

No description

Parameters

string $expression
bool $isOptimisticallyLive

Return Value

string

array getStateBindingModifiers(bool $withBlur = true, bool $withDebounce = true, bool $isOptimisticallyLive = true)

No description

Parameters

bool $withBlur
bool $withDebounce
bool $isOptimisticallyLive

Return Value

array

bool isLive()

No description

Return Value

bool

bool isLiveOnBlur()

No description

Return Value

bool

bool isLazy()

No description

Return Value

bool

bool isLiveDebounced()

No description

Return Value

bool

int|string|null getLiveDebounce()

No description

Return Value

int|string|null

int|null getNormalizedLiveDebounce()

No description

Return Value

int|null

CanBeAutofocused autofocus(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeAutofocused

bool isAutofocused()

No description

Return Value

bool

CanBeMarkedAsRequired markAsRequired(bool|Closure|null $condition = true)

No description

Parameters

bool|Closure|null $condition

Return Value

CanBeMarkedAsRequired

bool isMarkedAsRequired()

No description

Return Value

bool

CanBeValidated activeUrl(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated alpha(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated alphaDash(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated alphaNum(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated ascii(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated confirmed(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated doesntStartWith(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

Parameters

Arrayable|string|Closure $values
bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated doesntEndWith(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

Parameters

Arrayable|string|Closure $values
bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated endsWith(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

Parameters

Arrayable|string|Closure $values
bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated enum(string|Closure $enum)

No description

Parameters

string|Closure $enum

Return Value

CanBeValidated

CanBeValidated exists(string|Closure|null $table = null, string|Closure|null $column = null, Closure|null $modifyRuleUsing = null)

No description

Parameters

string|Closure|null $table
string|Closure|null $column
Closure|null $modifyRuleUsing

Return Value

CanBeValidated

CanBeValidated filled(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated hexColor(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated in(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

Parameters

Arrayable|string|Closure $values
bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated ip(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated ipv4(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated ipv6(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated json(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated macAddress(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated multipleOf(int|float|Closure $value)

No description

Parameters

int|float|Closure $value

Return Value

CanBeValidated

CanBeValidated notIn(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

Parameters

Arrayable|string|Closure $values
bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated notRegex(string|Closure|null $pattern)

No description

Parameters

string|Closure|null $pattern

Return Value

CanBeValidated

CanBeValidated nullable(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated prohibited(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated prohibitedIf(string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
mixed $stateValues
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated prohibitedUnless(string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
mixed $stateValues
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated prohibits(array|string|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

Parameters

array|string|Closure $statePaths
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated required(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated requiredIf(string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
mixed $stateValues
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated requiredIfAccepted(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated requiredUnless(string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
mixed $stateValues
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated requiredWith(string|array|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

Parameters

string|array|Closure $statePaths
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated requiredWithAll(string|array|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

Parameters

string|array|Closure $statePaths
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated requiredWithout(string|array|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

Parameters

string|array|Closure $statePaths
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated requiredWithoutAll(string|array|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

Parameters

string|array|Closure $statePaths
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated regex(string|Closure|null $pattern)

No description

Parameters

string|Closure|null $pattern

Return Value

CanBeValidated

CanBeValidated startsWith(Arrayable|string|Closure $values, bool|Closure $condition = true)

No description

Parameters

Arrayable|string|Closure $values
bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated string(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated ulid(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated uuid(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated rule(mixed $rule, bool|Closure $condition = true)

No description

Parameters

mixed $rule
bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated rules(string|array|Closure $rules, bool|Closure $condition = true)

No description

Parameters

string|array|Closure $rules
bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated after(string|Closure $date, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $date
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated afterOrEqual(string|Closure $date, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $date
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated before(string|Closure $date, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $date
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated beforeOrEqual(string|Closure $date, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $date
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated different(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated gt(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated gte(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated lt(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated lte(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated same(string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

Parameters

string|Closure $statePath
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated unique(string|Closure|null $table = null, string|Closure|null $column = null, Model|Closure|null $ignorable = null, bool $ignoreRecord = false, Closure|null $modifyRuleUsing = null)

No description

Parameters

string|Closure|null $table
string|Closure|null $column
Model|Closure|null $ignorable
bool $ignoreRecord
Closure|null $modifyRuleUsing

Return Value

CanBeValidated

CanBeValidated distinct(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeValidated

CanBeValidated validationAttribute(string|Closure|null $label)

No description

Parameters

string|Closure|null $label

Return Value

CanBeValidated

CanBeValidated validationMessages(array $messages)

No description

Parameters

array $messages

Return Value

CanBeValidated

string|null getRegexPattern()

No description

Return Value

string|null

string getRequiredValidationRule()

No description

Return Value

string

string getValidationAttribute()

No description

Return Value

string

array getValidationMessages()

No description

Return Value

array

array getValidationRules()

No description

Return Value

array

void dehydrateValidationMessages(array $messages)

No description

Parameters

array $messages

Return Value

void

void dehydrateValidationRules(array $rules)

No description

Parameters

array $rules

Return Value

void

void dehydrateValidationAttributes(array $attributes)

No description

Parameters

array $attributes

Return Value

void

bool isRequired()

No description

Return Value

bool

CanBeValidated dateComparisonRule(string $rule, string|Closure $date, bool $isStatePathAbsolute = false)

No description

Parameters

string $rule
string|Closure $date
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated fieldComparisonRule(string $rule, string|Closure $statePath, bool $isStatePathAbsolute = false)

No description

Parameters

string $rule
string|Closure $statePath
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated multiFieldComparisonRule(string $rule, array|string|Closure $statePaths, bool $isStatePathAbsolute = false)

No description

Parameters

string $rule
array|string|Closure $statePaths
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanBeValidated multiFieldValueComparisonRule(string $rule, string|Closure $statePath, mixed $stateValues, bool $isStatePathAbsolute = false)

No description

Parameters

string $rule
string|Closure $statePath
mixed $stateValues
bool $isStatePathAbsolute

Return Value

CanBeValidated

CanDisableGrammarly disableGrammarly(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanDisableGrammarly

bool isGrammarlyDisabled()

No description

Return Value

bool

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

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraFieldWrapperAttributes

array getExtraFieldWrapperAttributes()

No description

Return Value

array

ComponentAttributeBag getExtraFieldWrapperAttributesBag()

No description

Return Value

ComponentAttributeBag

HasHelperText helperText(Htmlable|Closure|null $text)

No description

Parameters

Htmlable|Closure|null $text

Return Value

HasHelperText

Htmlable|null getHelperText()

No description

Return Value

Htmlable|null

HasHint hint(Htmlable|Closure|null $hint)

No description

Parameters

Htmlable|Closure|null $hint

Return Value

HasHint

HasHint hintColor(string|array|Closure|null $color)

No description

Parameters

string|array|Closure|null $color

Return Value

HasHint

HasHint hintIcon(string|Closure|null $icon, string|Closure|null $tooltip = null)

No description

Parameters

string|Closure|null $icon
string|Closure|null $tooltip

Return Value

HasHint

HasHint hintIconTooltip(string|Closure|null $tooltip)

No description

Parameters

string|Closure|null $tooltip

Return Value

HasHint

HasHint hintAction(Action|Closure $action)

No description

Parameters

Action|Closure $action

Return Value

HasHint

HasHint hintActions(array $actions)

No description

Parameters

array $actions

Return Value

HasHint

Htmlable|null getHint()

No description

Return Value

Htmlable|null

string|array|null getHintColor()

No description

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

string|null getHintIcon()

No description

Return Value

string|null

string|null getHintIconTooltip()

No description

Return Value

string|null

array getHintActions()

No description

Return Value

array

array cacheHintActions()

No description

Return Value

array

HasName name(string $name)

No description

Parameters

string $name

Return Value

HasName

string getName()

No description

Return Value

string

final __construct(string $name)

No description

Parameters

string $name

static Field make(string $name)

No description

Parameters

string $name

Return Value

Field