useWindowSize

Category

Elements

Export Size

541 B

Last Changed

5 days ago

Reactive window size

Demo

Usage

import { useWindowSize } from '@reause/core'

const { width, height } = useWindowSize() // plain numbers, re-render on resize
// SSR renders the Infinity defaults; after mount it tracks the real window size

Type Declarations

export interface UseWindowSizeOptions extends ConfigurableWindow {
    initialWidth?: number;
    initialHeight?: number;
    listenOrientation?: boolean;
    includeScrollbar?: boolean;
    type?: 'inner' | 'outer' | 'visual';
}

export interface UseWindowSizeReturn {
    width: number;
    height: number;
}

export function useWindowSize(options?: UseWindowSizeOptions): UseWindowSizeReturn

Source

Source · Demo · VueUse

Contributors

Changelog

v0.1.0 on

00605 - fix(core): resolve useWindowSize audit findings (#697)