Lion Logo Lion Fundamentals Guides Components Blog Toggle darkmode

Steps: API Table

class: LionStep, lion-step

Fields

NamePrivacyTypeDefaultDescriptionInherited From
conditionpublicThe funtion which us run to check if this step can be transitioned to. Takes lion-steps data as a first argument `myConditionFunc(data)`.
forwardOnlypublicbooleanfalseAllows transition to step only in forward direction. Skips it if transitioned back. May be useful if the step is only showing some messages and does data loading and then makes transition to next step automatically.
initialSteppublicbooleanfalseIf set this step will be the initially enabled step There should be only ONE intial step in each steps
invertConditionpublicbooleanfalseAllows to invert condition function result.
statuspublicstring'untouched'Step status, one of: "untouched", "entered", "left", "skipped".

Methods

NamePrivacyDescriptionParametersReturnInherited From
enterpublic
leavepublic
passesConditionpublicdata: Object
skippublic

Events

NameTypeDescriptionInherited From
enterCustomEvent
leaveCustomEvent
skipCustomEvent

Attributes

NameFieldInherited From
statusstatus
invert-conditioninvertCondition
forward-onlyforwardOnly
initial-stepinitialStep

class: LionSteps, lion-steps

Fields

NamePrivacyTypeDefaultDescriptionInherited From
currentpublicnumber0Number of the current entered step.
datapublic{[key: string]: ?}{}Storage for data gathered across different steps. Data is passed into each step condition function as a first argument.
stepspublic
_internalCurrentSyncprotectedbooleantrue
_maxprotectednumber0

Methods

NamePrivacyDescriptionParametersReturnInherited From
nextpublic
previouspublic
_changeStepprotectednewCurrent: number, oldCurrent: number
_dispatchTransitionEventprotectedfromStep: {number: number, element: LionStep}, toStep: {number: number, element: LionStep}
_goToprotectednewCurrent: number, oldCurrent: number
_onCurrentChangedprotectednewValues: {current: number}, oldValues: {current: number}

Events

NameTypeDescriptionInherited From
transitionCustomEvent

Attributes

NameFieldInherited From
datadata
currentcurrent