Tracking State

Tracking state of the guides is stored in the browser's localStorage, on key lusift_state.

Lusift.getTrackingState() retrieves the tracking state of all the guides saved by Lusift.

type TrackingState = {
    [guideId: string]: GuideTrackingState;
}

type GuideTrackingState = {
    asyncSteps: {
        [stepId: number]: {
            toOpen: boolean;
        };
    };
    currentStepindex: number;
    enabled: boolean;
    finished: boolean;
    prematurelyClosed: boolean;
}

asyncSteps refers to hotspot steps with async set to true.

When toOpen is true, the hotspot will appear at the target dom element.

currentStepindex is the index of the currently displayed or to display step.

Weather the guide is enabled.

finished is true when all of the sync steps have been closed.

prematurelyClosed is set to true when Lusift.close() is used to close the guide.