`html


`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()
`

$3

`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)
`

$3

`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 instead.

$3

`typescript
toHaveAccessibleDescription(expectedAccessibleDescription?: string | RegExp)
`

This allows you to assert that an element has the expected
accessible description.

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/expect.stringMatching.

#### Examples

`html
data-testid="link"
href="/"
aria-label="Home page"
title="A link to start over"
>Start>
About

src="logo.jpg"
data-testid="logo"
alt="Company logo"
aria-describedby="t1"
/>
The logo of Our Company
src="logo.jpg"
data-testid="logo2"
alt="Company logo"
aria-description="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',
)
expect(getByTestId('logo2')).toHaveAccessibleDescription(
'The logo of Our Company',
)
`

$3

`typescript
toHaveAccessibleErrorMessage(expectedAccessibleErrorMessage?: string | RegExp)
`

This allows you to assert that an element has the expected
accessible error message.

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/expect.stringMatching.

#### Examples

`html
aria-label="Has Error"
aria-invalid="true"
aria-errormessage="error-message"
/>



aria-label="Not Invalid"
aria-invalid="false"
aria-errormessage="error-message"
/>
`

`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()
`

$3

`typescript
toHaveAccessibleName(expectedAccessibleName?: string | RegExp)
`

This allows you to assert that an element has the expected
accessible name. 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/expect.stringMatching.

#### Examples

`html






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'))
`

$3

`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.

The list of class names may include strings and regular expressions. Regular
expressions are matched against each individual class in the target element, and
it is NOT matched against its full class attribute value as whole.

#### Examples

`html

Delete item

No Classes
`

`javascript
const deleteButton = getByTestId('delete-button')
const noClasses = getByTestId('no-classes')

expect(deleteButton).toHaveClass('extra')
expect(deleteButton).toHaveClass('btn-danger btn')
expect(deleteButton).toHaveClass(/danger/, 'btn')
expect(deleteButton).toHaveClass('btn-danger', 'btn')
expect(deleteButton).not.toHaveClass('btn-link')
expect(deleteButton).not.toHaveClass(/link/)
expect(deleteButton).not.toHaveClass(/btn extra/) // It does not match

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()
`

$3

`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()
`

$3

`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 do not. Here's a list
of all cases covered:

-

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 without the multiple attribute return the value as a
string corresponding to the value attribute of the selected option, or
undefined if there's no selected option.
- elements return the value as an array containing all
the values of the [selected options][].
- <code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> elements return their value as a <strong>string</strong>. The value<br /> corresponds to their node content.</p><p class="my-3">The above rules make it easy, for instance, to switch from using a single select<br />control to using a group of radio buttons. Or to switch from a multi select<br />control, to using a group of checkboxes. The resulting set of form values used<br />by this matcher to compare against would be the same.</p><p class="my-3">[selected options]:<br /> https://developer.mozilla.org/en-US/docs/Web/API/HTMLSelectElement/selectedOptions<br />[form]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement<br />[fieldset]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLFieldSetElement<br />[.elements]:<br /> https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/elements</p><p class="my-3">#### Examples</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">html<br /><form data-testid="login-form"><br /> <input type="text" name="username" value="jane.doe" /><br /> <input type="password" name="password" value="12345678" /><br /> <input type="checkbox" name="rememberMe" checked /><br /> <button type="submit">Sign in</button><br /></form><br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">javascript<br />expect(getByTestId('login-form')).toHaveFormValues({<br /> username: 'jane.doe',<br /> rememberMe: true,<br />})<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><hr /></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">typescript<br />toHaveStyle(css: string | object)<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">This allows you to check if a certain element has some specific css properties<br />with specific values applied. It matches only if the element has _all_ the<br />expected properties applied, not just some of them.</p><p class="my-3">#### Examples</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">html<br /><button<br /> data-testid="delete-button"<br /> style="display: none; background-color: red"<br />><br /> Delete item<br /></button><br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">javascript<br />const button = getByTestId('delete-button')</p><p class="my-3">expect(button).toHaveStyle('display: none')<br />expect(button).toHaveStyle({display: 'none'})<br />expect(button).toHaveStyle(</code><br /> background-color: red;<br /> display: none;<br /><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">)<br />expect(button).toHaveStyle({<br /> backgroundColor: 'red',<br /> display: 'none',<br />})<br />expect(button).not.toHaveStyle(</code><br /> background-color: blue;<br /> display: none;<br /><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">)<br />expect(button).not.toHaveStyle({<br /> backgroundColor: 'blue',<br /> display: 'none',<br />})<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">This also works with rules that are applied to the element via a class name for<br />which some rules are defined in a stylesheet currently active in the document.<br />The usual rules of css precedence apply.</p><p class="my-3"><hr /></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">typescript<br />toHaveTextContent(text: string | RegExp, options?: {normalizeWhitespace: boolean})<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">This allows you to check whether the given node has a text content or not. This<br />supports elements, but also text nodes and fragments.</p><p class="my-3">When a </code>string<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> argument is passed through, it will perform a partial<br />case-sensitive match to the node content.</p><p class="my-3">To perform a case-insensitive match, you can use a </code>RegExp<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> with the </code>/i<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"><br />modifier.</p><p class="my-3">If you want to match the whole content, you can use a </code>RegExp<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> to do it.</p><p class="my-3">#### Examples</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">html<br /><span data-testid="text-content">Text Content</span><br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">javascript<br />const element = getByTestId('text-content')</p><p class="my-3">expect(element).toHaveTextContent('Content')<br />expect(element).toHaveTextContent(/^Text Content$/) // to match the whole content<br />expect(element).toHaveTextContent(/content$/i) // to use case-insensitive match<br />expect(element).not.toHaveTextContent('content')<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><hr /></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">typescript<br />toHaveValue(value: string | string[] | number)<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">This allows you to check whether the given form element has the specified value.<br />It accepts </code><input><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">, </code><select><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> and </code><textarea><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> elements with the exception of<br /></code><input type="checkbox"><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> and </code><input type="radio"><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">, which can be meaningfully<br />matched only using <a href="#tobechecked" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer"></code>toBeChecked<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></a> or<br /><a href="#tohaveformvalues" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer"></code>toHaveFormValues<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></a>.</p><p class="my-3">It also accepts elements with roles </code>meter<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">, </code>progressbar<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">, </code>slider<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> or<br /></code>spinbutton<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> and checks their </code>aria-valuenow<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> attribute (as a number).</p><p class="my-3">For all other form elements, the value is matched using the same algorithm as in<br /><a href="#tohaveformvalues" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer"></code>toHaveFormValues<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></a> does.</p><p class="my-3">#### Examples</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">html<br /><input type="text" value="text" data-testid="input-text" /><br /><input type="number" value="5" data-testid="input-number" /><br /><input type="text" data-testid="input-empty" /><br /><select multiple data-testid="select-number"><br /> <option value="first">First Value</option><br /> <option value="second" selected>Second Value</option><br /> <option value="third" selected>Third Value</option><br /></select><br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">##### Using DOM Testing Library</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">javascript<br />const textInput = getByTestId('input-text')<br />const numberInput = getByTestId('input-number')<br />const emptyInput = getByTestId('input-empty')<br />const selectInput = getByTestId('select-number')</p><p class="my-3">expect(textInput).toHaveValue('text')<br />expect(numberInput).toHaveValue(5)<br />expect(emptyInput).not.toHaveValue()<br />expect(selectInput).toHaveValue(['second', 'third'])<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><hr /></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">typescript<br />toHaveDisplayValue(value: string | RegExp | (string|RegExp)[])<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">This allows you to check whether the given form element has the specified<br />displayed value (the one the end user will see). It accepts </code><input><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">,<br /></code><select><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> and </code><textarea><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> elements with the exception of<br /></code><input type="checkbox"><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> and </code><input type="radio"><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">, which can be meaningfully<br />matched only using <a href="#tobechecked" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer"></code>toBeChecked<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></a> or<br /><a href="#tohaveformvalues" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer"></code>toHaveFormValues<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></a>.</p><p class="my-3">#### Examples</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">html<br /><label for="input-example">First name</label><br /><input type="text" id="input-example" value="Luca" /></p><p class="my-3"><label for="textarea-example">Description</label><br /><textarea id="textarea-example">An example description here.

Fruit

Select a fruit...
Banana
Ananas
Avocado

Fruits

Select a fruit...
Banana
Ananas
Avocado

`

##### 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'])
`

$3

`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




role="checkbox"
aria-checked="false"
data-testid="aria-checkbox-unchecked"
/>











`

`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()
`

---

$3

`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






role="checkbox"
aria-checked="false"
data-testid="aria-checkbox-unchecked"
/>

`

`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()
`

---

$3

This allows you to assert that an element has the expected
role.

This is useful in cases where you already have access to an element via some
query other than the role itself, and want to make additional assertions
regarding its accessibility.

The role can match either an explicit role (via the role attribute), or an
implicit one via the
implicit ARIA semantics.

Note: roles are matched literally by string equality, without inheriting from
the ARIA role hierarchy. As a result, querying a superclass role like 'checkbox'
will not include elements with a subclass role like 'switch'.

`typescript
toHaveRole(expectedRole: string)
`

`html
Continue


Continue
Continue
About
Invalid link
`

`javascript
expect(getByTestId('button')).toHaveRole('button')
expect(getByTestId('button-explicit')).toHaveRole('button')
expect(getByTestId('button-explicit-multiple')).toHaveRole('button')
expect(getByTestId('button-explicit-multiple')).toHaveRole('switch')
expect(getByTestId('link')).toHaveRole('link')
expect(getByTestId('link-invalid')).not.toHaveRole('link')
expect(getByTestId('link-invalid')).toHaveRole('generic')
`

