templateRef

分类

组件

导出大小

283 B

上次更改

3 个月前

将 ref 绑定到模板元素的简写。

用法

vue

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

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

使用 JSX/TSX

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

当与 <script setup> 一起使用时，无需此功能，因为所有变量都将暴露给模板。它将与 ref 完全相同。

vue

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

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

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

类型声明

/**
 * @deprecated Use Vue's built-in `useTemplateRef` instead.
 *
 * Shorthand for binding ref to template element.
 *
 * @see https://vueuse.org.cn/templateRef
 * @param key
 * @param initialValue
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function templateRef
<
  T
 extends HTMLElement | SVGElement | Component
 | null,
  Keys
 extends string = string,
>(key
: Keys
, initialValue
?: T
 | null): Readonly
<Ref
<T
>>