VueUse

templateRef

Shorthand for binding ref to template element.

Usage

<template>
  <div ref="target"></div>
</template>

<script lang="ts">
import { templateRef } from '@vueuse/core'

export default {
  setup() {
    const target = templateRef('target')

    // no need to return the `target`, it will bind to the ref magically
  }
}
</script>

With JSX/TSX

import { templateRef } from '@vueuse/core'

export default {
  setup() {
    const target = templateRef<HTMLElement | null>('target', null)

    // use string ref
    return () => <div ref="target"></div>
  },
}

<script setup>

There is no need for this when using with <script setup> since all the variables will be exposed to the template. It will be exactly the same as ref.

<template>
  <div ref="target"></div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const target = ref<HTMLElement | null>(null)
</script>

Type Declarations

/**
 * Shorthand for binding ref to template element.
 *
 * @see /templateRef
 * @param key
 * @param initialValue
 */
export declare function templateRef<T extends Element | null>(
  key: string,
  initialValue?: T | null
): Readonly<Ref<T>>

Source

Source • Docs