frontend
    Preparing search index...

    Interface UseTutorialReturn

    Return type of the useTutorial hook.

    interface UseTutorialReturn {
        canResume: boolean;
        currentStep: TutorialStep | null;
        currentStepIndex: number;
        isActive: boolean;
        isCompleted: boolean;
        next: () => void;
        restart: () => void;
        skip: () => void;
        start: () => void;
        totalSteps: number;
    }
    Index

    Properties

    canResume currentStep currentStepIndex isActive isCompleted next restart skip start totalSteps

    Properties

    canResume: boolean

    Whether a previous session can be resumed from a saved step.

    currentStep: TutorialStep | null

    The current step definition, or null if not active.

    currentStepIndex: number

    Zero-based index of the current step.

    isActive: boolean

    Whether the tutorial is currently running.

    isCompleted: boolean

    Whether the tutorial has been completed (persisted in localStorage).

    next: () => void

    Advance to the next step, completing the tutorial if on the last step.

    restart: () => void

    Restart the tutorial from step 0, clearing any saved progress.

    skip: () => void

    Skip/dismiss the tutorial without marking it complete. Saves progress if past step 0.

    start: () => void

    Start the tutorial, resuming from saved progress if available.

    totalSteps: number

    Total number of steps in the tutorial.

    Settings

    Member Visibility

    On This Page

    Properties