API.md

API

methods

• mount
• shallow
• wrapper
  • contains
  • destroy
  • didEmit
  • find
  • hasAttribute
  • hasClass
  • hasStyle
  • hasProp
  • html
  • is
  • isEmpty
  • isVueInstance
  • name
  • setData
  • setProps
  • text
  • trigger
  • update

mount(Component, options)

Mount component.

options Object

attachToDocument Boolean attach DOM to document. Default false

components - Array<String> - name of components to replace with stubs

globals - Object methods and properties to be added as globals

provide - Object properties to inject into component

props - Object

slots - Object

slots.name - Array<Component>|Component|String

returns Object - Wrapper/ Vue Wrapper

example

const wrapper = mount(Component, {
 components: ['foo', 'bar'],
 globals: { $route: stub() }
 props: { myProp: 'my prop' },
 provide: { anotherProp: 'access via `inject`' },
 slots: {
  default: [AnotherComponent],
  header: HeaderComponent
 }
})

shallow(Component, options)

Render component n level deeep, defaults to 1. stub child components so they can still be tested.

options Object

components - Array<String> - name of components to replace with stubs

depth - Number - number of levels to render

globals - Object methods and properties to be added as globals

props - Object

slots - Object

slots.name - Array<Component>|Component|String

returns Object - Wrapper/ Vue Wrapper

example

const wrapper = shallow(Component, {
 components: ['foo', 'bar'],
 globals: { $route: stub() }
 props: { myProp: 'my prop' },
 slots: {
  default: [AnotherComponent],
  header: HeaderComponent
 }
})

wrapper

contains(selector)

Returns true if wrapper contains selector

selector - String|Object CSS selector or Vue component

returns - Boolean

example

wrapper.contains('div')

destroy()

Calls $destroy on vms

comments - maybe not needed. Same could be achieved with wrapper.vm.$destory

example

wrapper.destroy()

didEmit()

Asserts wrapper vm emitted event

returns - Boolean

example

wrapper.didEmit('update')

find(selector)

Returns true if wrapper contains selector

selector - String|Object CSS selector or Vue component

returns - Object wrapper containing new elements

example

wrapper.find()

hasAttribute(attribute, value?)

Returns true if wrapper DOM elements have attribute. If value is specified, checke the value of the attribute matches.

attribute - String value (optional) - String

returns - Boolean

example

wrapper.hasAttribute('attribute')

hasClass(class)

Returns true if wrapper DOM elements have class

class - String

returns - Boolean

example

wrapper.hasClass('class')

hasStyle(style)

Returns true if wrapper DOM elements have style

style - String

returns - Boolean

example

wrapper.hasProp('style')

hasProp(prop)

Returns true if wrapper vm have prop

prop - String

returns - Boolean

example

wrapper.hasProp('prop')

html()

Renders HTML of wrapper elements

returns - String HTML of wrapper DOM node as a string

example

wrapper.html()

is(selector)

Asserts root wrapper nodes match selector

returns - Boolean

example

wrapper.is('div')

isEmpty()

Asserts root wrapper node contains no children

returns - Boolean

example

wrapper.isEmpty()

isVueInstance()

Asserts root wrapper node is vm

returns - Boolean

example

wrapper.isVueComponent()

name()

Returns name of vm or tag name of vNode

returns - String - name of component if vm, name of tag if vNode

example

wrapper.name()

setData(data)

Sets vm data and re renders

comments - should it re render, or should it be left to user?

data - Object - data to set

example

wrapper.setData({data: 'value'})

setProps(props)

Sets vm props and re renders

comments - should it re render, or should it be left to user?

props - Object - props to set

example

wrapper.setProps({prop: 'value'})

text()

Returns all text node content of vNode tree concatted to string

returns - String - content of all text nodes

example

wrapper.text()

trigger(event)

Dispatches native event or custom event to wrapper elements or vms

event - String name of event to be dispatched/emitted

comments - should this be broken into two methods - trigger and emit?

example

wrapper.trigger('click')

update()

Forces vm to re render example

wrapper.update()