qunit-dom

qunit-dom
==============================================================================

[![Latest NPM release][npm-badge]][npm-badge-url]

[npm-badge]: https://img.shields.io/npm/v/qunit-dom.svg
[npm-badge-url]: https://www.npmjs.com/package/qunit-dom
[travis-badge]: https://img.shields.io/travis/simplabs/qunit-dom/master.svg
[travis-badge-url]: https://travis-ci.org/simplabs/qunit-dom

High Level DOM Assertions for QUnit

``js
assert.dom('h1').exists();
assert.dom('h1').hasClass('title');
assert.dom('h1').hasText('Welcome to Ember, John Doe!');

assert.dom('input').isFocused();
assert.dom('input').hasValue(/.+ Doe/);
assert.dom('input').hasAttribute('type', 'text');
`

> [!NOTE]
> qunit-dom was written and is maintained by Mainmatter and contributors.
> We offer consulting, training, and team augmentation for web development teams – check out our website to learn more!

Install
------------------------------------------------------------------------------

$3

`bash
npm install --save-dev qunit-dom
`

or using yarn:

`bash
yarn add --dev qunit-dom
`

$3

Import and run the setup function in your test-helper.js file:

`js
// tests/test-helper.js
import * as QUnit from 'qunit';
import { setup } from 'qunit-dom';

//...

setup(QUnit.assert);

setApplication(Application.create(config.APP));

start();

//...
`

This will attach the APIs to QUnit's assert object.

$3

Install qunit-dom v2.0.0

$3

Load qunit-dom.js after qunit.js:

`html


`


Usage
------------------------------------------------------------------------------

Once installed the DOM element assertions are available at assert.dom(...).*:

`js
test('the title is welcoming', function(assert) {
assert.dom('#title').hasText('Welcome to QUnit');
});
`

All available assertions are documented in API.md.

A basic codemod to automatically convert your assertions is available at
https://github.com/simplabs/qunit-dom-codemod.

$3

qunit-dom includes type definition files, but the way it extends QUnit means
that you need import it somewhere so that TS and your editor can pick up the
types. It is recommended to add the following line to your
tests/test-helper.ts file:

`
import 'qunit-dom';
`

Rename your tests/test-helper.js to .ts` if you do not have such a
file yet.

Contributing
------------------------------------------------------------------------------

See CONTRIBUTING.md.

Related
------------------------------------------------------------------------------

- chai-dom – DOM assertions for
the Chai assertion library using vanilla JavaScript
- chai-jquery – jQuery assertions
for chai

License
------------------------------------------------------------------------------

qunit-dom is developed by and ©
Mainmatter GmbH and contributors. It is released under the
MIT License.