analytica-frontend-lib/dist/hooks/useScreen.d.ts

Repositório público dos componentes utilizados nas plataformas da Analytica Ensino

type ScreenSize = {
    width: number;
    height: number;
};
type UseScreenSizeOptions = {
    width?: boolean;
    height?: boolean;
};
type UseScreenSizeReturn = {
    width?: number;
    height?: number;
    screenSize: ScreenSize;
};
/**
 * Hook para capturar o tamanho da tela do usuário
 * @param options - Opções para escolher quais dimensões capturar
 * @returns Objeto com as dimensões solicitadas e o tamanho completo da tela
 */
export declare const useScreenSize: (options?: UseScreenSizeOptions) => UseScreenSizeReturn;
/**
 * Hook para capturar apenas a largura da tela
 */
export declare const useScreenWidth: () => number;
/**
 * Hook para capturar apenas a altura da tela
 */
export declare const useScreenHeight: () => number;
/**
 * Hook para capturar o tamanho completo da tela
 */
export declare const useFullScreenSize: () => ScreenSize;
/**
 * Hook to detect screen size
 * @returns true if the screen is mobile, false otherwise
 */
export declare const useMobile: () => boolean;
export {};
//# sourceMappingURL=useScreen.d.ts.map