Chai-jQ
chai-jq is an alternate plugin for the Chai assertion
library to provide jQuery-specific assertions.
Usage
You can install chai-jq via the following package managers:
See the integration notes below to properly patch Chai with the plugin's asserts in different environments (browser, AMD, Node.js).
To see some of the plugin's assertions in action, see the test page for the project.
Plugin API
.$visible.$hidden.$val(string|regexp).$class(string).$attr(name, string).$prop(name, value).$html(string).$text(string).$css(name, string)
.$visible
Asserts that the element is visible.
Node.js/JsDom Note: JsDom does not currently infer zero-sized or hidden parent elements as hidden / visible appropriately.
expect($("<div> </div>"))
.to.be.$visible;See: http://api.jquery.com/visible-selector/
.$hidden
Asserts that the element is hidden.
Node.js/JsDom Note: JsDom does not currently infer zero-sized or hidden parent elements as hidden / visible appropriately.
expect($("<div style=\"display: none\" />"))
.to.be.$hidden;See: http://api.jquery.com/hidden-selector/
.$val(string|regexp)
Asserts that the element value matches a string or regular expression.
expect($("<input value='foo' />"))
.to.have.$val("foo").and
.to.have.$val(/^foo/);See: http://api.jquery.com/val/
.$class(string)
Asserts that the element has a class match.
expect($("<div class='foo bar' />"))
.to.have.$class("foo").and
.to.have.$class("bar");See: http://api.jquery.com/hasClass/
.$attr(name, string)
Asserts that the target has exactly the given named attribute, or
asserts the target contains a subset of the attribute when using the
include or contain modifiers.
expect($("<div id=\"hi\" foo=\"bar time\" />"))
.to.have.$attr("id", "hi").and
.to.contain.$attr("foo", "bar");See: http://api.jquery.com/attr/
.$prop(name, value)
Asserts that the target has exactly the given named property.
expect($("<input type=\"checkbox\" checked=\"checked\" />"))
.to.have.$prop("checked", true).and
.to.have.$prop("type", "checkbox");See: http://api.jquery.com/prop/
.$html(string)
Asserts that the target has exactly the given HTML, or
asserts the target contains a subset of the HTML when using the
include or contain modifiers.
expect($("<div><span>foo</span></div>"))
.to.have.$html("<span>foo</span>").and
.to.contain.$html("foo");See: http://api.jquery.com/html/
.$text(string)
Asserts that the target has exactly the given text, or
asserts the target contains a subset of the text when using the
include or contain modifiers.
expect($("<div><span>foo</span> bar</div>"))
.to.have.$text("foo bar").and
.to.contain.$text("foo");See: http://api.jquery.com/text/
.$css(name, string)
Asserts that the target has exactly the given CSS property, or
asserts the target contains a subset of the CSS when using the
include or contain modifiers.
Node.js/JsDom Note: Computed CSS properties are not correctly inferred as of JsDom v0.8.8. Explicit ones should get matched exactly.
Browser Note: Explicit CSS properties are sometimes not matched
(in contrast to Node.js), so the plugin performs an extra check against
explicit style properties for a match. May still have other wonky
corner cases.
PhantomJS Note: PhantomJS also is fairly wonky and unpredictable with
respect to CSS / styles, especially those that come from CSS classes
and not explicity style attributes.
expect($("<div style=\"width: 50px; border: 1px dotted black;\" />"))
.to.have.$css("width", "50px").and
.to.have.$css("border-top-style", "dotted");See: http://api.jquery.com/css/
Integration
chai-jq works in your browser, with AMD/RequireJS, and in Node.js with
JsDom.
Standard Browser: To use in a standard HTML page, include chai-jq.js
after Chai.
<script src="chai.js"></script>
<script src="chai-jq.js"></script>AMD Browser: To use in a RequireJS/AMD page, require in chai-jq and
inject it into Chai before your test imports / runners begin:
require(["chai", "../chai-jq"], function (chai, plugin) {
// Inject plugin.
chai.use(plugin);
// Rest of your test code here...
});Node.js / JsDom: To use in Node.js/JsDom, require in chai-jq and
inject it into Chai before your test imports / runners begin:
var chai = require("chai");
var plugin = require("chai-jq");
// Inject plugin.
chai.use(plugin);
// Rest of test code here...Contributions
Please see the Contributions Guide for how to help out with the plugin.
We test all changes with Travis CI. Here's our current build status:
Licenses
All code not otherwise specified is Copyright 2013 Ryan Roemer. Released under the MIT License.
This repository contains various libraries from other folks, and are licensed as follows:
jQuery is Copyright jQuery Foundation and licensed under the MIT license.
Mocha is Copyright TJ Holowaychuk and licensed under the MIT license.
Chai is Copyright Jake Luer and licensed under the BSD license.
Sinon.JS is Copyright Christian Johansen and licensed under the BSD license.
Mocha-PhantomJS is Copyright Ken Collins and licensed under the MIT license.
Pure is Copyright Yahoo! and licensed under the MIT license.