jest-dom

owl

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
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 User profile pic Company logo 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 ``` ```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 alt Test title

Test content

``` ```javascript const button = getByTestId('ok-button') expect(button).toHaveAttribute('disabled') expect(button).toHaveAttribute('type', 'submit') expect(button).not.toHaveAttribute('type', 'button') expect(button).toHaveAttribute('type', expect.stringContaining('sub')) expect(button).toHaveAttribute('type', expect.not.stringContaining('but')) ```
### `toHaveClass` ```typescript toHaveClass(...classNames: string[], options?: {exact: boolean}) ``` This allows you to check whether the given element has certain classes within its `class` attribute. You must provide at least one class, unless you are asserting that an element does not have any classes. #### Examples ```html ``` ```javascript const deleteButton = getByTestId('delete-button') const noClasses = getByTestId('no-classes') expect(deleteButton).toHaveClass('extra') expect(deleteButton).toHaveClass('btn-danger btn') expect(deleteButton).toHaveClass('btn-danger', 'btn') expect(deleteButton).not.toHaveClass('btn-link') expect(deleteButton).toHaveClass('btn-danger extra btn', {exact: true}) // to check if the element has EXACTLY a set of classes expect(deleteButton).not.toHaveClass('btn-danger extra', {exact: true}) // if it has more than expected it is going to fail expect(noClasses).not.toHaveClass() ```
### `toHaveFocus` ```typescript toHaveFocus() ``` This allows you to assert whether an element has focus or not. #### Examples ```html
``` ```javascript const input = getByTestId('element-to-focus') input.focus() expect(input).toHaveFocus() input.blur() expect(input).not.toHaveFocus() ```
### `toHaveFormValues` ```typescript toHaveFormValues(expectedValues: { [name: string]: any }) ``` This allows you to check if a form or fieldset contains form controls for each given name, and having the specified value. > It is important to stress that this matcher can only be invoked on a [form][] > or a [fieldset][] element. > > This allows it to take advantage of the [.elements][] property in `form` and > `fieldset` to reliably fetch all form controls within them. > > This also avoids the possibility that users provide a container that contains > more than one `form`, thereby intermixing form controls that are not related, > and could even conflict with one another. This matcher abstracts away the particularities with which a form control value is obtained depending on the type of form control. For instance, `` elements have a `value` attribute, but `` elements return the value as a **number**, instead of a string. - `` elements: - if there's a single one with the given `name` attribute, it is treated as a **boolean**, returning `true` if the checkbox is checked, `false` if unchecked. - if there's more than one checkbox with the same `name` attribute, they are all treated collectively as a single form control, which returns the value as an **array** containing all the values of the selected checkboxes in the collection. - `` elements are all grouped by the `name` attribute, and such a group treated as a single form control. This form control returns the value as a **string** corresponding to the `value` attribute of the selected radio button within the group. - `` elements return the value as a **string**. This also applies to `` elements having any other possible `type` attribute that's not explicitly covered in different rules above (e.g. `search`, `email`, `date`, `password`, `hidden`, etc.) - `` elements return the value as an **array** containing all the values of the [selected options][]. - ` ``` ##### Using DOM Testing Library ```javascript const input = screen.getByLabelText('First name') const textarea = screen.getByLabelText('Description') const selectSingle = screen.getByLabelText('Fruit') const selectMultiple = screen.getByLabelText('Fruits') expect(input).toHaveDisplayValue('Luca') expect(input).toHaveDisplayValue(/Luc/) expect(textarea).toHaveDisplayValue('An example description here.') expect(textarea).toHaveDisplayValue(/example/) expect(selectSingle).toHaveDisplayValue('Select a fruit...') expect(selectSingle).toHaveDisplayValue(/Select/) expect(selectMultiple).toHaveDisplayValue([/Avocado/, 'Banana']) ```
### `toBeChecked` ```typescript toBeChecked() ``` This allows you to check whether the given element is checked. It accepts an `input` of type `checkbox` or `radio` and elements with a `role` of `checkbox`, `radio` or `switch` with a valid `aria-checked` attribute of `"true"` or `"false"`. #### Examples ```html
``` ```javascript const inputCheckboxChecked = getByTestId('input-checkbox-checked') const inputCheckboxUnchecked = getByTestId('input-checkbox-unchecked') const ariaCheckboxChecked = getByTestId('aria-checkbox-checked') const ariaCheckboxUnchecked = getByTestId('aria-checkbox-unchecked') expect(inputCheckboxChecked).toBeChecked() expect(inputCheckboxUnchecked).not.toBeChecked() expect(ariaCheckboxChecked).toBeChecked() expect(ariaCheckboxUnchecked).not.toBeChecked() const inputRadioChecked = getByTestId('input-radio-checked') const inputRadioUnchecked = getByTestId('input-radio-unchecked') const ariaRadioChecked = getByTestId('aria-radio-checked') const ariaRadioUnchecked = getByTestId('aria-radio-unchecked') expect(inputRadioChecked).toBeChecked() expect(inputRadioUnchecked).not.toBeChecked() expect(ariaRadioChecked).toBeChecked() expect(ariaRadioUnchecked).not.toBeChecked() const ariaSwitchChecked = getByTestId('aria-switch-checked') const ariaSwitchUnchecked = getByTestId('aria-switch-unchecked') expect(ariaSwitchChecked).toBeChecked() expect(ariaSwitchUnchecked).not.toBeChecked() ```
### `toBePartiallyChecked` ```typescript toBePartiallyChecked() ``` This allows you to check whether the given element is partially checked. It accepts an `input` of type `checkbox` and elements with a `role` of `checkbox` with a `aria-checked="mixed"`, or `input` of type `checkbox` with `indeterminate` set to `true` #### Examples ```html
``` ```javascript const ariaCheckboxMixed = getByTestId('aria-checkbox-mixed') const inputCheckboxChecked = getByTestId('input-checkbox-checked') const inputCheckboxUnchecked = getByTestId('input-checkbox-unchecked') const ariaCheckboxChecked = getByTestId('aria-checkbox-checked') const ariaCheckboxUnchecked = getByTestId('aria-checkbox-unchecked') const inputCheckboxIndeterminate = getByTestId('input-checkbox-indeterminate') expect(ariaCheckboxMixed).toBePartiallyChecked() expect(inputCheckboxChecked).not.toBePartiallyChecked() expect(inputCheckboxUnchecked).not.toBePartiallyChecked() expect(ariaCheckboxChecked).not.toBePartiallyChecked() expect(ariaCheckboxUnchecked).not.toBePartiallyChecked() inputCheckboxIndeterminate.indeterminate = true expect(inputCheckboxIndeterminate).toBePartiallyChecked() ```
### `toHaveErrorMessage` > This custom matcher is deprecated. Prefer > [`toHaveAccessibleErrorMessage`](#tohaveaccessibleerrormessage) instead, which > is more comprehensive in implementing the official spec. ```typescript toHaveErrorMessage(text: string | RegExp) ``` This allows you to check whether the given element has an [ARIA error message](https://www.w3.org/TR/wai-aria/#aria-errormessage) or not. Use the `aria-errormessage` attribute to reference another element that contains custom error message text. Multiple ids is **NOT** allowed. Authors MUST use `aria-invalid` in conjunction with `aria-errormessage`. Learn more from [`aria-errormessage` spec](https://www.w3.org/TR/wai-aria/#aria-errormessage). Whitespace is normalized. When a `string` argument is passed through, it will perform a whole case-sensitive match to the error message text. To perform a case-insensitive match, you can use a `RegExp` with the `/i` modifier. To perform a partial match, you can pass a `RegExp` or use `expect.stringContaining("partial string")`. #### Examples ```html Invalid time: the time must be between 9:00 AM and 5:00 PM ``` ```javascript const timeInput = getByLabel('startTime') expect(timeInput).toHaveErrorMessage( 'Invalid time: the time must be between 9:00 AM and 5:00 PM', ) expect(timeInput).toHaveErrorMessage(/invalid time/i) // to partially match expect(timeInput).toHaveErrorMessage(expect.stringContaining('Invalid time')) // to partially match expect(timeInput).not.toHaveErrorMessage('Pikachu!') ``` ## Deprecated matchers ### `toBeEmpty` > Note: This matcher is being deprecated due to a name clash with > `jest-extended`. See more info in #216. In the future, please use only > [`toBeEmptyDOMElement`](#toBeEmptyDOMElement) ```typescript toBeEmpty() ``` This allows you to assert whether an element has content or not. #### Examples ```html ``` ```javascript expect(getByTestId('empty')).toBeEmpty() expect(getByTestId('not-empty')).not.toBeEmpty() ```
### `toBeInTheDOM` > This custom matcher is deprecated. Prefer > [`toBeInTheDocument`](#tobeinthedocument) instead. ```typescript toBeInTheDOM() ``` This allows you to check whether a value is a DOM element, or not. Contrary to what its name implies, this matcher only checks that you passed to it a valid DOM element. It does not have a clear definition of what "the DOM" is. Therefore, it does not check whether that element is contained anywhere. This is the main reason why this matcher is deprecated, and will be removed in the next major release. You can follow the discussion around this decision in more detail [here](https://github.com/testing-library/jest-dom/issues/34). As an alternative, you can use [`toBeInTheDocument`](#tobeinthedocument) or [`toContainElement`](#tocontainelement). Or if you just want to check if a value is indeed an `HTMLElement` you can always use some of [jest's built-in matchers](https://jestjs.io/docs/en/expect#tobeinstanceofclass): ```js expect(document.querySelector('.ok-button')).toBeInstanceOf(HTMLElement) expect(document.querySelector('.cancel-button')).toBeTruthy() ``` > Note: The differences between `toBeInTheDOM` and `toBeInTheDocument` are > significant. Replacing all uses of `toBeInTheDOM` with `toBeInTheDocument` > will likely cause unintended consequences in your tests. Please make sure when > replacing `toBeInTheDOM` to read through the documentation of the proposed > alternatives to see which use case works better for your needs. ### `toHaveDescription` > This custom matcher is deprecated. Prefer > [`toHaveAccessibleDescription`](#tohaveaccessibledescription) instead, which > is more comprehensive in implementing the official spec. ```typescript toHaveDescription(text: string | RegExp) ``` This allows you to check whether the given element has a description or not. An element gets its description via the [`aria-describedby` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute). Set this to the `id` of one or more other elements. These elements may be nested inside, be outside, or a sibling of the passed in element. Whitespace is normalized. Using multiple ids will [join the referenced elements’ text content separated by a space](https://www.w3.org/TR/accname-1.1/#mapping_additional_nd_description). When a `string` argument is passed through, it will perform a whole case-sensitive match to the description text. To perform a case-insensitive match, you can use a `RegExp` with the `/i` modifier. To perform a partial match, you can pass a `RegExp` or use `expect.stringContaining("partial string")`. #### Examples ```html
Closing will discard any changes
``` ```javascript const closeButton = getByRole('button', {name: 'Close'}) expect(closeButton).toHaveDescription('Closing will discard any changes') expect(closeButton).toHaveDescription(/will discard/) // to partially match expect(closeButton).toHaveDescription(expect.stringContaining('will discard')) // to partially match expect(closeButton).toHaveDescription(/^closing/i) // to use case-insensitive match expect(closeButton).not.toHaveDescription('Other description') const deleteButton = getByRole('button', {name: 'Delete'}) expect(deleteButton).not.toHaveDescription() expect(deleteButton).toHaveDescription('') // Missing or empty description always becomes a blank string ``` ## Inspiration This whole library was extracted out of Kent C. Dodds' [DOM Testing Library][dom-testing-library], which was in turn extracted out of [React Testing Library][react-testing-library]. The intention is to make this available to be used independently of these other libraries, and also to make it more clear that these other libraries are independent from jest, and can be used with other tests runners as well. ## Other Solutions I'm not aware of any, if you are please [make a pull request][prs] and add it here! If you would like to further test the accessibility and validity of the DOM consider [`jest-axe`](https://github.com/nickcolley/jest-axe). It doesn't overlap with `jest-dom` but can complement it for more in-depth accessibility checking (eg: validating `aria` attributes or ensuring unique id attributes). ## Guiding Principles > [The more your tests resemble the way your software is used, the more > confidence they can give you.][guiding-principle] This library follows the same guiding principles as its mother library [DOM Testing Library][dom-testing-library]. Go [check them out][guiding-principle] for more details. Additionally, with respect to custom DOM matchers, this library aims to maintain a minimal but useful set of them, while avoiding bloating itself with merely convenient ones that can be easily achieved with other APIs. In general, the overall criteria for what is considered a useful custom matcher to add to this library, is that doing the equivalent assertion on our own makes the test code more verbose, less clear in its intent, and/or harder to read. ## Contributors Thanks goes to these people ([emoji key][emojis]):

