コンテンツへスキップ

useTemplateRefsList

カテゴリ
エクスポートサイズ
177 B
最終更新
先週

v-for 内のテンプレート要素とコンポーネントに ref をバインドするための短縮形。

警告

この関数は Vue 3 でのみ動作します

デモ

12345
コンソールを開いて出力を確認してください

使用法

vue
<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>

型宣言

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

ソース

ソースデモドキュメント

コントリビューター

Anthony Fu
Anthony Fu
bjym

変更履歴

v12.0.0-beta.1 2024/11/21
0a9ed - feat!: Vue 2 のサポートを削除、バンドルの最適化、クリーンアップ (#4349)
v10.8.0 2024/2/20
a086e - fix: より厳密な型

MITライセンスの下でリリースされています。