- useJourney<StepSlugs, State, Metadata>(steps, state, setState, metadata): {
CurrentStep: (() => Element);
enableNextButton: boolean;
goToNextStep: (() => void);
goToPreviousStep: (() => void);
hasNextStep: boolean;
hasPreviousStep: boolean;
isComplete: boolean;
isEnabled: boolean;
isJourneyEnd: boolean;
isSkipped: boolean;
isSubmittable: boolean;
nextStep: undefined | ComputedStep<StepSlugs, State, Metadata, StepSlugs>;
previousStep: undefined | ComputedStep<StepSlugs, State, Metadata, StepSlugs>;
showNextButton: boolean;
showPreviousButton: boolean;
showSubmitButton: boolean;
slug: StepSlugs;
}
-
Type Parameters
-
StepSlugs extends string
-
-
Metadata extends object
Parameters
-
steps: Steps<StepSlugs, State, Metadata>
-
state: State
-
setState: Dispatch<SetStateAction<State>>
-
metadata: Metadata
Returns {
CurrentStep: (() => Element);
enableNextButton: boolean;
goToNextStep: (() => void);
goToPreviousStep: (() => void);
hasNextStep: boolean;
hasPreviousStep: boolean;
isComplete: boolean;
isEnabled: boolean;
isJourneyEnd: boolean;
isSkipped: boolean;
isSubmittable: boolean;
nextStep: undefined | ComputedStep<StepSlugs, State, Metadata, StepSlugs>;
previousStep: undefined | ComputedStep<StepSlugs, State, Metadata, StepSlugs>;
showNextButton: boolean;
showPreviousButton: boolean;
showSubmitButton: boolean;
slug: StepSlugs;
}
-
CurrentStep: (() => Element)
-
- (): Element
-
Returns Element
-
enableNextButton: boolean
-
goToNextStep: (() => void)
-
goToPreviousStep: (() => void)
-
hasNextStep: boolean
-
hasPreviousStep: boolean
-
isComplete: boolean
-
isEnabled: boolean
-
isJourneyEnd: boolean
-
isSkipped: boolean
-
isSubmittable: boolean
-
nextStep: undefined | ComputedStep<StepSlugs, State, Metadata, StepSlugs>
-
previousStep: undefined | ComputedStep<StepSlugs, State, Metadata, StepSlugs>
-
showNextButton: boolean
-
showPreviousButton: boolean
-
showSubmitButton: boolean
-
slug: StepSlugs