Call a Vue.js component method from outside the component

Question

Let's say I have a main Vue instance that has child components. Is there a way of calling a method belonging to one of these components from outside the Vue instance entirely?

Here is an example:

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>

So when I click the internal button, the increaseCount() method is bound to its click event so it gets called. There is no way to bind the event to the external button, whose click event I am listening for with jQuery, so I'll need some other way to call increaseCount.

EDIT

It seems this works:

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

However, this is not a good solution because I am referencing the component by its index in the children array, and with many components this is unlikely to stay constant and the code is less readable.

I added an answer using mxins if you want to give it a try. In my opinion I prefer to setup the app this way. — Omar Tanti
– Omar Tanti, Commented Mar 28, 2018 at 1:31
Why do you need to do that? I mean why do you need to call that method? Maybe better to use something like v-model? — Igor Popov
– Igor Popov, Commented Feb 19, 2022 at 1:48
In my case it would be something like this: I build some vue app that I include in some existing static hugo webpage. The vue app can be seen as some plugin/addon and is otherwise completely separate. But I would like to connect the existing search button and language switcher to the vue app that also supports this. — E. Körner
– E. Körner, Commented May 22, 2023 at 7:14

Samuel RIGAUD · Accepted Answer · 2024-01-29 21:35:12Z

359

In the end I opted for using Vue's ref directive. This allows a component to be referenced from the parent for direct access.

E.g.

Have a component registered on my parent instance:

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

Render the component in template/html with a reference:

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

Now, elsewhere I can access the component externally

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

See this fiddle for an example: https://jsfiddle.net/0zefx8o6/

(old example using Vue 1: https://jsfiddle.net/6v7y6msr/)

Edit for Vue3 - Composition API

The child-component has to return the function in setup you want to use in the parent-component otherwise the function is not available to the parent.

Note: <script setup> doc is not affacted, because it provides all the functions and variables to the template by default.

edited Jan 29, 2024 at 21:35

Samuel RIGAUD

1,6981 gold badge19 silver badges28 bronze badges

answered May 30, 2016 at 9:04

harryg

24.2k47 gold badges135 silver badges208 bronze badges

Sign up to request clarification or add additional context in comments.

12 Comments

harryg Over a year ago

That's because you probably haven't defined it. Look at the linked fiddle.

tw airball Over a year ago

If you are using webpack then you won't be able to access vm due to the way it scopes modules. You can do something like window.app = vm in your main.js. Source: forum.vuejs.org/t/how-to-access-vue-from-chrome-console/3606

harryg Over a year ago

There's so official definition of what's a hack vs what's "normal" coding, but rather than call this approach a hack (or look for a "less-hacky" way of achieving the same thing) it's probably better to question why you need to do this. In many cases it might be more elegant to use Vue's event system to trigger external component behaviour, or even ask why you're triggering components externally at all.

Allen Wang Over a year ago

This can come up if you are trying to integrate a view component into an already existing page. Rather than redesigning the page entirely, it is nice sometimes to incrementally add additional functionality.

Eyal Over a year ago

I had to use this. : this.$refs.foo.doSomething();

|

Samuel RIGAUD · Accepted Answer · 2024-01-29 21:36:48Z

55

You can set ref for child components then in parent can call via $refs:

Add ref to child component:

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

Add click event to parent:

<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>

edited Jan 29, 2024 at 21:36

Samuel RIGAUD

1,6981 gold badge19 silver badges28 bronze badges

answered Dec 28, 2018 at 4:26

Cong Nguyen

3,4551 gold badge25 silver badges22 bronze badges

2 Comments

Jesse Reza Khorasanee Over a year ago

Great answer. I'm just going to edit the html to be a bit smaller vertically. Currently I can only see 'Internal Button' when I run it which was can be confusing.

Kwaadpepper Over a year ago

You can access from the parent component a ref using this : this.$refs.childref, used this to make a generic alert component for example

tony19 · Accepted Answer · 2022-07-15 19:45:09Z

51

For Vue2 this applies:

var bus = new Vue()

// in component A's method

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

// in component B's created hook

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

  // ...
})

See here for the Vue docs. And here is more detail on how to set up this event bus exactly.

If you'd like more info on when to use properties, events and/ or centralized state management see this article.