Kent C. Dodds
πŸ’» πŸ“– πŸš‡ ⚠️
Ryan Castner
πŸ“–
Daniel Sandiego
πŸ’»
PaweΕ‚ MikoΕ‚ajczyk
πŸ’»
Alejandro ÑÑñez Ortiz
πŸ“–
Matt Parrish
πŸ› πŸ’» πŸ“– ⚠️
Justin Hall
πŸ“¦

Anto Aravinth
πŸ’» ⚠️ πŸ“–
Jonah Moses
πŸ“–
Łukasz Gandecki
πŸ’» ⚠️ πŸ“–
Ivan Babak
πŸ› πŸ€”
Jesse Day
πŸ’»
Ernesto GarcΓ­a
πŸ’» πŸ“– ⚠️
Mark Volkmann
πŸ› πŸ’»

smacpherson64
πŸ’» πŸ“– ⚠️
John Gozde
πŸ› πŸ’»
Iwona
πŸ’» πŸ“– ⚠️
Lewis
πŸ’»
Leandro Lourenci
πŸ› πŸ“– πŸ’» ⚠️
Shukhrat Mukimov
πŸ›
Roman Usherenko
πŸ’» ⚠️

Joe Hsu
πŸ“–
Haz
πŸ› πŸ’»
Revath S Kumar
πŸ’»
hiwelo.
πŸ’» πŸ€” ⚠️
Łukasz Fiszer
πŸ’»
Jean Chung
πŸ’» ⚠️
CarlaTeo
πŸ’» ⚠️

