useElementSize

类别

Elements

导出体积

909 B

上次更改

3 months ago

获取 HTML 元素的响应式大小。ResizeObserver MDN

示例

源码 playground (beta)

调整框大小以查看更改

width: 0
height: 0

用法

vue

<script setup lang="ts">
import { useElementSize
 } from '@vueuse/core'
import { useTemplateRef
 } from 'vue'

const el
 = useTemplateRef
('el')
const { width
, height
 } = useElementSize
(el
)
</script>

<template>
  <div
 ref
="el
">
    Height: {{ height
 }}
    Width: {{ width
 }}
  </div
>
</template>

组件用法

vue

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

指令用法

vue

<script setup lang="ts">
import { vElementSize
 } from '@vueuse/components'

function onResize
({ width
, height
 }: { width
: number, height
: number }) {
  console
.log
(width
, height
)
}
</script>

<template>
  <textarea
 v-element-si
ze="onResize
" />
  <!-- 使用选项 -->
  <textarea

    v-element-si
ze="[
onResize
, { 
width
: 100, 
height
: 100 }, { 
box
: 'content-box' }]
"
  />
</template>

类型声明

export interface ElementSize {
  width
: number
  height
: number
}
export interface UseElementSizeOptions extends UseResizeObserverOptions {}
export interface UseElementSizeReturn {
  width
: ShallowRef
<number>
  height
: ShallowRef
<number>
  stop
: () => void
}
/**
 * HTML 元素的响应式尺寸。
 *
 * @see https://vueuse.org/useElementSize
 */
export declare function useElementSize
(
  target
: MaybeComputedElementRef
,
  initialSize
?: ElementSize,
  options
?: UseElementSizeOptions,
): UseElementSizeReturn