posthog-tours
Version:
A TypeScript package for creating guided tours in PostHog
30 lines (29 loc) • 1.03 kB
TypeScript
import { PostHogToursOptions, TourConfig, TourEligibilityResult } from './types';
export declare class PostHogTours {
private posthog;
private tours;
private observers;
private intersectionObservers;
private userPropertyPrefix;
private defaultOnEligible?;
private shouldCheckElementVisibility;
private activeTourId;
private localStorageKey;
private debug;
constructor(options: PostHogToursOptions);
private log;
private syncLocalStorageWithPostHog;
private validateFeatureFlags;
private startMonitoringTours;
private monitorElement;
checkTourEligibility(tourId: string): Promise<TourEligibilityResult>;
private getSeenToursFromStorage;
private saveSeenToursToStorage;
private checkVisibility;
private hasTourBeenSeen;
markTourAsSeen(tourId: string): void;
checkAllTours(): Promise<TourEligibilityResult[]>;
reset(): void;
getTourConfig(flagKey: string): TourConfig | undefined;
forceTour(tourId: string): Promise<boolean>;
}