1. class
  2. Filament
  3. \
  4. Forms
  5. \
  6. Components
  7. \
  8. Wizard

Wizard

class Wizard extends Component (View source)

Traits

CanBeContained
HasExtraAlpineAttributes
CanGrow
BelongsToContainer
BelongsToModel
CanBeConcealed
CanBeDisabled
CanBeHidden
CanBeRepeated
CanSpanColumns
Cloneable
HasActions
HasChildComponents
HasFieldWrapper
HasId
HasInlineLabel
HasKey
HasLabel
HasMaxWidth
HasMeta
HasState
ListensToEvents
HasColumns
HasExtraAttributes
HasStateBindingModifiers
Conditionable
Configurable
EvaluatesClosures
Macroable
Tappable

Properties

protected string $evaluationIdentifier from  EvaluatesClosures
static protected Closure>> $macros from  Macroable
protected string $view
protected string|Closure|null $defaultView from  ViewComponent
protected array<string,mixed> $viewData from  ViewComponent
protected string $viewIdentifier from  ViewComponent
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 $isContained from  CanBeContained
protected bool $isContainedCache from  CanBeContained
protected array $extraAlpineAttributes from  HasExtraAlpineAttributes
protected Htmlable|null $cancelAction
protected bool|Closure $isSkippable
protected string|Closure|null $stepQueryStringKey
protected Htmlable|null $submitAction
protected Closure|null $modifyNextActionUsing
protected Closure|null $modifyPreviousActionUsing
protected int|Closure $startStep
protected int $currentStepIndex

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

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

No description

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

No description

from  EvaluatesClosures
array
resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

from  EvaluatesClosures
array
resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

from  EvaluatesClosures
string|null
getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

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

No description

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

No description

from  Macroable
static void
flushMacros()

No description

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

No description

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

No description

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

No description

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

No description

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

No description

from  ViewComponent
array
extractPublicMethods()

No description

from  ViewComponent
ViewComponent
viewData(array $data)

No description

from  ViewComponent
string
getView()

No description

from  ViewComponent
string|null
getDefaultView()

No description

from  ViewComponent
string
toHtml()

No description

from  ViewComponent
View
render()

No description

from  ViewComponent
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
HasForms
getLivewire()

No description

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

No description

from  BelongsToModel
void
saveRelationships()

No description

from  BelongsToModel
void
saveRelationshipsBeforeChildren()

No description

from  BelongsToModel
void
loadStateFromRelationships(bool $andHydrate = false)

No description

from  BelongsToModel
BelongsToModel
saveRelationshipsUsing(Closure|null $callback)

No description

from  BelongsToModel
BelongsToModel
saveRelationshipsBeforeChildrenUsing(Closure|null $callback)

No description

from  BelongsToModel
BelongsToModel
saveRelationshipsWhenDisabled(bool|Closure $condition = true)

No description

from  BelongsToModel
bool
shouldSaveRelationshipsWhenDisabled()

No description

from  BelongsToModel
BelongsToModel
saveRelationshipsWhenHidden(bool|Closure $condition = true)

No description

from  BelongsToModel
bool
shouldSaveRelationshipsWhenHidden()

No description

from  BelongsToModel
BelongsToModel
loadStateFromRelationshipsUsing(Closure|null $callback)

No description

from  BelongsToModel
string|null
getModel()

No description

from  BelongsToModel
Model|null
getRecord()

No description

from  BelongsToModel
Model|null
getModelInstance()

No description

from  BelongsToModel
Component|null
getConcealingComponent()

No description

from  CanBeConcealed
bool
isConcealed()

No description

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

No description

from  CanBeDisabled
CanBeDisabled
disabledOn(string|array $operations)

No description

from  CanBeDisabled
bool
isDisabled()

No description

from  CanBeDisabled
bool
isEnabled()

No description

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

No description

from  CanBeHidden
CanBeHidden
hiddenOn(string|array $operations)

No description

from  CanBeHidden
CanBeHidden
hiddenWhenAllChildComponentsHidden()

No description

from  CanBeHidden
CanBeHidden
whenTruthy(string|array $paths)

No description

