useTemplateRefsList

Category

Component

Export Size

177 B

Last Changed

4 months ago

Shorthand for binding refs to template elements and components inside v-for.

WARNING

This function only works for Vue 3

Demo

source

12345

Open the console to see the output

Usage

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

const refs = useTemplateRefsList<HTMLDivElement>()

onUpdated(() => {
  console.log(refs)
})
</script>

<template>
  <div v-for="i of 5" :key="i" :ref="refs.set" />
</template>

Type Declarations

export type TemplateRefsList<T> = T[] & {
  set: (el: object | null) => void
}
export declare function useTemplateRefsList<T = Element>(): Readonly<
  Ref<Readonly<TemplateRefsList<T>>>
>

Source

Source • Demo • Docs

Contributors

Anthony Fu

Anthony Fu

bjym

Changelog

v10.8.0 on 2/20/2024

a086e - fix: stricter types