Vue3 11.模板引用

模板引用

在某些情况下，需要访问底层DOM元素，想要实现这一点，需要使用特殊的refattribute：

<input ref="input" />

ref是一个特殊的attribute，它允许在一个特定的DOM元素或者子组件实例被挂载后，获得对它的直接引用。

访问模板引用

要在组合式API中获取引用，可以使用辅助函数useTemplateRef()

<script setup>
import {useTemplateRef, onMounted} from 'vue'

//第一个参数必须与模板中的ref值匹配
const input = useTemplateRef('my-input')

onMounted(() => {
  input.value.focus()
})
</script>

<template>
  <input ref="my-input" />
</template>

注意⚠️，只可以在组件挂载后才能访问模板引用。如果想在模板中的表达式访问input，在初次渲染时会是null，因为在初次渲染前这个元素还不存在。如果你需要监听一个模板引用ref的变化，确保考虑到其值为null的情况：
watchEffect(() => {
  if (input.value) {
     input.value.focus()
  } else {
     // 此时还没挂载，或此元素已经被卸载（例如通过v-if控制）
  }
})

组件上的ref

模板引用也可以被用在一个子组件上，这种情况下引用中获得的值是组件实例：

<script setup>
import {useTemplateRef, onMounted} from 'vue'
import Child from './Child.vue'

const childRef = useTemplateRef('child')

onMounted(() => {
  // childRef.value 将持有 <Child /> 的实例
})
</script>

<template>
  <Child ref="child" />
</template>

父组件对子组件的控制区别：

子组件使用的是选项式API或者没有使用<script setup>，被引用的组件实例和该子组件的this完全一致，这意味着父组件对子组件的每一个属性和方法都有完全的访问权。所以应该只在绝对需要时才使用组件引用。大多数情况下，应该首先使用标准的props和emit接口来实现父子组件交互。
使用了<script setup>的组件是默认私有的，父组件无法访问到一个使用了<script setup>的子组件中的任何东西，除非子组件在其中通过defineExpose宏显式暴露：

<script setup>
import {ref} from 'vue'

const a = 1
const b = ref(2)

//像defineExpose这样的编译器宏不需要导入
defineExpose({
  a,
  b
})
</script>

当父组件通过模板引用获取到了该组件的实例时，得到的实例类型为{a: number, b: number}(ref都会自动解包，和一般的实例一样)。

`v-for`中的模板引用

当在v-for中使用模板引用时，对应的ref中包含的值是一个数组，它将在元素被挂载后包含对应整个列表的所有元素：

<script setup>
import {ref, useTemplateRef, onMounted} from 'vue'

const list = ref([
  /* ... */
])

const itemRefs = useTemplateRef('items')

onMounted(() => console.log(itemRefs.value))
</script>

<template>
  <ul>
    <li v-for="item in list" ref="items">
      {{ item }}
    </li>
  </ul>
</template>

注意：ref数组并不保证与源数组相同的顺序

函数模板引用

除了使用字符串值作名字，refattribute还可以绑定为一个函数，会在每次组件更新时都被调用。该函数会收到元素引用作为其第一个参数：

<input :ref="(el) => { /* 将el赋值给一个数据属性或ref变量 */ }"

注意这里需要使用动态的:ref绑定才能够传入一个函数。当绑定的元素被卸载时，函数也会调用一次，此时的el参数会是null。当然也可以绑定一个组件方法而不是内联函数。