https://github.com/mainmatter/qunit-dom

High Level DOM Assertions for QUnit
https://github.com/mainmatter/qunit-dom

dom-assertions ember emberjs hacktoberfest qunit qunit-dom

Last synced: 1 day ago
JSON representation

High Level DOM Assertions for QUnit

• Host: GitHub
• URL: https://github.com/mainmatter/qunit-dom
• Owner: mainmatter
• License: mit
• Created: 2017-08-30T16:05:54.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-01-19T08:19:03.000Z (5 days ago)
• Last Synced: 2025-01-19T09:23:49.557Z (5 days ago)
• Topics: dom-assertions, ember, emberjs, hacktoberfest, qunit, qunit-dom
• Language: TypeScript
• Homepage:
• Size: 13.8 MB
• Stars: 179
• Watchers: 8
• Forks: 125
• Open Issues: 49
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
qunit-dom

==============================================================================

[![CI Build Status](https://github.com/simplabs/qunit-dom/actions/workflows/ci.yml/badge.svg)](https://github.com/simplabs/qunit-dom/actions/workflows/ci.yml)

[![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](https://qunitjs.com/)

```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](https://mainmatter.com) and contributors.

> We offer consulting, training, and team augmentation for web development teams – check out our [website](https://mainmatter.com/) to learn more!

Install

------------------------------------------------------------------------------

### npm

```bash

npm install --save-dev qunit-dom

```

or using [`yarn`](https://yarnpkg.com/):

```bash

yarn add --dev qunit-dom

```

### Ember projects using `ember-qunit` v6.x and above

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.

### Ember projects using < v6.x of ember-qunit

Install qunit-dom v2.0.0

### `` Tag

Load `qunit-dom.js` *after* `qunit.js`:

```html

<script src="https://unpkg.com/qunitjs/qunit/qunit.js">

```

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](API.md).**

A basic codemod to automatically convert your assertions is available at

[https://github.com/simplabs/qunit-dom-codemod](https://github.com/simplabs/qunit-dom-codemod).

### TypeScript

`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](CONTRIBUTING.md).

Related

------------------------------------------------------------------------------

- [chai-dom](https://github.com/nathanboktae/chai-dom) – DOM assertions for

  the Chai assertion library using vanilla JavaScript

- [chai-jquery](https://github.com/chaijs/chai-jquery) – jQuery assertions

  for chai

License

------------------------------------------------------------------------------

qunit-dom is developed by and ©

[Mainmatter GmbH](http://mainmatter.com) and contributors. It is released under the

[MIT License](https://github.com/simplabs/qunit-dom/blob/master/LICENSE.md).