See below comment of Thomas regarding Vue 3.

edited Jul 15, 2022 at 19:45

tony19

140k23 gold badges281 silver badges354 bronze badges

answered Sep 10, 2017 at 20:26

musicformellons

13.6k5 gold badges58 silver badges95 bronze badges

3 Comments

byxor Over a year ago

Short and sweet! If you dislike the global bus variable, you can go a step further and inject the bus into your component using props. I'm relatively new to vue so I can't assure you that this is idiomatic.

Thomas Over a year ago

new Vue() is deprecated in vue 3 for alternative follow this question

Utmost Creator Over a year ago

Event bus is not recommended patter (at least in vue 2/3), that is why it has been removed from docs. for more information you can read this or the same on from image here - the answer was provided by skirtle (moderator, MVP on Vue's the discord chennel). "References to event buses were removed from the Vue 2 docs a long time ago and we recently added something to the Vue 3 docs to actively discourage it"

Helder Lucas · Accepted Answer · 2017-01-08 18:58:35Z

34

You can use Vue event system

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

and

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

Here is the fiddle: http://jsfiddle.net/hfalucas/wc1gg5v4/59/

edited Jan 8, 2017 at 18:58

answered Nov 12, 2015 at 23:44

Helder Lucas

3,3532 gold badges24 silver badges28 bronze badges

2 Comments

Helder Lucas Over a year ago

@GusDeCooL the example has been edited. Not that after Vuejs 2.0 some methods used there have been deprecated

Koronos Over a year ago

Works well if there is only 1 instance of component, but if there are many instances, works better use $refs.component.method()

urig · Accepted Answer · 2019-05-26 10:53:54Z

32

A slightly different (simpler) version of the accepted answer:

Have a component registered on the parent instance:

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

Render the component in template/html with a reference:

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

Access the component method:

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

edited May 26, 2019 at 10:53

urig

16.9k33 gold badges120 silver badges210 bronze badges

answered Mar 1, 2019 at 7:46

Victor

1,0231 gold badge12 silver badges25 bronze badges

Comments

Roland · Accepted Answer · 2018-10-29 11:26:01Z

12

Say you have a child_method() in the child component:

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

Now you want to execute the child_method from parent component:

<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
        }
    }
}

If you want to execute a parent component method from child component:

this.$parent.name_of_method()

NOTE: It is not recommended to access the child and parent component like this.

Instead as best practice use Props & Events for parent-child communication.

If you want communication between components surely use vuex or event bus

Please read this very helpful article

edited Oct 29, 2018 at 11:26

answered Jun 24, 2018 at 5:33

Roland

28.1k9 gold badges108 silver badges103 bronze badges

2 Comments

musicformellons Over a year ago

Yes, you can, but not considered 'best practice': downward to Child use properties, upward to Parent use events. To also cover 'sidewards', use custom events, or e.g. vuex. See this nice article for more info.

Roland Over a year ago

Yes it is not recommended to do so.

dotNET · Accepted Answer · 2024-02-29 14:23:38Z

11

If you're using Vue 3 with <script setup> sugar, note that internal bindings of a component are closed (not visible from outside the component) and you must use defineExpose(see docs) to make them visible from outside. Something like this:

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

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

Since

Components using <script setup> are closed by default

edited Feb 29, 2024 at 14:23

answered May 23, 2022 at 12:50

dotNET

35.7k29 gold badges176 silver badges276 bronze badges

Comments

Dotnetgang · Accepted Answer · 2018-06-28 17:31:18Z

7

This is a simple way to access a component's methods from other component

// 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');
   }
}

answered Jun 28, 2018 at 17:31

Dotnetgang

811 silver badge1 bronze badge

Comments

Sarvar Nishonboyev · Accepted Answer · 2020-10-21 09:57:17Z

4

Using 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

answered Oct 21, 2020 at 9:57

Sarvar Nishonboyev

13.2k11 gold badges80 silver badges78 bronze badges

Comments

Nick Web · Accepted Answer · 2018-05-07 11:02:39Z

3

Here is a simple one

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

edited May 7, 2018 at 11:02

Nick Web

31 bronze badge

answered Mar 6, 2018 at 4:20

Pratik Khadtale

