defineExpose 是 Vue 3 中的一个宏函数,用于在组合式 API 中明确地暴露组件的属性或方法,以便父组件能够访问它们。这个宏函数的使用主要是在 <script setup> 中,允许开发者更清晰地管理组件的接口。下面是详细的介绍和使用示例:

基本概念

在 Vue 3 中,父组件可以通过 ref 引用子组件实例,从而访问子组件的属性或方法。然而,在组合式 API 中,如果需要将某些方法或属性暴露给父组件,需要使用 defineExpose

使用场景

  • 当你希望父组件调用子组件的方法。
  • 当你希望父组件访问子组件的数据或属性。

使用方法

通过上述示例和解释,可以清楚地看到 defineExpose 是如何用于暴露子组件的方法和属性给父组件使用的。这种方式提高了组件之间接口的明确性和可维护性。

  1. 定义子组件并暴露方法或属性

    在子组件中使用 <script setup> 并通过 defineExpose 明确暴露需要的内容。

    <!-- ChildComponent.vue -->
    <template>
      <div>
        子组件内容
      </div>
    </template>
    
    <script setup>
    import { ref } from 'vue';
    
    const count = ref(0);
    
    function increment() {
      count.value++;
    }
    
    // 使用 defineExpose 暴露方法和属性
    defineExpose({
      count,
      increment
    });
    </script>
    

    在父组件中使用子组件

    父组件通过 ref 引用子组件,并可以调用子组件暴露的方法或访问暴露的属性。

    <!-- ParentComponent.vue -->
    <template>
      <div>
        <ChildComponent ref="childRef"/>
        <button @click="incrementCount">Increment Count in Child</button>
      </div>
    </template>
    
    <script setup>
    import { ref } from 'vue';
    import ChildComponent from './ChildComponent.vue';
    
    const childRef = ref(null);
    
    function incrementCount() {
      if (childRef.value) {
        childRef.value.increment();
        console.log(childRef.value.count);  // 输出子组件中的 count
      }
    }
    </script>
    

    注意事项

  2. defineExpose 只能在 <script setup> 中使用。
  3. 只有通过 defineExpose 暴露的方法和属性才能被父组件访问。
  4. 如果未使用 defineExpose 明确暴露,父组件将无法访问子组件的属性和方法。
GitHub 加速计划 / vu / vue
207.55 K
33.66 K
下载
vuejs/vue: 是一个用于构建用户界面的 JavaScript 框架,具有简洁的语法和丰富的组件库,可以用于开发单页面应用程序和多页面应用程序。
最近提交(Master分支:3 个月前 )
73486cb5 * chore: fix link broken Signed-off-by: snoppy <michaleli@foxmail.com> * Update packages/template-compiler/README.md [skip ci] --------- Signed-off-by: snoppy <michaleli@foxmail.com> Co-authored-by: Eduardo San Martin Morote <posva@users.noreply.github.com> 5 个月前
e428d891 Updated Browser Compatibility reference. The previous currently returns HTTP 404. 5 个月前
Logo

旨在为数千万中国开发者提供一个无缝且高效的云端环境,以支持学习、使用和贡献开源项目。

更多推荐