Skip to content

useElementSize

Category
Export Size
955 B
Last Changed
4 months ago

Reactive size of an HTML element. ResizeObserver MDN

Demo

Resize the box to see changes

Usage

vue
<script>
import { ref } from 'vue'
import { useElementSize } from '@vueuse/core'

export default {
  setup() {
    const el = ref(null)
    const { width, height } = useElementSize(el)

    return {
      el,
      width,
      height,
    }
  }
}
</script>

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

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

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

Directive Usage

This function also provides a directive version via the @vueuse/components package. Learn more about the usage.

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-size="onResize" />
  <!-- with options -->
  <textarea v-element-size="[onResize, { width: 100, height: 100 }, { box: 'content-box' }]" />
</template>

Type Declarations

typescript
export interface ElementSize {
  width: number
  height: number
}
/**
 * Reactive size of an HTML element.
 *
 * @see https://vueuse.org/useElementSize
 */
export declare function useElementSize(
  target: MaybeComputedElementRef,
  initialSize?: ElementSize,
  options?: UseResizeObserverOptions,
): {
  width: Ref<number>
  height: Ref<number>
  stop: () => void
}
export type UseElementSizeReturn = ReturnType<typeof useElementSize>

Source

SourceDemoDocs

Contributors

Anthony Fu
webfansplz
Mikhailov Nikita
wheat
menghan
仿生狮子
ByMykel
jing
vaakian X
Vasily Kuzin
vaakian X
Jelf
Shinigami
Alex Kozack
Sanxiaozhizi

Changelog

v10.6.0 on 11/9/2023
165c8 - fix: get value in onMounted hook (#3366)
5f545 - feat: stop function (#3367)
v10.4.0 on 8/25/2023
791f7 - fix: add as prop for component usage (#3274)
v9.12.0 on 1/29/2023
902b3 - fix: fix incorrect element size on SVG (#2661)
30475 - fix: use contentBoxSize as an array in useElementSize (#2520)
v9.11.0 on 1/17/2023
d5321 - fix(components): mark defineComponent as pure (#2623)
v9.2.0 on 9/5/2022
3c642 - feat: support box sizing (#2143)
v8.9.3 on 7/14/2022
28db2 - fix(useResizeObserver)!: rename type ResizeObserverOptions to UseResizeObserverOptions (#1862)

Released under the MIT License.