3055 silver badges11 bronze badges

Comments

Jonathan Arias · Accepted Answer · 2023-04-03 04:14:53Z

3

To access the data of a child component in Vue 3 or execute (call) a method, using <script setup> syntax, as mentioned above, it is necessary to use the defineExpose(see docs) method to make variables or methods visible from outside. Look at the following code.

Child component:

<script setup>
impor { ref } from "vue";

const varA = ref("Hola");
const myMethod = () => { ... };


defineExpose({
  varA,
  myMethod,
});
</script>

Parent component:

<child-component ref="myChildComponent" />

<script setup>
import { ref } from "vue";
const myChildComponent = ref(null)

const changeData = () => {
   myChildComponent.value.myMethod();

   // or
   
   myChildComponent.value.varA = "Hi";
}
</script>

As mentioned above:

Components using script setup are closed by default

answered Apr 3, 2023 at 4:14

Jonathan Arias

6109 silver badges20 bronze badges

1 Comment

Canelo Digital Feb 8 at 14:11

This is the Vue3 way... and it makes sense, more object oriented/encapsuled approach. All functions are normally set to private except those which are defineExposed, then they're public. (at least something similar to that concept)

greybeard · Accepted Answer · 2020-03-20 12:50:36Z

2

I am not sure is it the right way but this one works for me.
First import the component which contains the method you want to call in your component

import myComponent from './MyComponent'

and then call any method of MyCompenent

myComponent.methods.doSomething()

edited Mar 20, 2020 at 12:50

greybeard

2,6779 gold badges40 silver badges71 bronze badges

answered Mar 20, 2020 at 11:31

Rohit Kumar

684 bronze badges

2 Comments

cyboashu Over a year ago

this doesn't give you access to any data in your component. if your doSomething is using any thing from data, this method is useless.

Bogdan M. Over a year ago

@cyboashu you are right but it is a perfect idea for me since I wanted to use generic methods from a mixin.

Pezhvak · Accepted Answer · 2023-11-03 08:22:10Z

2

If you're searching for vue 3 solution with setup functions, here it is:

Component:

<template>
  template...
</template>
<script setup>
import { defineExpose } from "vue";

function do_something(){
  alert('called!');
}

// here is the trick
defineExpose({do_something});
</script>

Parent:

<template>
  <my-component ref="myComponent" />
</template>
<script setup>
import {ref} from "vue";
const myComponent = ref(null);

// calling method on child component
myComponent.value.do_something();
</script>

In vue 3 composition api you should expose the method you want to access from outside by using defineExpose.

answered Nov 3, 2023 at 8:22

Pezhvak

11.1k7 gold badges32 silver badges44 bronze badges

Comments

ODaniel · Accepted Answer · 2020-09-21 17:21:56Z

1

