从组件外部调用 Vue.js 组件方法

Question

假设我有一个包含子组件的主 Vue 实例。 有没有办法完全从 Vue 实例外部调用属于这些组件之一的方法？

这是一个例子：

 var vm = new Vue({ el: '#app', components: { 'my-component': { template: '#my-template', data: function() { return { count: 1, }; }, methods: { increaseCount: function() { this.count++; } } }, } }); $('#external-button').click(function() { vm['my-component'].increaseCount(); // This doesn't work });

 <script src="http://vuejs.org/js/vue.js"></script> <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script> <div id="app"> <my-component></my-component> <br> <button id="external-button">External Button</button> </div> <template id="my-template"> <div style="border: 1px solid; padding: 5px;"> <p>A counter: {{ count }}</p> <button @click="increaseCount">Internal Button</button> </div> </template>

所以当我点击内部按钮时， increaseCount()方法被绑定到它的点击事件，所以它被调用。 无法将事件绑定到外部按钮，我正在使用 jQuery 监听其单击事件，因此我需要一些其他方法来调用increaseCount 。

编辑

似乎这有效：

vm.$children[0].increaseCount();

但是，这不是一个好的解决方案，因为我通过子数组中的索引引用组件，并且对于许多组件，这不太可能保持不变并且代码的可读性较差。

Answer 1

最后我选择了使用Vue 的ref指令。 这允许从父级引用组件以进行直接访问。

例如

在我的父实例上注册了一个组件：

var vm = new Vue({
    el: '#app',
    components: { 'my-component': myComponent }
});

使用引用在 template/html 中渲染组件：

<my-component ref="foo"></my-component>

现在，我可以在其他地方从外部访问组件

<script>
vm.$refs.foo.doSomething(); //assuming my component has a doSomething() method
</script>

看这个小提琴的例子： https ://jsfiddle.net/xmqgnbu3/1/

（使用 Vue 1 的旧示例： https ://jsfiddle.net/6v7y6msr/）

为 Vue3 编辑 - 组合 API

子组件必须在setup中return要在父组件中使用的函数，否则该函数对父组件不可用。

注意： <sript setup> doc不受影响，因为它默认为模板提供了所有的函数和变量。

Answer 2

您可以为子组件设置 ref，然后在父组件中可以通过 $refs 调用：

将 ref 添加到子组件：

<my-component ref="childref"></my-component>

向父级添加点击事件：

<button id="external-button" @click="$refs.childref.increaseCount()">External Button</button>

 var vm = new Vue({ el: '#app', components: { 'my-component': { template: '#my-template', data: function() { return { count: 1, }; }, methods: { increaseCount: function() { this.count++; } } }, } });

 <script src="https://cdnjs.cloudflare.com/ajax/libs/vue/2.5.17/vue.js"></script> <div id="app"> <my-component ref="childref"></my-component> <button id="external-button" @click="$refs.childref.increaseCount()">External Button</button> </div> <template id="my-template"> <div style="border: 1px solid; padding: 2px;" ref="childref"> <p>A counter: {{ count }}</p> <button @click="increaseCount">Internal Button</button> </div> </template>

Answer 3

对于 Vue2 这适用：

var bus = new Vue()

// 在组件 A 的方法中

bus.$emit('id-selected', 1)

// 在组件 B 的 created 钩子中

bus.$on('id-selected', function (id) {

  // ...
})

有关 Vue 文档，请参见此处。 这里有更多关于如何准确设置这个事件总线的细节。

如果您想了解有关何时使用属性、事件和/或集中状态管理的更多信息，请参阅这篇文章。

请参阅以下 Thomas 关于 Vue 3 的评论。

Answer 4

可以使用 Vue 事件系统

vm.$broadcast('event-name', args)

和

 vm.$on('event-name', function())

这是小提琴：http: //jsfiddle.net/hfalucas/wc1gg5v4/59/

Answer 5

接受答案的稍微不同（更简单）的版本：

在父实例上注册一个组件：

export default {
    components: { 'my-component': myComponent }
}

使用引用在 template/html 中渲染组件：

<my-component ref="foo"></my-component>

访问组件方法：

<script>
    this.$refs.foo.doSomething();
</script>

Answer 6

假设您在子组件中有一个child_method() ：

export default {
    methods: {
        child_method () {
            console.log('I got clicked')
        }
    }
}

现在你想从父组件执行child_method ：

<template>
    <div>
        <button @click="exec">Execute child component</button>
        <child-cmp ref="child"></child_cmp> <!-- note the ref="child" here -->
    </div>
</template>

export default {
    methods: {
        exec () { //accessing the child component instance through $refs
            this.$refs.child.child_method() //execute the method belongs to the child component
        }
    }
}

如果要从子组件执行父组件方法：

this.$parent.name_of_method()

注意：不建议像这样访问子组件和父组件。

相反，作为最佳实践，使用 Props & Events 进行父子通信。

如果你想在组件之间进行通信，一定要使用vuex或事件总线

请阅读这篇非常有用的文章

---

Answer 7

这是从其他组件访问组件方法的简单方法

// This is external shared (reusable) component, so you can call its methods from other components

export default {
   name: 'SharedBase',
   methods: {
      fetchLocalData: function(module, page){
          // .....fetches some data
          return { jsonData }
      }
   }
}

// This is your component where you can call SharedBased component's method(s)
import SharedBase from '[your path to component]';
var sections = [];

export default {
   name: 'History',
   created: function(){
       this.sections = SharedBase.methods['fetchLocalData']('intro', 'history');
   }
}

Answer 8

这是一个简单的

this.$children[indexOfComponent].childsMethodName();

Answer 9

使用 Vue 3：

const app = createApp({})

// register an options object
app.component('my-component', {
  /* ... */
})

....

// retrieve a registered component
const MyComponent = app.component('my-component')

MyComponent.methods.greet();

https://v3.vuejs.org/api/application-api.html#component

Answer 10

我不确定它是否正确，但这个方法对我有用。
首先导入包含您要在组件中调用的方法的组件

import myComponent from './MyComponent'

然后调用 MyCompenent 的任何方法

myComponent.methods.doSomething()

Answer 11

在这样的组件中声明您的函数：

export default {
  mounted () {
    this.$root.$on('component1', () => {
      // do your logic here :D
    });
  }
};

并从这样的任何页面调用它：

this.$root.$emit("component1");

Answer 12

有时您希望将这些内容包含在您的组件中。 根据 DOM 状态（当您的 Vue 组件被实例化时，您正在侦听的元素必须存在于 DOM 中），您可以在 Vue 组件内侦听组件外部元素上的事件。 假设您的组件外部有一个元素，当用户单击它时，您希望您的组件做出响应。

在 html 中，您有：

<a href="#" id="outsideLink">Launch the component</a>
...
<my-component></my-component>

在您的 Vue 组件中：

    methods() {
      doSomething() {
        // do something
      }
    },
    created() {
       document.getElementById('outsideLink').addEventListener('click', evt => 
       {
          this.doSomething();
       });
    }
    

Answer 13

如果您将 Vue 3 与<script setup>糖一起使用，请注意组件的内部绑定是关闭的（从组件外部不可见），您必须使用defineExpose （请参阅docs ）使它们从外部可见。 像这样的东西：

<script setup lang="ts">
const method1 = () => { ... };
const method2 = () => { ... };

defineExpose({
  method1,
  method2,
});
</script>

Answer 14

我使用了一个非常简单的解决方案。 我使用 Vanilla JS 在我选择的 Vue 组件中包含了一个调用该方法的 HTML 元素，然后触发点击！

在 Vue 组件中，我包含了如下内容：

<span data-id="btnReload" @click="fetchTaskList()"><i class="fa fa-refresh"></i></span>

我使用Vanilla JS：

const btnReload = document.querySelector('[data-id="btnReload"]');
btnReload.click();