Testing user interactions in Vue

Introduction

Testing user interactions helps make sure your app works as expected when people click buttons or type in fields. It catches mistakes early so users have a smooth experience.

You want to check if clicking a button changes the page content correctly.

You need to verify that typing in a form input updates the data shown.

You want to confirm that toggling a checkbox shows or hides some text.

You want to make sure a dropdown menu opens when clicked.

You want to test that submitting a form triggers the right action.

Syntax

Vue

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

test('description', async () => {
  const wrapper = mount(Component)
  await wrapper.find('selector').trigger('event')
  expect(wrapper.text()).toContain('expected text')
})

Use mount to load the component for testing.

Use trigger to simulate user events like clicks or typing.

Examples

Simulates clicking a button and checks if the text changes to 'Clicked!'.

Vue

await wrapper.find('button').trigger('click')
expect(wrapper.text()).toContain('Clicked!')

Simulates typing 'Hello' into an input field and checks the input's value.

Vue

await wrapper.find('input').setValue('Hello')
expect(wrapper.find('input').element.value).toBe('Hello')

Simulates checking a checkbox and verifies the text updates accordingly.

Vue

await wrapper.find('input[type=checkbox]').setChecked(true)
expect(wrapper.text()).toContain('Checked!')

Sample Program

This test loads the ButtonClick component, checks that the message is not visible initially, then simulates a button click and confirms the message appears.

Vue

/* ButtonClick.vue */
<template>
  <button @click="clicked = true">Click me</button>
  <p v-if="clicked">Button was clicked!</p>
</template>

<script setup>
import { ref } from 'vue'
const clicked = ref(false)
</script>

/* ButtonClick.test.js */
import { mount } from '@vue/test-utils'
import ButtonClick from './ButtonClick.vue'

test('shows message after button click', async () => {
  const wrapper = mount(ButtonClick)
  expect(wrapper.text()).not.toContain('Button was clicked!')
  await wrapper.find('button').trigger('click')
  expect(wrapper.text()).toContain('Button was clicked!')
})

Important Notes

Always wait for Vue to update the DOM after events using await.

Use clear selectors like element tags or classes to find elements.

Test only one interaction per test to keep tests simple and clear.

Summary

Testing user interactions means simulating clicks, typing, and other actions.

Use Vue Test Utils mount and trigger to do this.

Check the component output to confirm it reacts correctly.

Practice

1. What is the main purpose of using trigger in Vue Test Utils when testing user interactions?

easy

A. To simulate user events like clicks or typing on components

B. To mount the component before testing

C. To check the component's initial data state

D. To import Vue components into the test file

Solution

1. Step 1: Understand the role of trigger

   The trigger method simulates user events such as clicks or keyboard input on a mounted Vue component.

2. Step 2: Differentiate from other methods

   Mounting is done by mount, checking data is done by assertions, and importing components is unrelated to trigger.

3. Final Answer:

   To simulate user events like clicks or typing on components -> Option A

4. Quick Check:

   trigger simulates events = B [OK]

Hint: Remember: trigger = simulate user event [OK]

Common Mistakes:

• Confusing trigger with mount
• Thinking trigger checks data directly
• Assuming trigger imports components

2. Which of the following is the correct syntax to simulate a click event on a button with Vue Test Utils?

easy

A. wrapper.find('button').click()

B. wrapper.find('button').trigger('click')

C. wrapper.click('button')

D. wrapper.trigger('click')

Solution

1. Step 1: Identify the correct method to find and trigger

   First, find the button element using find('button'), then call trigger('click') on it.

2. Step 2: Check each option

   wrapper.find('button').click() uses click() which is not a Vue Test Utils method. wrapper.trigger('click') calls trigger on wrapper, not on the button. wrapper.click('button') uses a non-existent click method.

3. Final Answer:

   wrapper.find('button').trigger('click') -> Option B

4. Quick Check:

   Find element then trigger event = D [OK]

