my-swiss-knife: - v1.9.9
    Preparing search index...

    Type Alias StepperContextType

    Describes the shape of the Stepper context used to control step-based navigation.

    type StepperContextType = {
        canProceed: (step: number) => boolean;
        currentStep: number;
        goTo: (step: number) => void;
        next: () => void;
        prev: () => void;
        setCanProceed: (step: number, canProceed: boolean) => void;
    }
    Index

    Properties

    canProceed currentStep goTo next prev setCanProceed

    Properties

    canProceed: (step: number) => boolean

    Checks whether a specific step is allowed to proceed.

    Type Declaration

      • (step: number): boolean

      • Parameters

        • step: number

          Step index to check.

        Returns boolean

        True if the step can be proceeded from, otherwise false.

    currentStep: number

    Index of the current active step.

    goTo: (step: number) => void

    Jumps to the specified step index.

    Type Declaration

      • (step: number): void

      • Parameters

        • step: number

          Target step index to navigate to.

        Returns void

    next: () => void

    Advances to the next step.

    prev: () => void

    Moves to the previous step (but not below index 0).

    setCanProceed: (step: number, canProceed: boolean) => void

    Sets whether a specific step is allowed to proceed.

    Type Declaration

      • (step: number, canProceed: boolean): void

      • Parameters

        • step: number

          Step index to set permission for.

        • canProceed: boolean

          Whether the step can be navigated past.

        Returns void

    Settings

    Member Visibility

    On This Page

    Properties