@fbaconversio/onborda/dist/hooks/useBreakpoint.d.ts

The ultimate product tour library for Next.js

import { Step, Breakpoint, ExtendedSide } from "../types";
type ScreenSize = {
    width: number;
    height: number;
    breakpoint: string;
    currentSide: ExtendedSide;
    style: React.CSSProperties;
};
/**
 * Hook to get the current screen size and responsive breakpoints
 * @param breakpoints Custom breakpoints object
 * @param currentStep Current step from the tour
 * @returns Current screen dimensions, responsive flags, and the appropriate side for the current breakpoint
 */
export declare const useBreakpoint: ({ breakpoints, extendSides, currentStep, }: {
    breakpoints: Partial<Record<Breakpoint, number>> & {
        [key: string]: number;
    };
    extendSides: {
        [key: string]: React.CSSProperties;
    };
    currentStep?: Step;
}) => ScreenSize;
export default useBreakpoint;