目录
虽然 Vue 的声明性渲染模型为你抽象了大部分对 DOM 的直接操作,但在某些情况下,我们仍然需要直接访问底层 DOM 元素。要实现这一点,我们可以使用特殊的 ref
attribute:
ref
是一个特殊的 attribute,和v-for
章节中提到的key
类似。它允许我们在一个特定的 DOM 元素或子组件实例被挂载后,获得对它的直接引用。这可能很有用,比如说在组件挂载时将焦点设置到一个 input 元素上,或在一个元素上初始化一个第三方库。
在Vue 2中,我们可以使用ref
属性来获取模板中的DOM元素或组件实例的引用。这使得在Vue组件中访问和操作特定元素或组件变得非常方便。
要获取一个DOM元素的引用,我们可以在模板中使用ref
属性并为其指定一个名称。然后,我们可以通过this.$refs
来访问这个引用。
- <template>
- <div>
- <button ref="myButton">点击我</button>
- </div>
- </template>
-
- <script>
- export default {
- mounted() {
- // 在生命周期钩子中使用$refs来获取引用
- this.$refs.myButton.innerText = '已点击';
- }
- }
- </script>
在上面的例子中,我们给按钮添加了一个ref
属性,值为myButton
。然后在mounted
生命周期钩子中,我们使用this.$refs.myButton
来获取到这个按钮的引用,并修改了它的文本内容。
如果我们想获取一个子组件的引用,也可以使用相同的ref
属性来实现。
- <template>
- <div>
- <ChildComponent ref="myChildComponent" />
- </div>
- </template>
-
- <script>
- import ChildComponent from './ChildComponent.vue';
-
- export default {
- components: {
- ChildComponent
- },
- mounted() {
- // 在生命周期钩子中使用$refs来获取子组件的引用
- this.$refs.myChildComponent.someMethod();
- }
- }
- </script>
在上面的例子中,我们在父组件中引入了一个名为ChildComponent
的子组件,并在模板中使用了ref
属性来获取它的引用。然后在mounted
生命周期钩子中,我们可以使用this.$refs.myChildComponent
来访问并调用子组件的方法。
v-for
中的模板引用当在 v-for
中使用模板引用时,相应的引用中包含的值是一个数组
- <script>
- export default {
- data() {
- return {
- list: [
- /* ... */
- ]
- }
- },
- mounted() {
- console.log(this.$refs.items)
- }
- }
- </script>
-
- <template>
- <ul>
- <li v-for="item in list" ref="items">
- {{ item }}
- </li>
- </ul>
- </template>
应该注意的是,ref 数组并不保证与源数组相同的顺序。
为了通过组合式 API 获得该模板引用,我们需要声明一个同名的 ref:
- <script setup>
- import { ref, onMounted } from 'vue'
-
- // 声明一个 ref 来存放该元素的引用
- // 必须和模板里的 ref 同名
- const input = ref(null)
-
- onMounted(() => {
- input.value.focus()
- })
- </script>
-
- <template>
- <input ref="input" />
- </template>
如果不使用 ,需确保从
setup()
返回 ref:
- export default {
- setup() {
- const input = ref(null)
- // ...
- return {
- input
- }
- }
- }
注意,你只可以在组件挂载后才能访问模板引用。如果你想在模板中的表达式上访问 input
,在初次渲染时会是 null
。这是因为在初次渲染前这个元素还不存在呢!
如果你需要侦听一个模板引用 ref 的变化,确保考虑到其值为 null
的情况:
- watchEffect(() => {
- if (input.value) {
- input.value.focus()
- } else {
- // 此时还未挂载,或此元素已经被卸载(例如通过 v-if 控制)
- }
- })
v-for
中的模板引用当在 v-for
中使用模板引用时,对应的 ref 中包含的值是一个数组,它将在元素被挂载后包含对应整个列表的所有元素:
- <script setup>
- import { ref, onMounted } from 'vue'
-
- const list = ref([
- /* ... */
- ])
-
- const itemRefs = ref([])
-
- onMounted(() => console.log(itemRefs.value))
- </script>
-
- <template>
- <ul>
- <li v-for="item in list" ref="itemRefs">
- {{ item }}
- </li>
- </ul>
- </template>
除了使用字符串值作名字,ref
attribute 还可以绑定为一个函数,会在每次组件更新时都被调用。该函数会收到元素引用作为其第一个参数:
<input :ref="(el) => { /* 将 el 赋值给一个数据属性或 ref 变量 */ }">
注意我们这里需要使用动态的 :ref
绑定才能够传入一个函数。当绑定的元素被卸载时,函数也会被调用一次,此时的 el
参数会是 null
。你当然也可以绑定一个组件方法而不是内联函数。
- <div v-for=(item, index) in arrList>
- <div :ref="el => myRefs[index]=el"></div>
- </div>
-
- setup(){
- const myRefs = ref([]) as Ref<string[]>
- return {
- myRefs,
- }
- }
模板引用也可以被用在一个子组件上。这种情况下引用中获得的值是组件实例:
- <script setup>
- import { ref, onMounted } from 'vue'
- import Child from './Child.vue'
-
- const child = ref(null)
-
- onMounted(() => {
- // child.value 是 <Child /> 组件的实例
- })
- </script>
-
- <template>
- <Child ref="child" />
- </template>
如果一个子组件使用的是选项式 API 或没有使用 ,被引用的组件实例和该子组件的
this
完全一致,这意味着父组件对子组件的每一个属性和方法都有完全的访问权。这使得在父组件和子组件之间创建紧密耦合的实现细节变得很容易,当然也因此,应该只在绝对需要时才使用组件引用。大多数情况下,你应该首先使用标准的 props 和 emit 接口来实现父子组件交互。
有一个例外的情况,使用了
的组件是默认私有的:一个父组件无法访问到一个使用了
的子组件中的任何东西,除非子组件在其中通过
defineExpose
宏显式暴露:
- <script setup>
- import { ref } from 'vue'
-
- const a = 1
- const b = ref(2)
-
- // 像 defineExpose 这样的编译器宏不需要导入
- defineExpose({
- a,
- b
- })
- </script>
当父组件通过模板引用获取到了该组件的实例时,得到的实例类型为 { a: number, b: number }
(ref 都会自动解包,和一般的实例一样)。