useWindowSize ​
Reactive window size
Demo ​
Infinity x Infinity
Usage ​
js
import { useWindowSize } from '@vueuse/core'
const { width, height } = useWindowSize()
Component Usage ​
This function also provides a renderless component version via the
@vueuse/components
package. Learn more about the usage.
vue
<template>
<UseWindowSize v-slot="{ width, height }">
Width: {{ width }}
Height: {{ height }}
</UseWindowSize>
</template>
Type Declarations ​
typescript
export interface UseWindowSizeOptions extends ConfigurableWindow {
initialWidth?: number
initialHeight?: number
/**
* Listen to window `orientationchange` event
*
* @default true
*/
listenOrientation?: boolean
/**
* Whether the scrollbar should be included in the width and height
* Only effective when `type` is `'inner'`
*
* @default true
*/
includeScrollbar?: boolean
/**
* Use `window.innerWidth` or `window.outerWidth`
*
* @default 'inner'
*/
type?: "inner" | "outer"
}
/**
* Reactive window size.
*
* @see https://vueuse.org/useWindowSize
* @param options
*/
export declare function useWindowSize(options?: UseWindowSizeOptions): {
width: Ref<number, number>
height: Ref<number, number>
}
export type UseWindowSizeReturn = ReturnType<typeof useWindowSize>
Source ​
Contributors ​
Anthony Fu
Jelf
Antério Vieira
Anthony Fu
Al-Khawarizmi
Indrek Ardel
Zhousg
vaakian X
vaakian X
Shinigami
wheat
Alex Kozack
Roman Pavlov