class Wizard extends Component (View source)

Traits

Properties

static protected array $configurations from  Configurable
static protected array $importantConfigurations from  Configurable
protected string $evaluationIdentifier from  EvaluatesClosures
protected array $evaluationParametersToRemove from  EvaluatesClosures
protected string $view
protected array $viewData from  ViewComponent
protected string $viewIdentifier from  ViewComponent
static protected array $propertyCache from  ViewComponent
static protected array $methodCache from  ViewComponent
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 $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 array $columnSpan from  CanSpanColumns
protected array $actions from  HasActions
protected Model|string|null $actionFormModel from  HasActions
protected array|Closure $childComponents from  HasChildComponents
protected string|Closure|null $fieldWrapperView from  HasFieldWrapper
protected bool|Closure|null $hasInlineLabel from  HasInlineLabel
protected string|Closure|null $id from  HasId
protected bool|Closure $isLabelHidden from  HasLabel
protected Htmlable|Closure|null $label from  HasLabel
protected bool $shouldTranslateLabel from  HasLabel
protected string|Closure|null $maxWidth from  HasMaxWidth
protected array $meta from  HasMeta
protected Closure|null $afterStateHydrated from  HasState
protected Closure|null $afterStateUpdated from  HasState
protected Closure|null $beforeStateDehydrated from  HasState
protected $defaultState from  HasState
protected Closure|null $dehydrateStateUsing from  HasState
protected Closure|null $mutateDehydratedStateUsing from  HasState
protected bool $hasDefaultState from  HasState
protected bool|Closure $isDehydrated from  HasState
protected string|null $statePath from  HasState
protected array $listeners from  ListensToEvents
protected array|null $columns from  HasColumns
protected array $extraAttributes from  HasExtraAttributes
protected $stateBindingModifiers from  HasStateBindingModifiers
protected string|int|null $debounce from  HasStateBindingModifiers
protected array $extraAlpineAttributes from  HasExtraAlpineAttributes
protected Htmlable|null $cancelAction
protected bool|Closure $skippable
protected string|Closure|null $stepQueryStringKey
protected Htmlable|null $submitAction
int|Closure $startStep

Methods

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

No description

configure()

No description

void
setUp()

No description

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

No description

array
resolveEvaluationParameter(string $parameter, Closure $value)

No description

bool
isEvaluationParameterRemoved(string $parameter)

No description

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

No description

array
extractPublicProperties()

No description

array
extractPublicMethods()

No description

viewData(array $data)

No description

string
getView()

No description

string
toHtml()

No description

View
render()

No description

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

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 $contexts)

No description

bool
isDisabled()

No description

bool
isEnabled()

No description

hidden(bool|Closure $condition = true)

No description

hiddenOn(string|array $contexts)

No description

when(bool|Closure $condition = true)

No description

whenTruthy(string|array $paths)

No description

whenFalsy(string|array $paths)

No description

visible(bool|Closure $condition = true)

No description

visibleOn(string|array $contexts)

No description

bool
isHidden()

No description

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

No description

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

No description

cloneChildComponents()

No description

getClone()

No description

registerActions(array $actions)

No description

Action|Closure|null
getAction(string $name)

No description

array
getActions()

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

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

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

No description

bool|null
hasInlineLabel()

No description

id(string|Closure|null $id)

No description

from  HasId
string|null
getId()

No description

from  HasId
disableLabel(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(string|Closure|null $width)

No description

string|null
getMaxWidth()

No description

meta(string $key, $value)

No description

from  HasMeta
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
default($state)

No description

from  HasState
dehydrated(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)

No description

from  HasState
dehydrateStateUsing(Closure|null $callback)

No description

from  HasState
void
hydrateState(array|null $hydratedDefaultState)

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
mutateDehydratedState($state)

No description

from  HasState
bool
mutatesDehydratedState()

No description

from  HasState
mutateDehydratedStateUsing(Closure|null $callback)

No description

from  HasState
state($state)

No description

from  HasState
statePath(string|null $path)

No description

from  HasState
getDefaultState()

No description

from  HasState
getState()

No description

from  HasState
getOldState()

No description

from  HasState
string
getStatePath(bool $isAbsolute = true)

No description

from  HasState
bool
hasDefaultState()

No description

from  HasState
bool
isDehydrated()

No description

from  HasState
getGetCallback()

No description

from  HasState
getSetCallback()

No description

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

No description

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

No description

registerListeners(array $listeners)

No description

array
getListeners(string $event = null)

No description

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

No description

array|int|string|null
getColumns($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

reactive(bool $condition = true)

No description

lazy(bool $condition = true)

No description

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

No description

stateBindingModifiers(array|null $modifiers)

No description

string
applyStateBindingModifiers(string $expression, array $lazilyEntangledModifiers = [])

No description

bool
isReactive()

No description

bool
isLazy()

No description

bool
isDebounced()

No description

string|int|null
getDebounce()

No description

bool
shouldEvaluateWithState()

No description

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

No description

ComponentAttributeBag
getExtraAlpineAttributeBag()

No description

__construct(array|Closure $steps = [])

No description

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

No description

steps(array|Closure $steps)

No description

startOnStep(int|Closure $startStep)

No description

cancelAction(Htmlable|null $action)

No description

submitAction(Htmlable|null $action)

No description

skippable(bool|Closure $condition = true)

No description

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

Details

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

No description

Parameters

Closure $callback
Closure|null $during
bool $isImportant

Configurable configure()

No description

Return Value

Configurable

protected void setUp()

No description

Return Value

void

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

No description

Parameters

$value
array $parameters
array $exceptParameters

protected array getDefaultEvaluationParameters()

No description

Return Value

array

protected resolveEvaluationParameter(string $parameter, Closure $value)

No description

Parameters

string $parameter
Closure $value

protected bool isEvaluationParameterRemoved(string $parameter)

No description

Parameters

string $parameter

Return Value

bool

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

No description

Parameters

string $view
array $viewData

Return Value

ViewComponent

protected array extractPublicProperties()

No description

Return Value

array

protected array extractPublicMethods()

No description

Return Value

array

ViewComponent viewData(array $data)

No description

Parameters

array $data

Return Value

ViewComponent

string getView()

No description

Return Value

string

string toHtml()

No description

Return Value

string

View render()

No description

Return Value

View

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 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 $contexts)

No description

Parameters

string|array $contexts

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 $contexts)

