Properties
enable Next Button
enable Next Button : ( ( state , computed ) => boolean )
Type declaration
( state , computed ) : boolean
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns boolean
is Complete
is Complete : ( ( state , computed ) => boolean )
Type declaration
( state , computed ) : boolean
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns boolean
is Enabled
is Enabled : ( ( state , computed ) => boolean )
Type declaration
( state , computed ) : boolean
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns boolean
is Journey End
is Journey End : ( ( state , computed ) => boolean )
Type declaration
( state , computed ) : boolean
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns boolean
is Skipped
is Skipped : ( ( state , computed ) => boolean )
Type declaration
( state , computed ) : boolean
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns boolean
is Submittable
is Submittable : ( ( state , computed ) => boolean )
Type declaration
( state , computed ) : boolean
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns boolean
next Step
next Step : ( ( state ,
computed ) => undefined | ComputedStep < StepSlugs , State , Metadata , StepSlugs > )
Type declaration
( state , computed ) : undefined | ComputedStep < StepSlugs , State , Metadata , StepSlugs >
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns undefined | ComputedStep < StepSlugs , State , Metadata , StepSlugs >
previous Step
previous Step : ( ( state ,
computed ) => undefined | ComputedStep < StepSlugs , State , Metadata , StepSlugs > )
Type declaration
( state , computed ) : undefined | ComputedStep < StepSlugs , State , Metadata , StepSlugs >
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns undefined | ComputedStep < StepSlugs , State , Metadata , StepSlugs >
show Next Button
show Next Button : ( ( state , computed ) => boolean )
Type declaration
( state , computed ) : boolean
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns boolean
show Previous Button
show Previous Button : ( ( state , computed ) => boolean )
Type declaration
( state , computed ) : boolean
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns boolean
show Submit Button
show Submit Button : ( ( state , computed ) => boolean )
Type declaration
( state , computed ) : boolean
Parameters
state : State
computed : ComputedSteps < StepSlugs , State , Metadata , StepSlugs >
Returns boolean
A computed step in the journey. This is orchestrated by useJourney. It contains the step itself, as well as the computed values for the step (any functions not provided by the developer, all default values, etc.). This is used internally by useJourney. You will not need to use this type directly.