vue3中基于script setup语法糖的$refs使用

最新推荐文章于 2025-05-08 08:22:34 发布

原创最新推荐文章于 2025-05-08 08:22:34 发布 · 6.5k 阅读

22 ·

CC 4.0 BY-SA版权

文章标签：

#前端 #javascript #vue

本文介绍了在 Vue3 中如何使用 script setup 语法糖来调用子组件的方法。不同于 Vue2，Vue3 需要通过 ref 获取子组件实例，并在 onMounted 钩子中调用其方法。子组件需使用 defineExpose 将方法暴露出去。详细步骤包括设置子组件 ref、获取子组件实例、子组件定义公开方法和父组件调用方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在用vue3开发项目的时候，需要调用子组件的方法，于是想着用$refs来实现，但是我是使用script setup语法糖，原先vue2的语法已经不适用了。

于是一番折腾和查阅资料，终于搞定。

vue2语法

vue2语法在组件上设置ref属性后，在代码里可以通过 this.$refs.ref值访问到对应的子组件。

一个设置ref值的组件：

<base-input ref="usernameInput"></base-input>

在js代码中可以通过如下代码访问到这个组件：

this.$refs.usernameInput

可以调用里面的方法：

// 假设 base-input 组件内有方法foo

this.$refs.usernameInput.foo();

详细使用可以参考底部列出的参考文章。

vue3使用

网上找了一些文章比较零散，而且试了下都不能用，但是通过这些文章了解到了一些关键信息，最后整理出如下几步：

1. 组件设置ref值

这个和vue2的类似，父组件调用子组件的时候设置ref值。

<ChildVue ref="childRef" />

2. 组件实例获取

设置完成后，vue3可以通过ref方法获取。

const childRef = ref();

这边变量的名字需要和上面ref的一致。如何直接打印childRef，这个时候会是：

undefined

因为页面组件还没有挂载完成，所以需要在挂载完成之后才能正常使用。

onMounted(() => {
    console.log(childRef.value); // Proxy {…}
});

3. 子组件内设置对外公开的变量

上面第2步获取到子组件实例后，无法使用子组件内的方法，因为使用 script setup 的组件默认是关闭的，如果需要公开，需要使用 defineExpose 编译器宏。

// 子组件代码
const foo = () => {
  console.log("foo");
}
defineExpose({
  foo
});

父组件内调用：

// 调用子组件方法
childRef.value.foo(); // foo

这样就可以调用到子组件的方法了。

查看childRef.value，也可以看到其中公开的foo方法：

如果有帮助你解决问题，请帮忙点个赞，谢谢。

完整参考代码：

父组件：

<template>
    <ChildVue ref="childRef" />
</template>

<script setup lang="ts">
import { ref } from '@vue/reactivity';
import { onMounted } from '@vue/runtime-core';
import ChildVue from './Child.vue';

const childRef = ref();
console.log(childRef.value); // undefined

onMounted(() => {
    console.log(childRef.value); // Proxy {…}
    // 调用子组件方法
    childRef.value.foo(); // foo
});
</script>

<style>
</style>

子组件：

<template>child demo</template>

<script setup lang="ts">
const foo = () => {
  console.log("foo");
}
defineExpose({
  foo
});
</script>

<style>
</style>

参考文档

vue2访问子组件实例或子元素：https://cn.vuejs.org/v2/guide/components-edge-cases.html#%E8%AE%BF%E9%97%AE%E5%AD%90%E7%BB%84%E4%BB%B6%E5%AE%9E%E4%BE%8B%E6%88%96%E5%AD%90%E5%85%83%E7%B4%A0
vue3 expose：https://v3.cn.vuejs.org/api/options-data.html#expose
vue3 defineexpose：https://v3.cn.vuejs.org/api/sfc-script-setup.html#defineexpose