# Vue Test Utils Documentation

Welcome to Vue Test Utils, the official testing utility library for Vue.js!

This is the documentation for Vue Test Utils v2, which targets Vue 3.

In short:

# What is Vue Test Utils?

Vue Test Utils (VTU) is a set of utility functions aimed to simplify testing Vue.js components. It provides some methods to mount and interact with Vue components in an isolated manner.

Let's see an example:

import { mount } from '@vue/test-utils'

// The component to test
const MessageComponent = {
  template: '<p>{{ msg }}</p>',
  props: ['msg'],
}

test('displays message', () => {
  const wrapper = mount(MessageComponent, {
    props: {
      msg: 'Hello world'
    }
  })

  // Assert the rendered text of the component
  expect(wrapper.text()).toContain('Hello world')
})

# What Next?

To see Vue Test Utils in action, [take the Crash Course]./a-crash-course/), where we build a simple Todo app using a test-first approach.

Docs are split into two main sections:

  • Essentials, to cover common uses cases you'll face when testing Vue components.
  • Vue Test Utils in Depth, to explore other advanced features of the library.

Alternatively, you can explore the full API.