Sometimes you want to keep these things contained within your component. Depending on DOM state (the elements you're listening on must exist in DOM when your Vue component is instantiated), you can listen to events on elements outside of your component from within your Vue component. Let's say there is an element outside of your component, and when the user clicks it, you want your component to respond.

In html you have:

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

In your Vue component:

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

answered Sep 21, 2020 at 17:21

ODaniel

5955 silver badges13 bronze badges

1 Comment

Sebi2020 Over a year ago

This isn't a VueJS style solution. It bypasses the VueJS component system.

norbekoff · Accepted Answer · 2021-12-06 10:02:17Z

0

Declare your function in a component like this:

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

and call it from any page like this:

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

answered Dec 6, 2021 at 10:02

norbekoff

1,9141 gold badge13 silver badges25 bronze badges

Comments

Maxim Rysevets · Accepted Answer · 2024-02-05 14:14:30Z

Example of Message component.

100% work on Vue3.

No hacks! Clean console!

It is almost impossible to find a ready-made working solution but here it is.

Official documentation: https://v3.ru.vuejs.org/api/sfc-script-setup.html https://v3.ru.vuejs.org/api/sfc-script-setup.html

File `src/views/FormN.vue`

<script setup>
    import Messages from '../components/Messages.vue';
</script>

<template>
    <Messages ref="messagesRef" />
    <form>
        <button v-on:click="submitForm" type="button">Send</button>
    </form>
</template>

<script>
    export default {
        methods: {
            submitForm() {
                this.$refs.messagesRef.addMessage('New item was added.');
             // this.$refs.messagesRef.addMessage('New item was not added!', 'warning');
             // this.$refs.messagesRef.addMessage('New item was not added!!!', 'error');
             // this.$refs.messagesRef.deleteMessagesByType('ok');
             // this.$refs.messagesRef.deleteMessagesByType('warning');
             // this.$refs.messagesRef.deleteMessagesByType('error');
             // this.$refs.messagesRef.deleteMessagesAll();
            }
        }
    }
</script>

File `src/components/Messages.vue`

<script setup>
    import { ref } from 'vue';

    const messages = ref({
        'ok'     : [],
        'warning': [],
        'error'  : []
    });

    const addMessage = (message, type = 'ok') => {
        messages.value[type].push(message);
    };

    const deleteMessage = (num, type = 'ok') => {
        messages.value[type] = messages.value[type].filter((value, i) => i !== num);
    };

    const deleteMessagesByType = (type = 'ok') => {
        messages.value[type] = [];
    };

    const deleteMessagesAll = () => {
        deleteMessagesByType('ok');
        deleteMessagesByType('warning');
        deleteMessagesByType('error');
    };

    defineExpose({
        addMessage          : addMessage,
        deleteMessage       : deleteMessage,
        deleteMessagesByType: deleteMessagesByType,
        deleteMessagesAll   : deleteMessagesAll
    })
</script>

<template>
    <x-messages data-type="ok" v-if="messages.ok.length !== 0">
        <ul>
            <li v-for="(message, num) in messages.ok" :key="num">
                {{ message }} [<a href="#" data-type="delete" v-on:click="deleteMessage(num, 'ok')">x</a>]
            </li>
        </ul>
    </x-messages>
    <x-messages data-type="warning" v-if="messages.warning.length !== 0">
        <ul>
            <li v-for="(message, num) in messages.warning" :key="num">
                {{ message }} [<a href="#" data-type="delete" v-on:click="deleteMessage(num, 'warning')">x</a>]
            </li>
        </ul>
    </x-messages>
    <x-messages data-type="error" v-if="messages.error.length !== 0">
        <ul>
            <li v-for="(message, num) in messages.error" :key="num">
                {{ message }} [<a href="#" data-type="delete" v-on:click="deleteMessage(num, 'error')">x</a>]
            </li>
        </ul>
    </x-messages>
</template>

Bonus: custom tags.

File `vite.config.js`

export default defineConfig({
    plugins: [
        vue({
            template: {
                compilerOptions: {
                    isCustomElement: (tag) => [
                        'x-field',
                        'x-other-custom-tag'
                    ].includes(tag),
                }
            }
        })
    ],
    resolve: {
        alias: {
            '@': fileURLToPath(new URL('./src', import.meta.url))
        }
    }
})

p.s. This contribution was made by the author and developer of CMS Effcore.

Gorbas · Accepted Answer · 2018-12-14 13:55:50Z

-9

I have used a very simple solution. I have included a HTML element, that calls the method, in my Vue Component that I select, using Vanilla JS, and I trigger click!

In the Vue Component, I have included something like the following:

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

That I use using Vanilla JS:

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

answered Dec 14, 2018 at 13:55

Gorbas

821 silver badge3 bronze badges

1 Comment

Hybrid web dev Over a year ago

This is not considered good practice at all within vue, especially in the context of OP's question.

Collectives™ on Stack Overflow

Call a Vue.js component method from outside the component

17 Answers 17

12 Comments

2 Comments

3 Comments

2 Comments

Comments

2 Comments

Comments

Comments

Comments

Comments

1 Comment

2 Comments

Comments

1 Comment

Comments

File `src/views/FormN.vue`

File `src/components/Messages.vue`

File `vite.config.js`

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

17 Answers 17

12 Comments

2 Comments

3 Comments

2 Comments

Comments

2 Comments

Comments

Comments

Comments

Comments

1 Comment

2 Comments

Comments

1 Comment

Comments

File src/views/FormN.vue

File src/components/Messages.vue

File vite.config.js

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related

File `src/views/FormN.vue`

File `src/components/Messages.vue`

File `vite.config.js`