No description

Parameters

string|array $contexts

Return Value

CanBeHidden

CanBeHidden hiddenWhenAllChildComponentsHidden()

No description

Return Value

CanBeHidden

CanBeHidden when(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

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 $contexts)

No description

Parameters

string|array $contexts

Return Value

CanBeHidden

bool isHidden()

No description

Return Value

bool

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

No description

Parameters

array|int|string|Closure|null $span

Return Value

CanSpanColumns

CanSpanColumns columnSpanFull()

No description

Return Value

CanSpanColumns

array|int|string|null getColumnSpan(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|Closure|null getAction(string $name)

No description

Parameters

string $name

Return Value

Action|Closure|null

array getActions()

No description

Return Value

array

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($key = null)

No description

Parameters

$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

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

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

HasLabel disableLabel(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(string|Closure|null $width)

No description

Parameters

string|Closure|null $width

Return Value

HasMaxWidth

string|null getMaxWidth()

No description

Return Value

string|null

HasMeta meta(string $key, $value)

No description

Parameters

string $key
$value

Return Value

HasMeta

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

No description

Parameters

string|array|null $keys

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

HasState callBeforeStateDehydrated()

No description

Return Value

HasState

HasState default($state)

No description

Parameters

$state

Return Value

HasState

HasState dehydrated(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)

No description

Parameters

array $state

Return Value

void

HasState dehydrateStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

void hydrateState(array|null $hydratedDefaultState)

No description

Parameters

array|null $hydratedDefaultState

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

mutateDehydratedState($state)

No description

Parameters

$state

bool mutatesDehydratedState()

No description

Return Value

bool

HasState mutateDehydratedStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasState

HasState state($state)

No description

Parameters

$state

Return Value

HasState

HasState statePath(string|null $path)

No description

Parameters

string|null $path

Return Value

HasState

getDefaultState()

No description

getState()

No description

getOldState()

No description

string getStatePath(bool $isAbsolute = true)

No description

Parameters

bool $isAbsolute

Return Value

string

protected bool hasDefaultState()

No description

Return Value

bool

bool isDehydrated()

No description

Return Value

bool

protected Closure getGetCallback()

No description

Return Value

Closure

protected Closure getSetCallback()

No description

Return Value

Closure

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

No description

Parameters

Component $path
bool $isAbsolute

Return Value

string

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

No description

Parameters

string $event
...$parameters

Return Value

ListensToEvents

ListensToEvents registerListeners(array $listeners)

No description

Parameters

array $listeners

Return Value

ListensToEvents

array getListeners(string $event = null)

No description

Parameters

string $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($breakpoint = null)

No description

Parameters

$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 reactive(bool $condition = true)

No description

Parameters

bool $condition

Return Value

HasStateBindingModifiers

HasStateBindingModifiers lazy(bool $condition = true)

No description

Parameters

bool $condition

Return Value

HasStateBindingModifiers

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

No description

Parameters

string|int|null $delay

Return Value

HasStateBindingModifiers

HasStateBindingModifiers stateBindingModifiers(array|null $modifiers)

No description

Parameters

array|null $modifiers

Return Value

HasStateBindingModifiers

string applyStateBindingModifiers(string $expression, array $lazilyEntangledModifiers = [])

No description

Parameters

string $expression
array $lazilyEntangledModifiers

Return Value

string

array getStateBindingModifiers()

No description

Return Value

array

bool isReactive()

No description

Return Value

bool

bool isLazy()

No description

Return Value

bool

bool isDebounced()

No description

Return Value

bool

string|int|null getDebounce()

No description

Return Value

string|int|null

protected bool shouldEvaluateWithState()

No description

Return Value

bool

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

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraAlpineAttributes

array getExtraAlpineAttributes()

No description

Return Value

array

ComponentAttributeBag getExtraAlpineAttributeBag()

No description

Return Value

ComponentAttributeBag

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

No description

Parameters

array|Closure $steps

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

No description

Parameters

array|Closure $steps

Return Value

Wizard

Wizard steps(array|Closure $steps)

No description

Parameters

array|Closure $steps

Return Value

Wizard

Wizard startOnStep(int|Closure $startStep)

No description

Parameters

int|Closure $startStep

Return Value

Wizard

Wizard cancelAction(Htmlable|null $action)

No description

Parameters

Htmlable|null $action

Return Value

Wizard

Wizard submitAction(Htmlable|null $action)

No description

Parameters

Htmlable|null $action

Return Value

Wizard

Wizard skippable(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

Wizard

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

No description

Parameters

string|Closure|null $key

Return Value

Wizard

Htmlable|null getCancelAction()

No description

Return Value

Htmlable|null

Htmlable|null getSubmitAction()

No description

Return Value

Htmlable|null

int getStartStep()

No description

Return Value

int

string|null getStepQueryStringKey()

No description

Return Value

string|null

bool isSkippable()

No description

Return Value

bool

bool isStepPersistedInQueryString()

No description

Return Value

bool