Vue $nextTick() Method
Example
Using the $nextTick() method to wait for the DOM to update before we get the message inside the <p> tag.
methods: {
updateMsg() {
this.message = '"Hello! This is a new message."';
this.results.push(this.$refs.pEl.textContent);
this.$nextTick(() => {
this.results.push(this.$refs.pEl.textContent + ' (using $nextTick())');
});
}
}
See more examples below.
Definition and Usage
The $nextTick() method waits for the DOM to update before executing.
We use this.$nextTick() to wait for the DOM update cycle of the current Vue component to finish.
| Argument | Description |
|---|---|
| callback function | Optional. The callback function provided will run after the DOM is updated (see the example above). The $nextTick() method can also be used without an argument (see the example below). |
In addition to this.$nextTick() there is also a global nextTick() method that can be used to wait for the DOM to update even from outside the scope of a specific component.
Note: In Vue, when a reactive variable is changed, the DOM is not updated immediately. Vue saves these changes instead, and applies them when the 'next tick' happens. This is to enhance performance and ensure consistency between the Vue instance and the DOM.
More Examples
Example
The same result as in the first example can be achieved by calling the $nextTick() method with the await prefix in an asynchronous method. This causes the next lines of code to be put on hold until the 'next tick' happens.
<template>
<h2>Example $nextTick() Method</h2>
<p>Using "await $nextTick()", the next lines of code will also wait until the 'next tick' happens.
</p>
<div>
<p ref="messageEl">{{ message }}</p>
<button v-on:click.once="updateMsg">Update Message</button>
<ol>
<li v-for="x in results">{{ x }}</li>
</ol>
</div>
</template>
<script>
export default {
data() {
return {
message: "Initial Message",
results: []
};
},
methods: {
async updateMsg() {
this.message = "Hello! This message is now updated.";
this.results.push(this.$refs.messageEl.textContent);
await this.$nextTick();
this.results.push(this.$refs.messageEl.textContent + ' (after await $nextTick())');
}
}
};
</script>
<style scoped>
div {
border: solid black 1px;
padding: 10px;
}
</style>
Related Pages
JavaScript Tutorial: JavaScript Async
Vue Tutorial: Vue Methods
Vue Tutorial: Vue Template Refs
Vue Tutorial: Vue v-on
Vue Tutorial: Vue Event Modifiers
Vue Reference: Vue 'ref' Attribute
Vue Reference: Vue $refs Object