Skip to content

useWindowSize

Category
Export Size
964 B
Last Changed
15 minutes ago

响应式窗口大小

Demo

Infinity x Infinity

用法

js
import { useWindowSize } from '@vueuse/core'

const { width, height } = useWindowSize()

组件使用

vue
<template>
  <UseWindowSize v-slot="{ width, height }">
    Width: {{ width }}
    Height: {{ height }}
  </UseWindowSize>
</template>

类型声明

typescript
export interface UseWindowSizeOptions extends ConfigurableWindow {
  /**
   * 初始宽度
   */
  initialWidth?: number
  /**
   * 初始高度
   */
  initialHeight?: number
  /**
   * 监听窗口 `orientationchange` 事件
   *
   * @default true
   */
  listenOrientation?: boolean
  /**
   * 是否包含滚动条在宽度和高度中
   * 仅当 `type` 为 `'inner'` 时有效
   *
   * @default true
   */
  includeScrollbar?: boolean
  /**
   * 使用 `window.innerWidth` 或 `window.outerWidth`
   *
   * @default 'inner'
   */
  type?: "inner" | "outer"
}
/**
 * 响应式窗口大小。
 *
 * @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

SourceDemoDocs

贡献者

Anthony Fu
丶远方
Jelf
Antério Vieira
Anthony Fu
Al-Khawarizmi
Indrek Ardel
Zhousg
vaakian X
vaakian X
Shinigami
wheat
Alex Kozack
Roman Pavlov

变更日志

v11.0.0-beta.2 on 7/17/2024
bfba3 - feat: add ability to get outer sizes of the window (#3999)
v10.0.0-beta.3 on 4/12/2023
4e7b0 - fix!: use media query instead of orientationchange listener (#2919)
v9.11.0 on 1/17/2023
d5321 - fix(components): mark defineComponent as pure (#2623)

Released under the MIT License.