from  CanBeHidden
CanBeHidden
whenFalsy(string|array $paths)

No description

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

No description

from  CanBeHidden
CanBeHidden
visibleOn(string|array $operations)

No description

from  CanBeHidden
bool
isHidden()

No description

from  CanBeHidden
bool
isVisible()

No description

from  CanBeHidden
Repeater|null
getParentRepeater()

No description

from  CanBeRepeated
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
registerActions(array $actions)

No description

from  HasActions
Action|null
getAction(string $name)

No description

from  HasActions
array
getActions()

No description

from  HasActions
array
cacheActions()

No description

from  HasActions
Action
prepareAction(Action $action)

No description

from  HasActions
HasActions
actionFormModel(Model|string|null $model)

No description

from  HasActions
Model|string|null
getActionFormModel()

No description

from  HasActions
bool
hasAction(string $name)

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
HasFieldWrapper
fieldWrapperView(string|Closure|null $view)

No description

from  HasFieldWrapper
string
getFieldWrapperView()

No description

from  HasFieldWrapper
string|null
getCustomFieldWrapperView()

No description

from  HasFieldWrapper
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
disableLabel(bool|Closure $condition = true) deprecated

No description

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

No description

from  HasState
HasState
clearAfterStateUpdatedHooks()

No description

from  HasState
HasState
afterStateUpdated(Closure|null $callback)

No description

from  HasState
HasState
beforeStateDehydrated(Closure|null $callback)

No description

from  HasState
HasState
callAfterStateHydrated()

No description

from  HasState
HasState
callAfterStateUpdated()

No description

from  HasState
void
callAfterStateUpdatedHook(Closure $hook)

No description

from  HasState
HasState
callBeforeStateDehydrated()

No description

from  HasState
HasState
default(mixed $state)

No description

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

No description

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

No description

from  HasState
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
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
HasState
mutateDehydratedStateUsing(Closure|null $callback)

No description

from  HasState
HasState
mutateStateForValidationUsing(Closure|null $callback)

No description

from  HasState
HasState
state(mixed $state)

No description

from  HasState
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
HasState
stripCharacters(string|array|Closure|null $characters)

No description

from  HasState
array
getStripCharacters()

No description

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

No description

from  ListensToEvents
ListensToEvents
registerListeners(array $listeners)

No description

from  ListensToEvents
array
getListeners(string|null $event = null)

No description

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

No description

from  HasColumns
array|int|string|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
HasStateBindingModifiers
live(bool $onBlur = false, int|string|null $debounce = null, bool|Closure|null $condition = true)

No description

from  HasStateBindingModifiers
HasStateBindingModifiers
reactive()

No description

from  HasStateBindingModifiers
HasStateBindingModifiers
lazy()

No description

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

No description

from  HasStateBindingModifiers
HasStateBindingModifiers
stateBindingModifiers(array|null $modifiers)

No description

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

No description

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

No description

from  HasStateBindingModifiers
bool
isLive()

No description

from  HasStateBindingModifiers
bool
isLiveOnBlur()

No description

from  HasStateBindingModifiers
bool
isLazy()

No description

from  HasStateBindingModifiers
bool
isLiveDebounced()

No description

from  HasStateBindingModifiers
int|string|null
getLiveDebounce()

No description

from  HasStateBindingModifiers
int|null
getNormalizedLiveDebounce()

No description

from  HasStateBindingModifiers
CanBeContained
contained(bool|Closure $condition = true)

No description

from  CanBeContained
bool
isContained()

No description

from  CanBeContained
HasExtraAlpineAttributes
extraAlpineAttributes(array|Closure $attributes, bool $merge = false)

No description

from  HasExtraAlpineAttributes
array
getExtraAlpineAttributes()

No description

from  HasExtraAlpineAttributes
ComponentAttributeBag
getExtraAlpineAttributeBag()

No description

from  HasExtraAlpineAttributes
__construct(array|Closure $steps = [])

No description

static Wizard
make(array|Closure $steps = [])

No description

Action
getNextAction()

No description

Wizard
nextAction(Closure|null $callback)

No description

string
getNextActionName()

No description

Action
getPreviousAction()

