模板引用
虽然 Vue 的声明性渲染模型为你抽象了大部分对 DOM 的直接操作,但在某些情况下,我们仍然需要直接访问底层 DOM 元素。要实现这一点,我们可以使用特殊的
ref
attribute:
ref
是一个特殊的 attribute,和
v-for
章节中提到的
key
类似。它允许我们在一个特定的 DOM 元素或子组件实例被挂载后,获得对它的直接引用。这可能很有用,比如说在组件挂载时将焦点设置到一个 input 元素上,或在一个元素上初始化一个第三方库。
访问模板引用
为了通过组合式 API 获得该模板引用,我们需要声明一个同名的 ref:
如果不使用
<script setup>
,需确保从
setup()
返回 ref:
注意,你只可以
在组件挂载后
才能访问模板引用。如果你想在模板中的表达式上访问
input
,在初次渲染时会是
null
。这是因为在初次渲染前这个元素还不存在呢!
v-for
中的模板引用
需要 v3.2.25 及以上版本
应该注意的是,ref 数组 并不 保证与源数组相同的顺序。
函数模板引用
除了使用字符串值作名字,
ref
attribute 还可以绑定为一个函数,会在每次组件更新时都被调用。该函数会收到元素引用作为其第一个参数:
注意我们这里需要使用动态的
:ref
绑定才能够传入一个函数。当绑定的元素被卸载时,函数也会被调用一次,此时的
el
参数会是
null
。你当然也可以绑定一个组件方法而不是内联函数。
组件上的 ref
这一小节假设你已了解 组件 的相关知识,或者你也可以先跳过这里,之后再回来看。
模板引用也可以被用在一个子组件上。这种情况下引用中获得的值是组件实例:
如果一个子组件使用的是选项式 API
或没有使用
<script setup>
,被引用的组件实例和该子组件的
this
完全一致,这意味着父组件对子组件的每一个属性和方法都有完全的访问权。这使得在父组件和子组件之间创建紧密耦合的实现细节变得很容易,当然也因此,应该只在绝对需要时才使用组件引用。大多数情况下,你应该首先使用标准的 props 和 emit 接口来实现父子组件交互。
有一个例外的情况,使用了
<script setup>
的组件是
默认私有
的:一个父组件无法访问到一个使用了
<script setup>
的子组件中的任何东西,除非子组件在其中通过
defineExpose
宏显式暴露:
当父组件通过模板引用获取到了该组件的实例时,得到的实例类型为
{ a: number, b: number }
(ref 都会自动解包,和一般的实例一样)。
TypeScript 用户请参考: 为组件的模板引用标注类型