The component to render for the step. This is the component that will be rendered when the user is on this step.
Optional
enableWhether to enable the 'next' button in the journey. This is different from showNextButton
in that it only disables the button, but still shows it.
true if the current step is complete
Optional
isWhether the step is complete.
true
Optional
isWhether the step is enabled. If disabled, the step will not show up in the journey. This is useful for steps that are only shown conditionally.
true
Optional
isWhether this step represents the end of the journey. If so, the 'next' button will not be shown in the journey. This is useful for steps that represent a 'thank you' page or a 'success' page.
true if the step is the last step in the journey, taking into account skipped steps
Optional
isWhether the step is skipped. If skipped, the step won't be considered when hitting 'previous' or 'next'. This is useful for steps that are only shown conditionally.
false
Optional
isWhether the step is submittable. If not submittable, the 'submit' / 'next' button will not be shown in the journey.
This is useful for the last step in the journey. It should not be used to prevent the user from submitting the form if the step is not complete.
For that, use isComplete
instead.
true
Optional
nextThe next step in the journey. This is used to navigate to the next step when the user clicks the 'next' button.
the next step in the journey, taking into account skipped steps
Optional
previousThe previous step in the journey. This is used to navigate to the previous step when the user clicks the 'previous' button.
the previous step in the journey, taking into account skipped steps
Optional
showWhether to show the 'next' button in the journey.
true if the step is not the last step in the journey, taking into account skipped steps
Optional
showWhether to show the 'previous' button in the journey.
true if the step is not the first step in the journey, taking into account skipped steps
Optional
showWhether to show the 'submit' button in the journey.
true if the step is the last step in the journey, taking into account skipped steps
The slug of the step. This is used to identify the step and to navigate to it.
Generated using TypeDoc
A step in the journey, as defined by the developer.