Vue Testing Library

Simple and complete Vue.js testing utilities that encourage good testing practices.

Vue Testing Library is a lightweight adapter built on top of DOM Testing Library and @vue/test-utils.

Read the docs | Edit the docs

Table of Contents

• Installation
• A basic example
  • More examples
• Guiding Principles
• Docs
• Typings
• ESLint support
• Issues
  • 🐛 Bugs
  • 💡 Feature Requests
  • ❓ Questions
• License
• Contributors

Installation

This module is distributed via npm and should be installed as one of your project's devDependencies:

npm install --save-dev @testing-library/vue

This library has peerDependencies listings for Vue 3 and vue-template-compiler.

You may also be interested in installing jest-dom so you can use the custom Jest matchers.

If you're using Vue 2, please install version 5 of the library:

npm install --save-dev @testing-library/vue@^5

A basic example

<template>
  <p>Times clicked: {{ count }}</p>
  <button @click="increment">increment</button>
</template>

<script>
  export default {
    name: 'Button',
    data: () => ({
      count: 0,
    }),
    methods: {
      increment() {
        this.count++
      },
    },
  }
</script>

import {render, screen, fireEvent} from '@testing-library/vue'
import Button from './Button'

test('increments value on click', async () => {
  // The `render` method renders the component into the document.
  // It also binds to `screen` all the available queries to interact with
  // the component.
  render(Button)

  // queryByText returns the first matching node for the provided text
  // or returns null.
  expect(screen.queryByText('Times clicked: 0')).toBeTruthy()

  // getByText returns the first matching node for the provided text
  // or throws an error.
  const button = screen.getByText('increment')

  // Click a couple of times.
  await fireEvent.click(button)
  await fireEvent.click(button)

  expect(screen.queryByText('Times clicked: 2')).toBeTruthy()
})

You might want to install jest-dom to add handy assertions such as .toBeInTheDocument(). In the example above, you could write expect(screen.queryByText('Times clicked: 0')).toBeInTheDocument().

Using byText queries it's not the only nor the best way to query for elements. Read Which query should I use? to discover alternatives. In the example above, getByRole('button', {name: 'increment'}) is possibly the best option to get the button element.

More examples

You'll find examples of testing with different situations and popular libraries in the test directory.

Some included are:

• vuex
• vue-router
• vee-validate
• vue-i18n
• vuetify

Feel free to contribute with more examples!

Guiding Principles

The more your tests resemble the way your software is used, the more confidence they can give you.

We try to only expose methods and utilities that encourage you to write tests that closely resemble how your Vue components are used.

Utilities are included in this project based on the following guiding principles:

1. If it relates to rendering components, it deals with DOM nodes rather than component instances, nor should it encourage dealing with component instances.
2. It should be generally useful for testing individual Vue components or full Vue applications.
3. Utility implementations and APIs should be simple and flexible.

At the end of the day, what we want is for this library to be pretty light-weight, simple, and understandable.

Docs

Read the docs | Edit the docs

Typings

Please note that TypeScript 4.X is required.

The TypeScript type definitions are in the types directory.

ESLint support

If you want to lint test files that use Vue Testing Library, you can use the official plugin: eslint-plugin-testing-library.

Issues

Looking to contribute? Look for the Good First Issue label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

❓ Questions

For questions related to using the library, please visit a support community instead of filing an issue on GitHub.

• Discord

License

MIT

Contributors