Yarden Shoham
πŸ“–
Jaga Santagostino
πŸ› ⚠️ πŸ“–
Connor Meredith
πŸ’» ⚠️ πŸ“–
Pawel Wolak
⚠️
MichaΓ«l De Boey
πŸš‡
Jānis Zaržeckis
πŸ“–
koala-lava
πŸ“–

Juan Pablo Blanco
πŸ“–
Ben Monro
πŸ“–
Jeff Bernstein
πŸ“–
Sergi
πŸ’» ⚠️
Spencer Miskoviak
πŸ“–
Jon Rimmer
πŸ’» ⚠️
Luca Barone
πŸ’» ⚠️ πŸ€”

Malte Felmy
πŸ’» ⚠️
Championrunner
πŸ“–
Patrick Smith
πŸ’» ⚠️ πŸ“–
RubΓ©n Moya
πŸ’» ⚠️ πŸ“–
Daniela Valero
πŸ’» ⚠️ πŸ“–
Vladislav Katsura
πŸ’» ⚠️
Tim Fischbach
πŸ’» ⚠️ πŸ€”

Katie Boedges
πŸš‡
Brian Alexis
⚠️
Boris Serdiuk
πŸ› πŸ’» ⚠️
Dana Woodman
πŸ“–
Mo Sattler
πŸ“–
Geoff Rich
πŸ’» ⚠️ πŸ€” πŸ›
Syneva
πŸ’»