Hint: Find element first, then trigger event [OK]

Common Mistakes:

• Calling trigger on wrapper instead of element
• Using .click() instead of .trigger('click')
• Wrong method order or syntax

3. Given this Vue component test snippet:

const wrapper = mount({
  template: `Clicked {{ count }} times`,
  data() { return { count: 0 } }
})
await wrapper.find('button').trigger('click')
await wrapper.find('button').trigger('click')
console.log(wrapper.text())

What will be logged to the console?

medium

A. Clicked 0 times

B. Clicked 1 times

C. Clicked NaN times

D. Clicked 2 times

Solution

1. Step 1: Understand the component's data and event

   The button shows the count and increments it by 1 on each click.

2. Step 2: Count the number of clicks triggered

   Two clicks are triggered, so count increases from 0 to 2.

3. Final Answer:

   Clicked 2 times -> Option D

4. Quick Check:

   2 clicks increment count to 2 = C [OK]

Hint: Each trigger('click') adds 1 to count [OK]

Common Mistakes:

• Assuming count does not update
• Confusing async behavior
• Ignoring the number of triggers

4. In this test code:

const wrapper = mount({
  template: ``,
  data() { return { value: '' } },
  methods: {
    updateValue(event) { this.value = event.target.value }
  }
})
await wrapper.find('input').trigger('input', { target: { value: 'hello' } })
console.log(wrapper.vm.value)

What is the output and why?

medium

A. hello

B. empty string

C. undefined

D. Error: event object missing

Solution

1. Step 1: Understand how trigger passes event data

   The trigger method emits the event using the second argument as properties of the synthetic event object, so event.target.value is set to 'hello'.

2. Step 2: Check why value is updated

   The updateValue method reads event.target.value ('hello') and sets this.value = 'hello'.

3. Final Answer:

   hello -> Option A

4. Quick Check:

   trigger('input', {target:{value:'hello'}}) updates handler = B [OK]

Hint: trigger('input', {target:{value:'x'}}) feeds to @input handler [OK]

Common Mistakes:

• Triggering 'input' without payload
• Confusing with v-model inputs (use setValue)
• Confusing input event with change event

5. You want to test a Vue component with a text input that updates a message on typing. Which approach correctly simulates typing 'Vue' and verifies the message updates?

template: `
{{ message }}
`,
data() { return { text: '', message: '' } },
watch: { text(newVal) { this.message = `Typed: ${newVal}` } }

Which test code is correct?

hard

A. wrapper.find('input').element.value = 'Vue'
await wrapper.find('input').trigger('change')
expect(wrapper.text()).toContain('Typed: Vue')

B. await wrapper.find('input').trigger('input')
expect(wrapper.text()).toContain('Typed: Vue')

C. await wrapper.find('input').setValue('Vue')
expect(wrapper.text()).toContain('Typed: Vue')

D. wrapper.find('input').setAttribute('value', 'Vue')
await wrapper.find('input').trigger('input')
expect(wrapper.text()).toContain('Typed: Vue')

Solution

1. Step 1: Understand how to simulate typing in Vue Test Utils

   The setValue method sets the input value and triggers the input event properly, updating v-model and watchers.

2. Step 2: Evaluate each option's correctness

   A uses setValue correctly. B: await wrapper.find('input').trigger('input') expect(wrapper.text()).toContain('Typed: Vue') triggers input without event data so v-model unchanged. C manually sets value but triggers 'change' not updating v-model. D uses invalid setAttribute.

3. Final Answer:

   await wrapper.find('input').setValue('Vue') expect(wrapper.text()).toContain('Typed: Vue') -> Option C

4. Quick Check:

   Use setValue to simulate typing = A [OK]

Hint: Use setValue() to simulate typing and update v-model [OK]

Common Mistakes:

• Using trigger('input') without setValue()
• Manually changing element.value without events
• Using non-existent methods like setAttribute