phx-react/dist/cjs/stores/page-tracker/page-tracker.d.ts

PHX REACT

type PageEvent = 'forward' | 'back' | 'push' | undefined;
export type PageTrackerState = {
    /** current page index */
    pageIndex: number;
    /** correct `document.referrer` */
    referrer: string;
    /** whether the current page is the first page */
    isFirstPage: boolean;
    /** whether the current page is the last page */
    isLastPage: boolean;
    /** whether the user navigated to the page via browser back/forward buttons or by clicking a link */
    pageEvent: PageEvent;
    /** history browsing record */
    pageHistory: Array<string>;
    /** total page history length */
    pageHistoryLength: number;
};
export type HistoryCustomState = {
    __REACT_PAGE_TRACKER_INTERNAL__: Pick<PageTrackerState, 'pageIndex' | 'referrer' | 'pageHistory' | 'pageHistoryLength'>;
};
export declare const usePageTrackerHandler: () => void;
export declare const PageTracker: () => null;
export {};