Nick McCurdy
πŸ“– πŸ› πŸ’»
Obed Marquez Parlapiano
πŸ“–
Caleb Eby
πŸ“– πŸ’» ⚠️
Marcel Barner
πŸ’» ⚠️
Doma
πŸ’» ⚠️
Julien Wajsberg
πŸ’» ⚠️
steven nguyen
πŸ“–

tu4mo
πŸ“–
Matan Borenkraout
πŸ“¦
Yann Braga
πŸ’»
Ian VanSchooten
πŸ’»
Chantal Broeren
πŸ“–
JΓ©rΓ©mie Astori
πŸ’» πŸ€”
Ashley Ryan
πŸ’» πŸ€”
This project follows the [all-contributors][all-contributors] specification. Contributions of any kind welcome! ## LICENSE MIT [jest]: https://facebook.github.io/jest/ [dom-testing-library]: https://github.com/testing-library/dom-testing-library [react-testing-library]: https://github.com/testing-library/react-testing-library [npm]: https://www.npmjs.com/ [node]: https://nodejs.org [build-badge]: https://img.shields.io/github/workflow/status/testing-library/jest-dom/validate?logo=github&style=flat-square [build]: https://github.com/testing-library/jest-dom/actions?query=workflow%3Avalidate [coverage-badge]: https://img.shields.io/codecov/c/github/testing-library/jest-dom.svg?style=flat-square [coverage]: https://codecov.io/github/testing-library/jest-dom [version-badge]: https://img.shields.io/npm/v/@testing-library/jest-dom.svg?style=flat-square [package]: https://www.npmjs.com/package/@testing-library/jest-dom [downloads-badge]: https://img.shields.io/npm/dm/@testing-library/jest-dom.svg?style=flat-square [npmtrends]: http://www.npmtrends.com/@testing-library/jest-dom [license-badge]: https://img.shields.io/npm/l/@testing-library/jest-dom.svg?style=flat-square [license]: https://github.com/testing-library/jest-dom/blob/main/LICENSE [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square [prs]: http://makeapullrequest.com [coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square [coc]: https://github.com/testing-library/jest-dom/blob/main/other/CODE_OF_CONDUCT.md [github-watch-badge]: https://img.shields.io/github/watchers/testing-library/jest-dom.svg?style=social [github-watch]: https://github.com/testing-library/jest-dom/watchers [github-star-badge]: https://img.shields.io/github/stars/testing-library/jest-dom.svg?style=social [github-star]: https://github.com/testing-library/jest-dom/stargazers [twitter]: https://twitter.com/intent/tweet?text=Check%20out%20jest-dom%20by%20%40gnapse%20https%3A%2F%2Fgithub.com%2Ftesting-library%2Fjest-dom%20%F0%9F%91%8D [twitter-badge]: https://img.shields.io/twitter/url/https/github.com/testing-library/jest-dom.svg?style=social [emojis]: https://github.com/all-contributors/all-contributors#emoji-key [all-contributors]: https://github.com/all-contributors/all-contributors [all-contributors-badge]: https://img.shields.io/github/all-contributors/testing-library/jest-dom?color=orange&style=flat-square [guiding-principle]: https://testing-library.com/docs/guiding-principles [discord-badge]: https://img.shields.io/discord/723559267868737556.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square [discord]: https://discord.gg/testing-library