No description

Wizard
previousAction(Closure|null $callback)

No description

string
getPreviousActionName()

No description

Wizard
steps(array|Closure $steps)

No description

Wizard
startOnStep(int|Closure $startStep)

No description

Wizard
cancelAction(Htmlable|null $action)

No description

Wizard
submitAction(Htmlable|null $action)

No description

Wizard
skippable(bool|Closure $condition = true)

No description

Wizard
persistStepInQueryString(string|Closure|null $key = 'step')

No description

Htmlable|null
getCancelAction()

No description

Htmlable|null
getSubmitAction()

No description

int
getStartStep()

No description

string|null
getStepQueryStringKey()

No description

bool
isSkippable()

No description

bool
isStepPersistedInQueryString()

No description

int
getCurrentStepIndex()

No description

Wizard
setCurrentStepIndex(int $index)

No description

Details

in Configurable at line 10
static mixed configureUsing(Closure $modifyUsing, Closure|null $during = null, bool $isImportant = false)

No description

Parameters

Closure $modifyUsing
Closure|null $during
bool $isImportant

Return Value

mixed

in Configurable at line 20
Configurable configure()

No description

Return Value

Configurable

at line 59
protected void setUp()

No description

Return Value

void

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

No description

Parameters

mixed $value
array $namedInjections
array $typedInjections

Return Value

mixed

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

No description

Parameters

ReflectionParameter $parameter
array $namedInjections
array $typedInjections

Return Value

mixed

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

No description

Parameters

string $parameterName

Return Value

array

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

No description

Parameters

string $parameterType

Return Value

array

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

No description

Parameters

ReflectionParameter $parameter

Return Value

string|null

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

No description

Parameters

string $name
callable $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

in Macroable at line 37
static void flushMacros()

No description

Return Value

void

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

No description

Parameters

string $method
array $parameters

Return Value

mixed

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

No description

Parameters

string $method
array $parameters

Return Value

mixed

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

No description

Parameters

string $method

Return Value

callable|null

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

No description

Parameters

string|null $view
array $viewData

Return Value

ViewComponent

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

No description

Parameters

string|Closure|null $view

Return Value

ViewComponent

in ViewComponent at line 62
protected array extractPublicMethods()

No description

Return Value

array

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

No description

Parameters

array $data

Return Value

ViewComponent

in ViewComponent at line 83
string getView()

No description

Return Value

string

in ViewComponent at line 99
string|null getDefaultView()

No description

Return Value

string|null

in ViewComponent at line 104
string toHtml()

No description

Return Value

string

in ViewComponent at line 109
View render()

No description

Return Value

View

in 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 12
BelongsToContainer container(ComponentContainer $container)

No description

Parameters

ComponentContainer $container

Return Value

BelongsToContainer

in BelongsToContainer at line 19
ComponentContainer getContainer()

No description

Return Value

ComponentContainer

in BelongsToContainer at line 24
HasForms getLivewire()

No description

Return Value

HasForms

in BelongsToModel at line 22
BelongsToModel model(Model|string|Closure|null $model = null)

No description

Parameters

Model|string|Closure|null $model

Return Value

BelongsToModel

in BelongsToModel at line 29
void saveRelationships()

No description

Return Value

void

in BelongsToModel at line 52
void saveRelationshipsBeforeChildren()

No description

Return Value

void

in BelongsToModel at line 75
void loadStateFromRelationships(bool $andHydrate = false)

No description

Parameters

bool $andHydrate

Return Value

void

in BelongsToModel at line 100
BelongsToModel saveRelationshipsUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

BelongsToModel

in BelongsToModel at line 107
BelongsToModel saveRelationshipsBeforeChildrenUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

BelongsToModel

