# jest-dom

Custom jest matchers to test the state of the DOM

--- [![Build Status][build-badge]][build] [![Code Coverage][coverage-badge]][coverage] [![version][version-badge]][package] [![downloads][downloads-badge]][npmtrends] [![MIT License][license-badge]][license] [![All Contributors](https://img.shields.io/badge/all_contributors-28-orange.svg?style=flat-square)](#contributors-) [![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc] [![Discord][discord-badge]][discord] [![Watch on GitHub][github-watch-badge]][github-watch] [![Star on GitHub][github-star-badge]][github-star] [![Tweet][twitter-badge]][twitter] ## The problem You want to use [jest][] to write tests that assert various things about the state of a DOM. As part of that goal, you want to avoid all the repetitive patterns that arise in doing so. Checking for an element's attributes, its text content, its css classes, you name it. ## This solution The `@testing-library/jest-dom` library provides a set of custom jest matchers that you can use to extend jest. These will make your tests more declarative, clear to read and to maintain. ## Table of Contents - [Installation](#installation) - [Usage](#usage) - [With TypeScript](#with-typescript) - [Custom matchers](#custom-matchers) - [`toBeDisabled`](#tobedisabled) - [`toBeEnabled`](#tobeenabled) - [`toBeEmptyDOMElement`](#tobeemptydomelement) - [`toBeInTheDocument`](#tobeinthedocument) - [`toBeInvalid`](#tobeinvalid) - [`toBeRequired`](#toberequired) - [`toBeValid`](#tobevalid) - [`toBeVisible`](#tobevisible) - [`toContainElement`](#tocontainelement) - [`toContainHTML`](#tocontainhtml) - [`toHaveAccessibleDescription`](#tohaveaccessibledescription) - [`toHaveAccessibleErrorMessage`](#tohaveaccessibleerrormessage) - [`toHaveAccessibleName`](#tohaveaccessiblename) - [`toHaveAttribute`](#tohaveattribute) - [`toHaveClass`](#tohaveclass) - [`toHaveFocus`](#tohavefocus) - [`toHaveFormValues`](#tohaveformvalues) - [`toHaveStyle`](#tohavestyle) - [`toHaveTextContent`](#tohavetextcontent) - [`toHaveValue`](#tohavevalue) - [`toHaveDisplayValue`](#tohavedisplayvalue) - [`toBeChecked`](#tobechecked) - [`toBePartiallyChecked`](#tobepartiallychecked) - [`toHaveErrorMessage`](#tohaveerrormessage) - [Deprecated matchers](#deprecated-matchers) - [`toBeEmpty`](#tobeempty) - [`toBeInTheDOM`](#tobeinthedom) - [`toHaveDescription`](#tohavedescription) - [Inspiration](#inspiration) - [Other Solutions](#other-solutions) - [Guiding Principles](#guiding-principles) - [Contributors](#contributors) - [LICENSE](#license) ## Installation This module is distributed via [npm][npm] which is bundled with [node][node] and should be installed as one of your project's `devDependencies`: ``` npm install --save-dev @testing-library/jest-dom ``` or for installation with [yarn](https://yarnpkg.com/) package manager. ``` yarn add --dev @testing-library/jest-dom ``` > Note: We also recommend installing the jest-dom eslint plugin which provides > auto-fixable lint rules that prevent false positive tests and improve test > readability by ensuring you are using the right matchers in your tests. More > details can be found at > [eslint-plugin-jest-dom](https://github.com/testing-library/eslint-plugin-jest-dom). ## Usage Import `@testing-library/jest-dom` once (for instance in your [tests setup file][]) and you're good to go: [tests setup file]: https://jestjs.io/docs/en/configuration.html#setupfilesafterenv-array ```javascript // In your own jest-setup.js (or any other name) import '@testing-library/jest-dom' // In jest.config.js add (if you haven't already) setupFilesAfterEnv: ['/jest-setup.js'] ``` ### With TypeScript If you're using TypeScript, make sure your setup file is a `.ts` and not a `.js` to include the necessary types. You will also need to include your setup file in your `tsconfig.json` if you haven't already: ```json // In tsconfig.json "include": [ ... "./jest-setup.ts" ], ``` ## Custom matchers `@testing-library/jest-dom` can work with any library or framework that returns DOM elements from queries. The custom matcher examples below are written using matchers from `@testing-library`'s suite of libraries (e.g. `getByTestId`, `queryByTestId`, `getByText`, etc.) ### `toBeDisabled` ```typescript toBeDisabled() ``` This allows you to check whether an element is disabled from the user's perspective. According to the specification, the following elements can be [disabled](https://html.spec.whatwg.org/multipage/semantics-other.html#disabled-elements): `button`, `input`, `select`, `textarea`, `optgroup`, `option`, `fieldset`, and custom elements. This custom matcher considers an element as disabled if the element is among the types of elements that can be disabled (listed above), and the `disabled` attribute is present. It will also consider the element as disabled if it's inside a parent form element that supports being disabled and has the `disabled` attribute present. #### Examples ```html
link ``` ```javascript expect(getByTestId('button')).toBeDisabled() expect(getByTestId('input')).toBeDisabled() expect(getByText('link')).not.toBeDisabled() ``` > This custom matcher does not take into account the presence or absence of the > `aria-disabled` attribute. For more on why this is the case, check > [#144](https://github.com/testing-library/jest-dom/issues/144).

### `toBeEnabled` ```typescript toBeEnabled() ``` This allows you to check whether an element is not disabled from the user's perspective. It works like `not.toBeDisabled()`. Use this matcher to avoid double negation in your tests. > This custom matcher does not take into account the presence or absence of the > `aria-disabled` attribute. For more on why this is the case, check > [#144](https://github.com/testing-library/jest-dom/issues/144).

### `toBeEmptyDOMElement` ```typescript toBeEmptyDOMElement() ``` This allows you to assert whether an element has no visible content for the user. It ignores comments but will fail if the element contains white-space. #### Examples ```html ``` ```javascript expect(getByTestId('empty')).toBeEmptyDOMElement() expect(getByTestId('not-empty')).not.toBeEmptyDOMElement() expect(getByTestId('with-whitespace')).not.toBeEmptyDOMElement() ```

### `toBeInTheDocument` ```typescript toBeInTheDocument() ``` This allows you to assert whether an element is present in the document or not. #### Examples ```html Html Element
``` ```javascript expect( getByTestId(document.documentElement, 'html-element'), ).toBeInTheDocument() expect(getByTestId(document.documentElement, 'svg-element')).toBeInTheDocument() expect( queryByTestId(document.documentElement, 'does-not-exist'), ).not.toBeInTheDocument() ``` > Note: This matcher does not find detached elements. The element must be added > to the document to be found by toBeInTheDocument. If you desire to search in a > detached element please use: [`toContainElement`](#tocontainelement)

### `toBeInvalid` ```typescript toBeInvalid() ``` This allows you to check if an element, is currently invalid. An element is invalid if it has an [`aria-invalid` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-invalid_attribute) with no value or a value of `"true"`, or if the result of [`checkValidity()`](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5/Constraint_validation) is `false`. #### Examples ```html ``` ```javascript expect(getByTestId('no-aria-invalid')).not.toBeInvalid() expect(getByTestId('aria-invalid')).toBeInvalid() expect(getByTestId('aria-invalid-value')).toBeInvalid() expect(getByTestId('aria-invalid-false')).not.toBeInvalid() expect(getByTestId('valid-form')).not.toBeInvalid() expect(getByTestId('invalid-form')).toBeInvalid() ```

### `toBeRequired` ```typescript toBeRequired() ``` This allows you to check if a form element is currently required. An element is required if it is having a `required` or `aria-required="true"` attribute. #### Examples ```html
``` ```javascript expect(getByTestId('required-input')).toBeRequired() expect(getByTestId('aria-required-input')).toBeRequired() expect(getByTestId('conflicted-input')).toBeRequired() expect(getByTestId('aria-not-required-input')).not.toBeRequired() expect(getByTestId('optional-input')).not.toBeRequired() expect(getByTestId('unsupported-type')).not.toBeRequired() expect(getByTestId('select')).toBeRequired() expect(getByTestId('textarea')).toBeRequired() expect(getByTestId('supported-role')).not.toBeRequired() expect(getByTestId('supported-role-aria')).toBeRequired() ```

### `toBeValid` ```typescript toBeValid() ``` This allows you to check if the value of an element, is currently valid. An element is valid if it has no [`aria-invalid` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-invalid_attribute)s or an attribute value of `"false"`. The result of [`checkValidity()`](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5/Constraint_validation) must also be `true` if it's a form element. #### Examples ```html ``` ```javascript expect(getByTestId('no-aria-invalid')).toBeValid() expect(getByTestId('aria-invalid')).not.toBeValid() expect(getByTestId('aria-invalid-value')).not.toBeValid() expect(getByTestId('aria-invalid-false')).toBeValid() expect(getByTestId('valid-form')).toBeValid() expect(getByTestId('invalid-form')).not.toBeValid() ```

### `toBeVisible` ```typescript toBeVisible() ``` This allows you to check if an element is currently visible to the user. An element is visible if **all** the following conditions are met: - it is present in the document - it does not have its css property `display` set to `none` - it does not have its css property `visibility` set to either `hidden` or `collapse` - it does not have its css property `opacity` set to `0` - its parent element is also visible (and so on up to the top of the DOM tree) - it does not have the [`hidden`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/hidden) attribute - if `
` it has the `open` attribute #### Examples ```html
Zero Opacity Example
Visibility Hidden Example
Display None Example
Hidden Parent Example
Visible Example
Hidden Attribute Example
Title of hidden text
Hidden Details Example
Title of visible text
Visible Details Example
``` ```javascript expect(getByText('Zero Opacity Example')).not.toBeVisible() expect(getByText('Visibility Hidden Example')).not.toBeVisible() expect(getByText('Display None Example')).not.toBeVisible() expect(getByText('Hidden Parent Example')).not.toBeVisible() expect(getByText('Visible Example')).toBeVisible() expect(getByText('Hidden Attribute Example')).not.toBeVisible() expect(getByText('Hidden Details Example')).not.toBeVisible() expect(getByText('Visible Details Example')).toBeVisible() ```

### `toContainElement` ```typescript toContainElement(element: HTMLElement | SVGElement | null) ``` This allows you to assert whether an element contains another element as a descendant or not. #### Examples ```html ``` ```javascript const ancestor = getByTestId('ancestor') const descendant = getByTestId('descendant') const nonExistantElement = getByTestId('does-not-exist') expect(ancestor).toContainElement(descendant) expect(descendant).not.toContainElement(ancestor) expect(ancestor).not.toContainElement(nonExistantElement) ```

### `toContainHTML` ```typescript toContainHTML(htmlText: string) ``` Assert whether a string representing a HTML element is contained in another element. The string should contain valid html, and not any incomplete html. #### Examples ```html ``` ```javascript // These are valid uses expect(getByTestId('parent')).toContainHTML('') expect(getByTestId('parent')).toContainHTML('') expect(getByTestId('parent')).not.toContainHTML('
') // These won't work expect(getByTestId('parent')).toContainHTML('data-testid="child"') expect(getByTestId('parent')).toContainHTML('data-testid') expect(getByTestId('parent')).toContainHTML('') ``` > Chances are you probably do not need to use this matcher. We encourage testing > from the perspective of how the user perceives the app in a browser. That's > why testing against a specific DOM structure is not advised. > > It could be useful in situations where the code being tested renders html that > was obtained from an external source, and you want to validate that that html > code was used as intended. > > It should not be used to check DOM structure that you control. Please use > [`toContainElement`](#tocontainelement) instead.

### `toHaveAccessibleDescription` ```typescript toHaveAccessibleDescription(expectedAccessibleDescription?: string | RegExp) ``` This allows you to assert that an element has the expected [accessible description](https://w3c.github.io/accname/). You can pass the exact string of the expected accessible description, or you can make a partial match passing a regular expression, or by using [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring)/[expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp). #### Examples ```html Start About The logo of Our Company ``` ```js expect(getByTestId('link')).toHaveAccessibleDescription() expect(getByTestId('link')).toHaveAccessibleDescription('A link to start over') expect(getByTestId('link')).not.toHaveAccessibleDescription('Home page') expect(getByTestId('extra-link')).not.toHaveAccessibleDescription() expect(getByTestId('avatar')).not.toHaveAccessibleDescription() expect(getByTestId('logo')).not.toHaveAccessibleDescription('Company logo') expect(getByTestId('logo')).toHaveAccessibleDescription( 'The logo of Our Company', ) ```

### `toHaveAccessibleErrorMessage` ```typescript toHaveAccessibleErrorMessage(expectedAccessibleErrorMessage?: string | RegExp) ``` This allows you to assert that an element has the expected [accessible error message](https://w3c.github.io/aria/#aria-errormessage). You can pass the exact string of the expected accessible error message. Alternatively, you can perform a partial match by passing a regular expression or by using [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring)/[expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp). #### Examples ```html
This field is invalid
``` ```js // Inputs with Valid Error Messages expect(getByRole('textbox', {name: 'Has Error'})).toHaveAccessibleErrorMessage() expect(getByRole('textbox', {name: 'Has Error'})).toHaveAccessibleErrorMessage( 'This field is invalid', ) expect(getByRole('textbox', {name: 'Has Error'})).toHaveAccessibleErrorMessage( /invalid/i, ) expect( getByRole('textbox', {name: 'Has Error'}), ).not.toHaveAccessibleErrorMessage('This field is absolutely correct!') // Inputs without Valid Error Messages expect( getByRole('textbox', {name: 'No Error Attributes'}), ).not.toHaveAccessibleErrorMessage() expect( getByRole('textbox', {name: 'Not Invalid'}), ).not.toHaveAccessibleErrorMessage() ```

### `toHaveAccessibleName` ```typescript toHaveAccessibleName(expectedAccessibleName?: string | RegExp) ``` This allows you to assert that an element has the expected [accessible name](https://w3c.github.io/accname/). It is useful, for instance, to assert that form elements and buttons are properly labelled. You can pass the exact string of the expected accessible name, or you can make a partial match passing a regular expression, or by using [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring)/[expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp). #### Examples ```html

Test content