Interface ComputedStep<StepSlugs, State, Metadata, Slug>

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.

Type Parameters

Hierarchy

  • Omit<Step<StepSlugs, State, Metadata, Slug>, "showPreviousButton" | "showNextButton" | "previousStep" | "nextStep">
    • ComputedStep

Properties

component: ComponentType<ComponentProps<State, Metadata>>
enableNextButton: ((state, computed) => boolean)

Type declaration

    • (state, computed): boolean
    • Parameters

      • state: State
      • computed: ComputedSteps<StepSlugs, State, Metadata, StepSlugs>

      Returns boolean

isComplete: ((state, computed) => boolean)

Type declaration

    • (state, computed): boolean
    • Parameters

      • state: State
      • computed: ComputedSteps<StepSlugs, State, Metadata, StepSlugs>

      Returns boolean

isEnabled: ((state, computed) => boolean)

Type declaration

    • (state, computed): boolean
    • Parameters

      • state: State
      • computed: ComputedSteps<StepSlugs, State, Metadata, StepSlugs>

      Returns boolean

isJourneyEnd: ((state, computed) => boolean)

Type declaration

    • (state, computed): boolean
    • Parameters

      • state: State
      • computed: ComputedSteps<StepSlugs, State, Metadata, StepSlugs>

      Returns boolean

isSkipped: ((state, computed) => boolean)

Type declaration

    • (state, computed): boolean
    • Parameters

      • state: State
      • computed: ComputedSteps<StepSlugs, State, Metadata, StepSlugs>

      Returns boolean

isSubmittable: ((state, computed) => boolean)

Type declaration

    • (state, computed): boolean
    • Parameters

      • state: State
      • computed: ComputedSteps<StepSlugs, State, Metadata, StepSlugs>

      Returns boolean

nextStep: ((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>

previousStep: ((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>

showNextButton: ((state, computed) => boolean)

Type declaration

    • (state, computed): boolean
    • Parameters

      • state: State
      • computed: ComputedSteps<StepSlugs, State, Metadata, StepSlugs>

      Returns boolean

showPreviousButton: ((state, computed) => boolean)

Type declaration

    • (state, computed): boolean
    • Parameters

      • state: State
      • computed: ComputedSteps<StepSlugs, State, Metadata, StepSlugs>

      Returns boolean

showSubmitButton: ((state, computed) => boolean)

Type declaration

    • (state, computed): boolean
    • Parameters

      • state: State
      • computed: ComputedSteps<StepSlugs, State, Metadata, StepSlugs>

      Returns boolean

slug: Slug

Generated using TypeDoc