in BelongsToModel at line 114
BelongsToModel saveRelationshipsWhenDisabled(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

BelongsToModel

in BelongsToModel at line 121
bool shouldSaveRelationshipsWhenDisabled()

No description

Return Value

bool

in BelongsToModel at line 126
BelongsToModel saveRelationshipsWhenHidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

BelongsToModel

in BelongsToModel at line 133
bool shouldSaveRelationshipsWhenHidden()

No description

Return Value

bool

in BelongsToModel at line 138
BelongsToModel loadStateFromRelationshipsUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

BelongsToModel

in BelongsToModel at line 145
string|null getModel()

No description

Return Value

string|null

in BelongsToModel at line 160
Model|null getRecord()

No description

Return Value

Model|null

in BelongsToModel at line 175
Model|null getModelInstance()

No description

Return Value

Model|null

in CanBeConcealed at line 12
Component|null getConcealingComponent()

No description

Return Value

Component|null

in CanBeConcealed at line 31
bool isConcealed()

No description

Return Value

bool

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

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

in CanBeDisabled at line 25
CanBeDisabled disabledOn(string|array $operations)

No description

Parameters

string|array $operations

Return Value

CanBeDisabled

in CanBeDisabled at line 40
bool isDisabled()

No description

Return Value

bool

in CanBeDisabled at line 45
bool isEnabled()

No description

Return Value

bool

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

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

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

No description

Parameters

string|array $operations

Return Value

CanBeHidden

in CanBeHidden at line 42
CanBeHidden hiddenWhenAllChildComponentsHidden()

No description

Return Value

CanBeHidden

in CanBeHidden at line 60
CanBeHidden whenTruthy(string|array $paths)

No description

Parameters

string|array $paths

Return Value

CanBeHidden

in CanBeHidden at line 80
CanBeHidden whenFalsy(string|array $paths)

No description

Parameters

string|array $paths

Return Value

CanBeHidden

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

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

in CanBeHidden at line 107
CanBeHidden visibleOn(string|array $operations)

No description

Parameters

string|array $operations

Return Value

CanBeHidden

in CanBeHidden at line 122
bool isHidden()

No description

Return Value

bool

in CanBeHidden at line 131
bool isVisible()

No description

Return Value

bool

in CanBeRepeated at line 11
Repeater|null getParentRepeater()

No description

Return Value

Repeater|null

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 32
HasActions registerActions(array $actions)

No description

Parameters

array $actions

Return Value

HasActions

in HasActions at line 42
Action|null getAction(string $name)

No description

Parameters

string $name

Return Value

Action|null

in HasActions at line 50
array getActions()

No description

Return Value

array

in HasActions at line 58
array cacheActions()

No description

Return Value

array

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

No description

Parameters

Action $action

Return Value

Action

in HasActions at line 112
HasActions actionFormModel(Model|string|null $model)

No description

Parameters

Model|string|null $model

Return Value

HasActions

in HasActions at line 119
Model|string|null getActionFormModel()

No description

Return Value

Model|string|null

in HasActions at line 124
bool hasAction(string $name)

No description

Parameters

string $name

Return Value

bool

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 HasFieldWrapper at line 11
HasFieldWrapper fieldWrapperView(string|Closure|null $view)

No description

Parameters

string|Closure|null $view

Return Value

HasFieldWrapper

in HasFieldWrapper at line 18
string getFieldWrapperView()

No description

Return Value

string

in HasFieldWrapper at line 25
string|null getCustomFieldWrapperView()

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 19
HasLabel disableLabel(bool|Closure $condition = true) deprecated

deprecated Use `hiddenLabel()` instead.

No description

Parameters

bool|Closure $condition

Return Value

HasLabel

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

No description

Parameters

bool|Closure $condition

Return Value

HasLabel

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

No description

Parameters

Htmlable|Closure|null $label

Return Value

HasLabel

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

No description

Parameters

bool $shouldTranslateLabel

Return Value

HasLabel

in HasLabel at line 47
Htmlable|null getLabel()

No description

Return Value

Htmlable|null

in HasLabel at line 56
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 HasState at line 55
HasState afterStateHydrated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

in HasState at line 62
HasState clearAfterStateUpdatedHooks()

No description

Return Value

HasState

in HasState at line 69
HasState afterStateUpdated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

in HasState at line 76
HasState beforeStateDehydrated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

in HasState at line 83
HasState callAfterStateHydrated()

No description

Return Value

HasState

in HasState at line 92
HasState callAfterStateUpdated()

No description

Return Value

HasState

in HasState at line 109
protected void callAfterStateUpdatedHook(Closure $hook)

No description

Parameters

Closure $hook

Return Value

void

in HasState at line 116
HasState callBeforeStateDehydrated()

No description

Return Value

HasState

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

No description

Parameters

mixed $state

Return Value

HasState

in HasState at line 133
HasState dehydrated(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasState

in HasState at line 140
HasState dehydratedWhenHidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasState

in HasState at line 147
HasState formatStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

in HasState at line 157
array getStateToDehydrate()

No description

Return Value

array

in HasState at line 169
void dehydrateState(array $state, bool $isDehydrated = true)

No description

Parameters

array $state
bool $isDehydrated

Return Value

void

in HasState at line 204
HasState dehydrateStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

in HasState at line 214
void hydrateState(array|null $hydratedDefaultState, bool $andCallHydrationHooks = true)

No description

Parameters

array|null $hydratedDefaultState
bool $andCallHydrationHooks

Return Value

void

in HasState at line 227
void fill()

No description

Return Value

void

in HasState at line 237
void hydrateDefaultState(array|null $hydratedDefaultState)

No description

Parameters

array|null $hydratedDefaultState

Return Value

void

in HasState at line 272
void fillStateWithNull()

No description

Return Value

void

in HasState at line 283
mixed mutateDehydratedState(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

in HasState at line 297
mixed mutateStateForValidation(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

in HasState at line 311
protected mixed stripCharactersFromState(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

in HasState at line 326
bool mutatesDehydratedState()

No description

Return Value

bool

in HasState at line 331
bool mutatesStateForValidation()

No description

Return Value

bool

in HasState at line 336
bool hasStripCharacters()

No description

Return Value

bool

in HasState at line 341
HasState mutateDehydratedStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

in HasState at line 348
HasState mutateStateForValidationUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

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

No description

Parameters

mixed $state

Return Value

HasState

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

No description

Parameters

string|null $path

Return Value

HasState

in HasState at line 371
mixed getDefaultState()

No description

Return Value

mixed

in HasState at line 376
mixed getState()

No description

Return Value

mixed

in HasState at line 391
mixed getOldState()

No description

Return Value

mixed

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

No description

Parameters

bool $isAbsolute

Return Value

string

in HasState at line 429
bool hasStatePath()

No description

Return Value

bool

in HasState at line 434
protected bool hasDefaultState()

No description

Return Value

bool

in HasState at line 439
bool isDehydrated()

No description

Return Value

bool

in HasState at line 444
bool isDehydratedWhenHidden()

No description

Return Value

bool

in HasState at line 449
bool isHiddenAndNotDehydrated()

No description

Return Value

bool

in HasState at line 458
Get getGetCallback()

No description

Return Value

Get

in HasState at line 463
Set getSetCallback()

No description

Return Value

Set

in HasState at line 468
string generateRelativeStatePath(Component $path = '', bool $isAbsolute = false)

No description

Parameters

Component $path
bool $isAbsolute

Return Value

string

in HasState at line 495
protected void flushCachedAbsoluteStatePath()

No description

Return Value

void

in HasState at line 503
HasState stripCharacters(string|array|Closure|null $characters)

No description

Parameters

string|array|Closure|null $characters

Return Value

HasState

in HasState at line 513
array getStripCharacters()

No description

Return Value

array

in ListensToEvents at line 14
ListensToEvents dispatchEvent(string $event, mixed ...$parameters)

No description

Parameters

string $event
mixed ...$parameters

Return Value

ListensToEvents

in ListensToEvents at line 26
ListensToEvents registerListeners(array $listeners)

No description

Parameters

array $listeners

Return Value

ListensToEvents

in ListensToEvents at line 41
array getListeners(string|null $event = null)

No description

Parameters

string|null $event

Return Value

array

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

No description

Parameters

array|int|string|null $columns

Return Value

HasColumns

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

No description

Parameters

string|null $breakpoint

Return Value

array|int|string|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

in HasStateBindingModifiers at line 21
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

in HasStateBindingModifiers at line 30
HasStateBindingModifiers reactive()

No description

Return Value

HasStateBindingModifiers

in HasStateBindingModifiers at line 37
HasStateBindingModifiers lazy()

No description

Return Value

HasStateBindingModifiers

in HasStateBindingModifiers at line 44
HasStateBindingModifiers debounce(int|string|null $delay = 500)

No description

Parameters

int|string|null $delay

Return Value

HasStateBindingModifiers

in HasStateBindingModifiers at line 54
HasStateBindingModifiers stateBindingModifiers(array|null $modifiers)

No description

Parameters

array|null $modifiers

Return Value

HasStateBindingModifiers

in HasStateBindingModifiers at line 61
string applyStateBindingModifiers(string $expression, bool $isOptimisticallyLive = true)

No description

Parameters

string $expression
bool $isOptimisticallyLive

Return Value

string

in HasStateBindingModifiers at line 83
array getStateBindingModifiers(bool $withBlur = true, bool $withDebounce = true, bool $isOptimisticallyLive = true)

No description

Parameters

bool $withBlur
bool $withDebounce
bool $isOptimisticallyLive

Return Value

array

in HasStateBindingModifiers at line 126
bool isLive()

No description

Return Value

bool

in HasStateBindingModifiers at line 145
bool isLiveOnBlur()

No description

Return Value

bool

in HasStateBindingModifiers at line 164
bool isLazy()

No description

Return Value

bool

in HasStateBindingModifiers at line 169
bool isLiveDebounced()

No description

Return Value

bool

in HasStateBindingModifiers at line 190
int|string|null getLiveDebounce()

No description

Return Value

int|string|null

in HasStateBindingModifiers at line 211
int|null getNormalizedLiveDebounce()

No description

Return Value

int|null

in CanBeContained at line 13
CanBeContained contained(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeContained

in CanBeContained at line 20
bool isContained()

No description

Return Value

bool

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

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraAlpineAttributes

in HasExtraAlpineAttributes at line 32
array getExtraAlpineAttributes()

No description

Return Value

array

in HasExtraAlpineAttributes at line 43
ComponentAttributeBag getExtraAlpineAttributeBag()

No description

Return Value

ComponentAttributeBag

at line 43
final __construct(array|Closure $steps = [])

No description

Parameters

array|Closure $steps

at line 51
static Wizard make(array|Closure $steps = [])

No description

Parameters

array|Closure $steps

Return Value

Wizard

at line 123
Action getNextAction()

No description

Return Value

Action

at line 141
Wizard nextAction(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Wizard

at line 148
string getNextActionName()

No description

Return Value

string

at line 153
Action getPreviousAction()

No description

Return Value

Action

at line 170
Wizard previousAction(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Wizard

at line 177
string getPreviousActionName()

No description

Return Value

string

at line 185
Wizard steps(array|Closure $steps)

No description

Parameters

array|Closure $steps

Return Value

Wizard

at line 192
Wizard startOnStep(int|Closure $startStep)

No description

Parameters

int|Closure $startStep

Return Value

Wizard

at line 199
Wizard cancelAction(Htmlable|null $action)

No description

Parameters

Htmlable|null $action

Return Value

Wizard

at line 206
Wizard submitAction(Htmlable|null $action)

No description

Parameters

Htmlable|null $action

Return Value

Wizard

at line 213
Wizard skippable(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

Wizard

at line 220
Wizard persistStepInQueryString(string|Closure|null $key = 'step')

No description

Parameters

string|Closure|null $key

Return Value

Wizard

at line 227
Htmlable|null getCancelAction()

No description

Return Value

Htmlable|null

at line 232
Htmlable|null getSubmitAction()

No description

Return Value

Htmlable|null

at line 237
int getStartStep()

No description

Return Value

int

at line 254
string|null getStepQueryStringKey()

No description

Return Value

string|null

at line 259
bool isSkippable()

No description

Return Value

bool

at line 264
bool isStepPersistedInQueryString()

No description

Return Value

bool

at line 269
int getCurrentStepIndex()

No description

Return Value

int

at line 274
protected Wizard setCurrentStepIndex(int $index)

No description

Parameters

int $index

Return Value

Wizard