Git Product home page Git Product logo

vue-traverse's Introduction

Why?

Currently vue-test-utils must have a DOM to be used, but Vue does not! Contrary to what you might expect, Vue is not very much concerned with the DOM, except in one layer which runs when loaded inside a web browser. Due to this good design, a Vue component can be loaded in Node and you can set the props, call methods, and add listeners in a 100% supported way.

With vue-traverse you can now use a jQuery-like API to test that your template is behaving correctly as state changes, without reliance on jsdom or a web browser. This is thanks to Vue's documented VDOM (which is based on snabbdom).

This mixes well with vue-toolchain which allows you to easily require() a .vue file in mocha (see here).

Usage

const Query = require('vue-traverse');
const Vue = require('vue');
const expect = require('chai').expect;
const ConfirmDialog = require('./ConfirmDialog.vue').default;

const vm = new Vue(ConfirmDialog);
vm.text = 'Are you sure?'; // assuming this component has a 'text' prop...
vm.warn = true; // ... and a 'warn' prop
vm.$mount();

expect(Query(vm).hasClass('confirm-dialog')).to.be.true;
expect(Query(vm).find('.confirm-dialog__text').text()).to.equal('Are you sure?');
expect(Query(vm).find('.confirm-dialog__wrapper').hasClass('confirm-dialog__wrapper--is-warning')).to.be.true

API

These methods should behave just like good old jQuery. You can pretend that you're working on HTMLElements, even though internally you're inspecting the VDOM tree.

Traversal

  • find(selector) - reduce the set of matched elements to those that match selector
  • first() - reduce the set of matched elements to the first one in the set
  • last() - reduce the set of matched elements to the last one in the set

Getters

  • text() - returns the text content of all elements in the set, and children
  • attr(name) - value of the first element's v-bind:name
  • css(name) - value of name in the first element's v-bind:style object
  • prop(name) - value of name in the first element's v-bind.prop:name value
  • hasClass(name) - true if the element has this class via class= or v-bind:class="{}"

vue-traverse's People

Contributors

chearon avatar zbjornson avatar

Stargazers

Andre Asselin avatar Damon Muma avatar

Watchers

 avatar  avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.