---

$3

> This custom matcher is deprecated. Prefer
> 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 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.

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
Please enter a start time for the meeting:
id="startTime"
type="text"
aria-errormessage="msgID"
aria-invalid="true"
value="11:30 PM"
/>

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!')
`

---

$3

This allows to check whether given element is
pressed.

It accepts elements with explicit or implicit button role and valid
aria-pressed attribute of "true" or "false".

`typescript
toBePressed()
`

#### Examples

`html
Pressed
Released




Pressed span
Released span
`

##### Using DOM Testing Library

`javascript
screen.getByRole('button', {name: 'Pressed'}).toBePressed()
screen.getByRole('button', {name: 'Released'}).not.toBePressed()

screen.getByRole('button', {name: 'Pressed input button'}).toBePressed()
screen.getByRole('button', {name: 'Released input button'}).not.toBePressed()

screen.getByRole('button', {name: 'Pressed span'}).toBePressed()
screen.getByRole('button', {name: 'Released span'}).not.toBePressed()
`

---

$3

This allows to check whether given element is partially
pressed.

It accepts elements with explicit or implicit button role and valid
aria-pressed attribute of mixed.

`typescript
toBePressed()
`

#### Examples

`html
Partially pressed
type="button"
aria-pressed="mixed"
value="Partially pressed input button"
/>
Partially pressed span
`

##### Using DOM Testing Library

`javascript
screen.getByRole('button', {name: 'Partially pressed'}).toBePartiallyPressed()
screen
.getByRole('button', {name: 'Partially pressed input button'})
.toBePartiallyPressed()
screen
.getByRole('button', {name: 'Partially pressed span'})
.toBePartiallyPressed()
`

---

$3

This checks if a given element appears before another element in the DOM tree,
as per
compareDocumentPosition().

`typescript
toAppearBefore()
`

#### Examples

`html



Text A
Text B



`

`javascript
const textA = queryByTestId('text-a')
const textB = queryByTestId('text-b')

expect(textA).toAppearBefore(textB)
expect(textB).not.toAppearBefore(textA)
`

> Note: This matcher does not take into account CSS styles that may modify the
> display order of elements, eg:
>
> - flex-direction: row-reverse,
> - flex-direction: column-reverse,
> - display: grid

$3

This checks if a given element appears after another element in the DOM tree, as
per
compareDocumentPosition().

`typescript
toAppearAfter()
`

#### Examples

`html



Text A
Text B



`

`javascript
const textA = queryByTestId('text-a')
const textB = queryByTestId('text-b')

expect(textB).toAppearAfter(textA)
expect(textA).not.toAppearAfter(textB)
`

> Note: This matcher does not take into account CSS styles that may modify the
> display order of elements, see toAppearBefore()

Deprecated matchers

$3

> 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

`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()
`

---

$3

> This custom matcher is deprecated. Prefer
> 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.

As an alternative, you can use toBeInTheDocument or
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:

`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.

---

$3

> This custom matcher is deprecated. Prefer
> 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.
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.

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
X


Closing will discard any changes

Delete
`

`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
`

---

$3

This allows to assert that an element has a
text selection.

This is useful to check if text or part of the text is selected within an
element. The element can be either an input of type text, a textarea, or any
other element that contains text, such as a paragraph, span, div etc.

NOTE: the expected selection is a string, it does not allow to check for
selection range indeces.

`typescript
toHaveSelection(expectedSelection?: string)
`

`html


text selected text

prev

text selected text

next


`

`javascript
getByTestId('text').setSelectionRange(5, 13)
expect(getByTestId('text')).toHaveSelection('selected')

getByTestId('textarea').setSelectionRange(0, 5)
expect('textarea').toHaveSelection('text ')

const selection = document.getSelection()
const range = document.createRange()
selection.removeAllRanges()
selection.empty()
selection.addRange(range)

// selection of child applies to the parent as well
range.selectNodeContents(getByTestId('child'))
expect(getByTestId('child')).toHaveSelection('selected')
expect(getByTestId('parent')).toHaveSelection('selected')

// selection that applies from prev all, parent text before child, and part child.
range.setStart(getByTestId('prev'), 0)
range.setEnd(getByTestId('child').childNodes[0], 3)
expect(queryByTestId('prev')).toHaveSelection('prev')
expect(queryByTestId('child')).toHaveSelection('sel')
expect(queryByTestId('parent')).toHaveSelection('text sel')
expect(queryByTestId('next')).not.toHaveSelection()

// selection that applies from part child, parent text after child and part next.
range.setStart(getByTestId('child').childNodes[0], 3)
range.setEnd(getByTestId('next').childNodes[0], 2)
expect(queryByTestId('child')).toHaveSelection('ected')
expect(queryByTestId('parent')).toHaveSelection('ected text')
expect(queryByTestId('prev')).not.toHaveSelection()
expect(queryByTestId('next')).toHaveSelection('ne')
`

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. 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 💻 Show more