# Mounting Options

Options for mount and shallowMount .

• Mounting Options
  • context
  • data
  • slots
  • scopedSlots
  • stubs
  • mocks
  • localVue
  • attachTo
  • attachToDocument
  • attrs
  • propsData
  • listeners
  • parentComponent
  • provide
  • Other options

# context

• type: Object

Passes context to functional component. Can only be used with functional components .

Example:

import Foo from './Foo.vue'
import Bar from './Bar.vue'
const wrapper = mount(Component, {
  context: {
    props: { show: true },
    children: [Foo, Bar]
expect(wrapper.is(Component)).toBe(true)

# data

• type: Function

Passes data to a component. It will merge with the existing data function.

Example:

const Component = {
  template: `
      <span id="foo">{{ foo }}</span>
      <span id="bar">{{ bar }}</span>
  data() {
    return {
      foo: 'foo',
      bar: 'bar'
const wrapper = mount(Component, {
  data() {
    return {
      bar: 'my-override'
wrapper.find('#foo').text() // 'foo'
wrapper.find('#bar').text() // 'my-override'

# slots

• type: { [name: string]: Array<Component>|Component|string }

Provide an object of slot contents to the component. The key corresponds to the slot name. The value can be either a component, an array of components, or a template string, or text.

Example:

import Foo from './Foo.vue'
import MyComponent from './MyComponent.vue'
const bazComponent = {
  name: 'baz-component',
  template: '<p>baz</p>'
const yourComponent = {
  props: {
    foo: {
      type: String,
      required: true
  render(h) {
    return h('p', this.foo)
const wrapper = shallowMount(Component, {
  slots: {
    default: [Foo, '<my-component />', 'text'],
    fooBar: Foo, // Will match `<slot name="FooBar" />`.
    foo: '<div />',
    bar: 'bar',
    baz: bazComponent,
    qux: '<my-component />',
    quux: '<your-component foo="lorem"/><your-component :foo="yourProperty"/>'
  stubs: {
    // used to register custom components
    'my-component': MyComponent,
    'your-component': yourComponent
  mocks: {
    // used to add properties to the rendering context
    yourProperty: 'ipsum'
expect(wrapper.find('div')).toBe(true)

# scopedSlots

• type: { [name: string]: string|Function }

Provide an object of scoped slots to the component. The key corresponds to the slot name.

You can set the name of the props using the slot-scope attribute:

shallowMount(Component, {
  scopedSlots: {
    foo: '<p slot-scope="foo">{{foo.index}},{{foo.text}}</p>'

Otherwise props are available as a props object when the slot is evaluated:

shallowMount(Component, {
  scopedSlots: {
    default: '<p>{{props.index}},{{props.text}}</p>'

You can also pass a function that takes the props as an argument:

shallowMount(Component, {
  scopedSlots: {
    foo: function (props) {
      return this.$createElement('div', props.index)

Or you can use JSX. If you write JSX in a method, this.$createElement is auto-injected by babel-plugin-transform-vue-jsx:

shallowMount(Component, {
  scopedSlots: {
    foo(props) {
      return <div>{props.text}</div>

const WrapperComp = {
  template: `
  <ComponentUnderTest v-slot="props">
    <p>Using the {{props.a}}</p>
    <p>Using the {{props.a}}</p>
  </ComponentUnderTest>
  components: {
    ComponentUnderTest
const wrapper = mount(WrapperComp).findComponent(ComponentUnderTest)

# stubs

• type: { [name: string]: Component | string | boolean } | Array<string>

Stubs child components can be an Array of component names to stub, or an object. If stubs is an Array, every stub is <${component name}-stub> .

Deprecation Notice:

When stubbing components, supplying a string ( ComponentToStub: '<div class="stubbed" /> ) is no longer supported.

Example:

import Foo from './Foo.vue'
mount(Component, {
  stubs: ['registered-component']
shallowMount(Component, {
  stubs: {
    // stub with a specific implementation
    'registered-component': Foo,
    // create default stub.
    // the component name of default stub is another-component in this case.
    // the default stub is <${the component name of default stub}-stub>.
    'another-component': true

# mocks

• type: Object

Add additional properties to the instance. Useful for mocking global injections.

Example:

const $route = { path: 'http://www.example-path.com' }
const wrapper = shallowMount(Component, {
  mocks: {
    $route
expect(wrapper.vm.$route.path).toBe($route.path)

# localVue

• type: Vue

A local copy of Vue created by createLocalVue to use when mounting the component. Installing plugins on this copy of Vue prevents polluting the original Vue copy.

Example:

import { createLocalVue, mount } from '@vue/test-utils'
import VueRouter from 'vue-router'
import Foo from './Foo.vue'
const localVue = createLocalVue()
localVue.use(VueRouter)
const routes = [{ path: '/foo', component: Foo }]
const router = new VueRouter({
  routes
const wrapper = mount(Component, {
  localVue,
  router
expect(wrapper.vm.$route).toBeInstanceOf(Object)

# attachTo

• type: HTMLElement | string
• default: null

This either specifies a specific HTMLElement or CSS selector string targeting an HTMLElement, to which your component will be fully mounted in the document.

When attaching to the DOM, you should call wrapper.destroy() at the end of your test to remove the rendered elements from the document and destroy the component instance.

const div = document.createElement('div')
div.id = 'root'
document.body.appendChild(div)
const Component = {
  template: '<div>ABC</div>'
let wrapper = mount(Component, {
  attachTo: '#root'
expect(wrapper.vm.$el.parentNode).not.toBeNull()
wrapper.destroy()
wrapper = mount(Component, {
  attachTo: document.getElementById('root')
expect(wrapper.vm.$el.parentNode).not.toBeNull()
wrapper.destroy()

# attachToDocument

• type: boolean
• default: false

wrapper = mount(Component, {
  attachTo: document.body

Like attachTo , but automatically creates a new div element for you and inserts it into the body.

When attaching to the DOM, you should call wrapper.destroy() at the end of your test to remove the rendered elements from the document and destroy the component instance.

# attrs

• type: Object

Set the component instance's $attrs object.

# propsData

• type: Object

Set the component instance's props when the component is mounted.

Example:

const Component = {
  template: '<div>{{ msg }}</div>',
  props: ['msg']
const wrapper = mount(Component, {
  propsData: {
    msg: 'aBC'
expect(wrapper.text()).toBe('aBC')

# listeners

• type: Object

Set the component instance's $listeners object.

Example:

const Component = {
  template: '<button v-on:click="$emit(\'click\')"></button>'
const onClick = jest.fn()
const wrapper = mount(Component, {
  listeners: {
    click: onClick
wrapper.trigger('click')
expect(onClick).toHaveBeenCalled()

# parentComponent

• type: Object

Component to use as parent for mounted component.

Example:

import Foo from './Foo.vue'
const wrapper = shallowMount(Component, {
  parentComponent: Foo
expect(wrapper.vm.$parent.$options.name).toBe('foo')

# provide

• type: Object

Pass properties for components to use in injection. See provide/inject .

Example:

const Component = {
  inject: ['foo'],
  template: '<div>{{this.foo()}}</div>'
const wrapper = shallowMount(Component, {
  provide: {
    foo() {
      return 'fooValue'
expect(wrapper.text()).toBe('fooValue')

# Other options

When the options for mount and shallowMount contain the options other than the mounting options, the component options are overwritten with those using extends .

const Component = {
  template: '<div>{{ foo }}</div>',
  data() {
    return {
      foo: 'fromComponent'
const options = {
  data() {
    return {
      foo: 'fromOptions'
const wrapper = mount(Component, options)
expect(wrapper.text()).toBe('fromOptions')