API.md

API

assert.dom()

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

Parameters

• target (string | HTMLElement) A CSS selector that can be used to find elements using querySelector(), or an HTMLElement (Not all assertions support both target types.) (optional, default rootElement or document)
• rootElement HTMLElement? The root element of the DOM in which to search for the target (optional, default document)

Examples

test('the title exists', function(assert) {
  assert.dom('#title').exists();
});

Assertions

exists

• See: #doesNotExist

Assert an HTMLElement (or multiple) matching the selector exists.

Parameters

• options object?
• message string?

Examples

assert.dom('#title').exists();
assert.dom('.choice').exists({ count: 4 });

doesNotExist

• See: #exists

Assert an HTMLElement matching the selector does not exists.

Parameters

• message string?

Examples

assert.dom('.should-not-exist').doesNotExist();

isChecked

• See: #isNotChecked

Assert that the HTMLElement or an HTMLElement matching the selector is currently checked.

Parameters

• message string?

Examples

assert.dom('input.active').isChecked();

isNotChecked

• See: #isChecked

Assert that the HTMLElement or an HTMLElement matching the selector is currently unchecked.

Parameters

• message string?

Examples

assert.dom('input.active').isNotChecked();

isFocused

• See: #isNotFocused

Assert that the HTMLElement or an HTMLElement matching the selector is currently focused.

Parameters

• message string?

Examples

assert.dom('input.email').isFocused();

isNotFocused

• See: #isFocused

Assert that the HTMLElement or an HTMLElement matching the selector is not currently focused.

Parameters

• message string?

Examples

assert.dom('input[type="password"]').isNotFocused();

isRequired

• See: #isNotRequired

Assert that the HTMLElement or an HTMLElement matching the selector is currently required.

Parameters

• message string?

Examples

assert.dom('input[type="text"]').isRequired();

isNotRequired

• See: #isRequired

Assert that the HTMLElement or an HTMLElement matching the selector is currently not required.

Parameters

• message string?

Examples

assert.dom('input[type="text"]').isNotRequired();

isVisible

Assert that the HTMLElement or an HTMLElement matching the selector is visible. Visibility is determined with the hueristic used in jQuery's :visible pseudo-selector, specifically:

• is the element's offsetWidth non-zero
• is the element's offsetHeight non-zero
• is the length of an element's DOMRect objects found via getClientRects() non-zero

Additionally, visibility in this case means that the element is visible on the page, but not necessarily in the viewport.

Parameters

• message string?

Examples

assert.dom('.foo').isVisible();

isNotVisible

Assert that the HTMLElement or an HTMLElement matching the selector is not visible. Visibility is determined with the hueristic used in jQuery's :visible pseudo-selector, specifically:

• is the element's offsetWidth non-zero
• is the element's offsetHeight non-zero
• is the length of an element's DOMRect objects found via getClientRects() non-zero

Additionally, visibility in this case means that the element is visible on the page, but not necessarily in the viewport.

Parameters

• message string?

Examples

assert.dom('.foo').isNotVisible();

hasAttribute

• See: #doesNotHaveAttribute

Assert that the HTMLElement has an attribute with the provided name and optionally checks if the attribute value matches the provided text or regular expression.

Parameters

• name string
• value (string | RegExp | object?)
• message string?

Examples

assert.dom('input.password-input').hasAttribute('type', 'password');

doesNotHaveAttribute

• See: #hasAttribute

Assert that the HTMLElement has no attribute with the provided name.

Aliases: hasNoAttribute, lacksAttribute

Parameters

• name string
• message string?

Examples

assert.dom('input.username').hasNoAttribute('disabled');

hasClass

• See: #doesNotHaveClass

Assert that the HTMLElement has the expected CSS class using classList.

Parameters

• expected string
• message string?

Examples

assert.dom('input[type="password"]').hasClass('secret-password-input');

doesNotHaveClass

• See: #hasClass

Assert that the HTMLElement does not have the expected CSS class using classList.

Aliases: hasNoClass, lacksClass

Parameters

• expected string
• message string?

Examples

assert.dom('input[type="password"]').doesNotHaveClass('username-input');

hasText

• See: #includesText

Assert that the text of the HTMLElement or an HTMLElement matching the selector matches the expected text, using the textContent attribute and stripping/collapsing whitespace.

expected can also be a regular expression.

Parameters

• expected (string | RegExp)
• message string?

Examples

// <h2 id="title">
//   Welcome to <b>QUnit</b>
// </h2>

assert.dom('#title').hasText('Welcome to QUnit');

assert.dom('.foo').hasText(/[12]\d{3}/);

hasAnyText

• See: #hasText

Assert that the textContent property of an HTMLElement is not empty.

Parameters

• message string?

Examples

assert.dom('button.share').hasAnyText();

includesText

• See: #hasText

Assert that the text of the HTMLElement or an HTMLElement matching the selector contains the given text, using the textContent attribute.

Aliases: containsText, hasTextContaining

Parameters

• text string
• message string?

Examples

assert.dom('#title').includesText('Welcome');

doesNotIncludeText

Assert that the text of the HTMLElement or an HTMLElement matching the selector does not include the given text, using the textContent attribute.

Aliases: doesNotContainText, doesNotHaveTextContaining

Parameters

• text string
• message string?

Examples

assert.dom('#title').doesNotIncludeText('Welcome');

hasValue

• See: #hasAnyValue
• See: #hasNoValue

Assert that the value property of an HTMLInputElement matches the expected text or regular expression.

If no expected value is provided, the assertion will fail if the value is an empty string.

Parameters

• expected (string | RegExp | object?)
• message string?

Examples

assert.dom('input.username').hasValue('HSimpson');

hasAnyValue

• See: #hasValue
• See: #hasNoValue

Assert that the value property of an HTMLInputElement is not empty.

Parameters

• message string?

Examples

assert.dom('input.username').hasAnyValue();

hasNoValue

• See: #hasValue
• See: #hasAnyValue

Assert that the value property of an HTMLInputElement is empty.

Aliases: lacksValue

Parameters

• message string?

Examples

assert.dom('input.username').hasNoValue();