@najemi-software/vitest-dom 0.24.0 → 0.25.0

package/esm/matchers/to-have-description.js

@@ -1,6 +1,53 @@
 import { checkHtmlElement, getMessage, normalize, deprecate } from "./utils.js";
 // See algoritm: https://www.w3.org/TR/accname-1.1/#mapping_additional_nd_description
-/** @deprecated */
+/**
+ * @deprecated
+ * since v5.14.1
+ * @description
+ * Check the accessible description for an element.
+ * 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")`.
+ *
+ * @example
+ * <button aria-label="Close" aria-describedby="description-close">
+ *   X
+ * </button>
+ * <div id="description-close">
+ *   Closing will discard any changes
+ * </div>
+ *
+ * <button>Delete</button>
+ *
+ * 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
+ * @see
+ * [testing-library/jest-dom#tohavedescription](https://github.com/testing-library/jest-dom#tohavedescription)
+ */
 export function toHaveDescription(htmlElement, checkWith) {
     deprecate("toHaveDescription", "Please use toHaveAccessibleDescription.");
     checkHtmlElement(htmlElement, toHaveDescription, this);

package/esm/matchers/to-have-description.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-have-description.js","sourceRoot":"","sources":["../../src/matchers/to-have-description.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEhF,qFAAqF;AACrF,kBAAkB;AAClB,MAAM,UAAU,iBAAiB,CAE7B,WAAoB,EACpB,SAA4D;IAE5D,SAAS,CAAC,mBAAmB,EAAE,yCAAyC,CAAC,CAAC;IAE1E,gBAAgB,CAAC,WAAW,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAEvD,MAAM,kBAAkB,GAAG,SAAS,KAAK,SAAS,CAAC;IAEnD,MAAM,gBAAgB,GAAG,WAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC;IAC5E,MAAM,cAAc,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACrE,IAAI,WAAW,GAAG,EAAE,CAAC;IACrB,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC;QAC3C,MAAM,cAAc,GAAG,cAAc;aAChC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;aAC9D,MAAM,CAAC,CAAC,EAAE,EAAqB,EAAE,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;QACpD,WAAW,GAAG,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClF,CAAC;IAED,OAAO;QACH,IAAI,EAAE,kBAAkB;YACpB,CAAC,CAAC,SAAS,YAAY,MAAM;gBACzB,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC;gBAC7B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC;YACzC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;QAC1B,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,SAAS,EAAE,EAAE,CAAC,EACtF,wBAAwB,EAAE,mBAAmB,EAC7C,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,EACnC,UAAU,EACV,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CACxC,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-description.js","sourceRoot":"","sources":["../../src/matchers/to-have-description.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEhF,qFAAqF;AACrF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,UAAU,iBAAiB,CAE7B,WAAoB,EACpB,SAA4D;IAE5D,SAAS,CAAC,mBAAmB,EAAE,yCAAyC,CAAC,CAAC;IAE1E,gBAAgB,CAAC,WAAW,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAEvD,MAAM,kBAAkB,GAAG,SAAS,KAAK,SAAS,CAAC;IAEnD,MAAM,gBAAgB,GAAG,WAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC;IAC5E,MAAM,cAAc,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACrE,IAAI,WAAW,GAAG,EAAE,CAAC;IACrB,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC;QAC3C,MAAM,cAAc,GAAG,cAAc;aAChC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;aAC9D,MAAM,CAAC,CAAC,EAAE,EAAqB,EAAE,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;QACpD,WAAW,GAAG,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClF,CAAC;IAED,OAAO;QACH,IAAI,EAAE,kBAAkB;YACpB,CAAC,CAAC,SAAS,YAAY,MAAM;gBACzB,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC;gBAC7B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC;YACzC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;QAC1B,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,SAAS,EAAE,EAAE,CAAC,EACtF,wBAAwB,EAAE,mBAAmB,EAC7C,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,EACnC,UAAU,EACV,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CACxC,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-have-display-value.d.ts

@@ -1,2 +1,43 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * This allows you to check whether the given form element has the specified displayed value (the one the
+ * end user will see). It accepts <input>, <select> and <textarea> elements with the exception of <input type="checkbox">
+ * and <input type="radio">, which can be meaningfully matched only using toBeChecked or toHaveFormValues.
+ * @example
+ * <label for="input-example">First name</label>
+ * <input type="text" id="input-example" value="Luca" />
+ *
+ * <label for="textarea-example">Description</label>
+ * <textarea id="textarea-example">An example description here.</textarea>
+ *
+ * <label for="single-select-example">Fruit</label>
+ * <select id="single-select-example">
+ *   <option value="">Select a fruit...</option>
+ *   <option value="banana">Banana</option>
+ *   <option value="ananas">Ananas</option>
+ *   <option value="avocado">Avocado</option>
+ * </select>
+ *
+ * <label for="mutiple-select-example">Fruits</label>
+ * <select id="multiple-select-example" multiple>
+ *   <option value="">Select a fruit...</option>
+ *   <option value="banana" selected>Banana</option>
+ *   <option value="ananas">Ananas</option>
+ *   <option value="avocado" selected>Avocado</option>
+ * </select>
+ *
+ * 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(textarea).toHaveDisplayValue('An example description here.')
+ * expect(selectSingle).toHaveDisplayValue('Select a fruit...')
+ * expect(selectMultiple).toHaveDisplayValue(['Banana', 'Avocado'])
+ *
+ * @see
+ * [testing-library/jest-dom#tohavedisplayvalue](https://github.com/testing-library/jest-dom#tohavedisplayvalue)
+ */
 export declare function toHaveDisplayValue(this: MatcherState, htmlElement: Element, expectedValue: string | RegExp | Array<string | RegExp>): MatcherResult;

package/esm/matchers/to-have-display-value.js

@@ -1,4 +1,45 @@
 import { checkHtmlElement, getMessage } from "./utils.js";
+/**
+ * @description
+ * This allows you to check whether the given form element has the specified displayed value (the one the
+ * end user will see). It accepts <input>, <select> and <textarea> elements with the exception of <input type="checkbox">
+ * and <input type="radio">, which can be meaningfully matched only using toBeChecked or toHaveFormValues.
+ * @example
+ * <label for="input-example">First name</label>
+ * <input type="text" id="input-example" value="Luca" />
+ *
+ * <label for="textarea-example">Description</label>
+ * <textarea id="textarea-example">An example description here.</textarea>
+ *
+ * <label for="single-select-example">Fruit</label>
+ * <select id="single-select-example">
+ *   <option value="">Select a fruit...</option>
+ *   <option value="banana">Banana</option>
+ *   <option value="ananas">Ananas</option>
+ *   <option value="avocado">Avocado</option>
+ * </select>
+ *
+ * <label for="mutiple-select-example">Fruits</label>
+ * <select id="multiple-select-example" multiple>
+ *   <option value="">Select a fruit...</option>
+ *   <option value="banana" selected>Banana</option>
+ *   <option value="ananas">Ananas</option>
+ *   <option value="avocado" selected>Avocado</option>
+ * </select>
+ *
+ * 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(textarea).toHaveDisplayValue('An example description here.')
+ * expect(selectSingle).toHaveDisplayValue('Select a fruit...')
+ * expect(selectMultiple).toHaveDisplayValue(['Banana', 'Avocado'])
+ *
+ * @see
+ * [testing-library/jest-dom#tohavedisplayvalue](https://github.com/testing-library/jest-dom#tohavedisplayvalue)
+ */
 export function toHaveDisplayValue(htmlElement, expectedValue) {
     checkHtmlElement(htmlElement, toHaveDisplayValue, this);
     const tagName = htmlElement.tagName.toLowerCase();

package/esm/matchers/to-have-display-value.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-have-display-value.js","sourceRoot":"","sources":["../../src/matchers/to-have-display-value.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D,MAAM,UAAU,kBAAkB,CAE9B,WAAoB,EACpB,aAAuD;IAEvD,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,EAAE,IAAI,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IAElD,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CACX,qHAAqH,CACxH,CAAC;IACN,CAAC;IAED,IAAI,OAAO,KAAK,OAAO,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAE,WAAgC,CAAC,IAAI,CAAC,EAAE,CAAC;QAChG,MAAM,IAAI,KAAK,CACX,gEAAiE,WAAgC,CAAC,IAAI,uCAAuC,CAChJ,CAAC;IACN,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC/C,MAAM,cAAc,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IACxD,MAAM,yBAAyB,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CACjE,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAClB,QAAQ,YAAY,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAC3F,CACJ,CAAC,MAAM,CAAC;IAET,MAAM,oBAAoB,GAAG,yBAAyB,KAAK,MAAM,CAAC,MAAM,CAAC;IACzE,MAAM,4BAA4B,GAAG,yBAAyB,KAAK,cAAc,CAAC,MAAM,CAAC;IAEzF,OAAO;QACH,IAAI,EAAE,oBAAoB,IAAI,4BAA4B;QAC1D,OAAO,EAAE,GAAG,EAAE,CACV,UAAU,CACN,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,SAAS,EAAE,EAAE,CAAC,EACvF,oBAAoB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,uBAAuB,EACnE,aAAa,EACb,UAAU,EACV,MAAM,CACT;KACR,CAAC;AACN,CAAC;AAED,SAAS,SAAS,CAAC,OAAe,EAAE,WAAoB;IACpD,OAAO,OAAO,KAAK,QAAQ;QACvB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAE,WAAiC,CAAC,OAAO,CAAC;aACjD,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;aACnC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC;QAChD,CAAC,CAAC,CAAE,WAAsD,CAAC,KAAK,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,iBAAiB,CAAC,aAAuD;IAC9E,OAAO,aAAa,YAAY,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;AAC5E,CAAC"}
+{"version":3,"file":"to-have-display-value.js","sourceRoot":"","sources":["../../src/matchers/to-have-display-value.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,UAAU,kBAAkB,CAE9B,WAAoB,EACpB,aAAuD;IAEvD,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,EAAE,IAAI,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IAElD,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CACX,qHAAqH,CACxH,CAAC;IACN,CAAC;IAED,IAAI,OAAO,KAAK,OAAO,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAE,WAAgC,CAAC,IAAI,CAAC,EAAE,CAAC;QAChG,MAAM,IAAI,KAAK,CACX,gEAAiE,WAAgC,CAAC,IAAI,uCAAuC,CAChJ,CAAC;IACN,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC/C,MAAM,cAAc,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IACxD,MAAM,yBAAyB,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CACjE,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAClB,QAAQ,YAAY,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAC3F,CACJ,CAAC,MAAM,CAAC;IAET,MAAM,oBAAoB,GAAG,yBAAyB,KAAK,MAAM,CAAC,MAAM,CAAC;IACzE,MAAM,4BAA4B,GAAG,yBAAyB,KAAK,cAAc,CAAC,MAAM,CAAC;IAEzF,OAAO;QACH,IAAI,EAAE,oBAAoB,IAAI,4BAA4B;QAC1D,OAAO,EAAE,GAAG,EAAE,CACV,UAAU,CACN,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,SAAS,EAAE,EAAE,CAAC,EACvF,oBAAoB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,uBAAuB,EACnE,aAAa,EACb,UAAU,EACV,MAAM,CACT;KACR,CAAC;AACN,CAAC;AAED,SAAS,SAAS,CAAC,OAAe,EAAE,WAAoB;IACpD,OAAO,OAAO,KAAK,QAAQ;QACvB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAE,WAAiC,CAAC,OAAO,CAAC;aACjD,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;aACnC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC;QAChD,CAAC,CAAC,CAAE,WAAsD,CAAC,KAAK,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,iBAAiB,CAAC,aAAuD;IAC9E,OAAO,aAAa,YAAY,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;AAC5E,CAAC"}

package/esm/matchers/to-have-errormessage.d.ts

@@ -1,3 +1,43 @@
 import type { expect } from "vitest";
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ *
+ * 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 the
+ * [`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")`.
+ *
+ * @example
+ * <label for="startTime"> Please enter a start time for the meeting: </label>
+ * <input id="startTime" type="text" aria-errormessage="msgID" aria-invalid="true" value="11:30 PM" />
+ * <span id="msgID" aria-live="assertive" style="visibility:visible">
+ *   Invalid time: the time must be between 9:00 AM and 5:00 PM"
+ * </span>
+ *
+ *
+ * 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!')
+ * @see
+ * [testing-library/jest-dom#tohaveerrormessage](https://github.com/testing-library/jest-dom#tohaveerrormessage)
+ */
 export declare function toHaveErrorMessage(this: MatcherState, htmlElement: Element, checkWith?: string | RegExp | typeof expect.stringContaining): MatcherResult;

package/esm/matchers/to-have-errormessage.js

@@ -1,5 +1,45 @@
 import { checkHtmlElement, getMessage, normalize } from "./utils.js";
 // See aria-errormessage spec https://www.w3.org/TR/wai-aria-1.2/#aria-errormessage
+/**
+ * @description
+ *
+ * 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 the
+ * [`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")`.
+ *
+ * @example
+ * <label for="startTime"> Please enter a start time for the meeting: </label>
+ * <input id="startTime" type="text" aria-errormessage="msgID" aria-invalid="true" value="11:30 PM" />
+ * <span id="msgID" aria-live="assertive" style="visibility:visible">
+ *   Invalid time: the time must be between 9:00 AM and 5:00 PM"
+ * </span>
+ *
+ *
+ * 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!')
+ * @see
+ * [testing-library/jest-dom#tohaveerrormessage](https://github.com/testing-library/jest-dom#tohaveerrormessage)
+ */
 export function toHaveErrorMessage(htmlElement, checkWith) {
     checkHtmlElement(htmlElement, toHaveErrorMessage, this);
     if (!htmlElement.hasAttribute("aria-invalid") || htmlElement.getAttribute("aria-invalid") === "false") {

package/esm/matchers/to-have-errormessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-have-errormessage.js","sourceRoot":"","sources":["../../src/matchers/to-have-errormessage.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAErE,mFAAmF;AACnF,MAAM,UAAU,kBAAkB,CAE9B,WAAoB,EACpB,SAA4D;IAE5D,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,EAAE,IAAI,CAAC,CAAC;IAExD,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,OAAO,EAAE,CAAC;QACpG,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAErC,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE;gBACV,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,GAAG,qBAAqB,EAAE,SAAS,EAAE,EAAE,CAAC,EAClE,yDAAyD,EACzD,qBAAqB,EACrB,UAAU,EACV,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC;oBACpC,CAAC,CAAC,iBAAiB,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG;oBAC9D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CACrC,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,MAAM,mBAAmB,GAAG,SAAS,KAAK,SAAS,CAAC;IAEpD,MAAM,iBAAiB,GAAG,WAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;IAC9E,MAAM,eAAe,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEvE,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC;QAE3C,MAAM,eAAe,GAAG,eAAe;aAClC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;aAChE,MAAM,CAAC,CAAC,EAAE,EAAqB,EAAE,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;QAEpD,YAAY,GAAG,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACpF,CAAC;IAED,OAAO;QACH,IAAI,EAAE,mBAAmB;YACrB,CAAC,CAAC,SAAS,YAAY,MAAM;gBACzB,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC9B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC;YAC1C,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;QAC3B,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,SAAS,EAAE,EAAE,CAAC,EACvF,wBAAwB,EAAE,qBAAqB,EAC/C,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,EACnC,UAAU,EACV,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,CACzC,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-errormessage.js","sourceRoot":"","sources":["../../src/matchers/to-have-errormessage.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAErE,mFAAmF;AACnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,UAAU,kBAAkB,CAE9B,WAAoB,EACpB,SAA4D;IAE5D,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,EAAE,IAAI,CAAC,CAAC;IAExD,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,OAAO,EAAE,CAAC;QACpG,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAErC,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE;gBACV,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,GAAG,qBAAqB,EAAE,SAAS,EAAE,EAAE,CAAC,EAClE,yDAAyD,EACzD,qBAAqB,EACrB,UAAU,EACV,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC;oBACpC,CAAC,CAAC,iBAAiB,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG;oBAC9D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CACrC,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,MAAM,mBAAmB,GAAG,SAAS,KAAK,SAAS,CAAC;IAEpD,MAAM,iBAAiB,GAAG,WAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;IAC9E,MAAM,eAAe,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEvE,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC;QAE3C,MAAM,eAAe,GAAG,eAAe;aAClC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;aAChE,MAAM,CAAC,CAAC,EAAE,EAAqB,EAAE,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;QAEpD,YAAY,GAAG,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACpF,CAAC;IAED,OAAO;QACH,IAAI,EAAE,mBAAmB;YACrB,CAAC,CAAC,SAAS,YAAY,MAAM;gBACzB,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC9B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC;YAC1C,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;QAC3B,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,SAAS,EAAE,EAAE,CAAC,EACvF,wBAAwB,EAAE,qBAAqB,EAC/C,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,EACnC,UAAU,EACV,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,CACzC,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-have-focus.d.ts

@@ -1,2 +1,18 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Assert whether an element has focus or not.
+ * @example
+ * <div>
+ *   <input type="text" data-testid="element-to-focus" />
+ * </div>
+ *
+ * const input = getByTestId('element-to-focus')
+ * input.focus()
+ * expect(input).toHaveFocus()
+ * input.blur()
+ * expect(input).not.toHaveFocus()
+ * @see
+ * [testing-library/jest-dom#tohavefocus](https://github.com/testing-library/jest-dom#tohavefocus)
+ */
 export declare function toHaveFocus(this: MatcherState, element: Element): MatcherResult;

package/esm/matchers/to-have-focus.js

@@ -1,4 +1,20 @@
 import { checkHtmlElement } from "./utils.js";
+/**
+ * @description
+ * Assert whether an element has focus or not.
+ * @example
+ * <div>
+ *   <input type="text" data-testid="element-to-focus" />
+ * </div>
+ *
+ * const input = getByTestId('element-to-focus')
+ * input.focus()
+ * expect(input).toHaveFocus()
+ * input.blur()
+ * expect(input).not.toHaveFocus()
+ * @see
+ * [testing-library/jest-dom#tohavefocus](https://github.com/testing-library/jest-dom#tohavefocus)
+ */
 export function toHaveFocus(element) {
     checkHtmlElement(element, toHaveFocus, this);
     return {

package/esm/matchers/to-have-focus.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-have-focus.js","sourceRoot":"","sources":["../../src/matchers/to-have-focus.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAE7C,OAAO;QACH,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,KAAK,OAAO;QACrD,OAAO,EAAE,GAAG,EAAE;YACV,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,CAAC;gBAChF,EAAE;gBACF,GAAG,CAAC,IAAI,CAAC,KAAK;oBACV,CAAC,CAAC,CAAC,8BAA8B,EAAE,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC5E,CAAC,CAAC;wBACI,8BAA8B;wBAC9B,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;wBACxC,8BAA8B;wBAC9B,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE;qBACvE,CAAC;aACX,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-focus.js","sourceRoot":"","sources":["../../src/matchers/to-have-focus.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAE7C,OAAO;QACH,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,KAAK,OAAO;QACrD,OAAO,EAAE,GAAG,EAAE;YACV,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,CAAC;gBAChF,EAAE;gBACF,GAAG,CAAC,IAAI,CAAC,KAAK;oBACV,CAAC,CAAC,CAAC,8BAA8B,EAAE,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC5E,CAAC,CAAC;wBACI,8BAA8B;wBAC9B,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;wBACxC,8BAA8B;wBAC9B,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE;qBACvE,CAAC;aACX,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-have-form-values.d.ts

@@ -1,2 +1,22 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Check if a form or fieldset contains form controls for each given name, and having the specified value.
+ *
+ * Can only be invoked on a form or fieldset element.
+ * @example
+ * <form data-testid="login-form">
+ *   <input type="text" name="username" value="jane.doe" />
+ *   <input type="password" name="password" value="123" />
+ *   <input type="checkbox" name="rememberMe" checked />
+ *   <button type="submit">Sign in</button>
+ * </form>
+ *
+ * expect(getByTestId('login-form')).toHaveFormValues({
+ *   username: 'jane.doe',
+ *   rememberMe: true,
+ * })
+ * @see
+ * [testing-library/jest-dom#tohaveformvalues](https://github.com/testing-library/jest-dom#tohaveformvalues)
+ */
 export declare function toHaveFormValues(this: MatcherState, formElement: Element, expectedValues: Record<string, unknown>): MatcherResult;

package/esm/matchers/to-have-form-values.js

@@ -40,6 +40,26 @@ function getAllFormValues(container) {
         [getPureName(name)]: getFormValue(container, name),
     }), {});
 }
+/**
+ * @description
+ * Check if a form or fieldset contains form controls for each given name, and having the specified value.
+ *
+ * Can only be invoked on a form or fieldset element.
+ * @example
+ * <form data-testid="login-form">
+ *   <input type="text" name="username" value="jane.doe" />
+ *   <input type="password" name="password" value="123" />
+ *   <input type="checkbox" name="rememberMe" checked />
+ *   <button type="submit">Sign in</button>
+ * </form>
+ *
+ * expect(getByTestId('login-form')).toHaveFormValues({
+ *   username: 'jane.doe',
+ *   rememberMe: true,
+ * })
+ * @see
+ * [testing-library/jest-dom#tohaveformvalues](https://github.com/testing-library/jest-dom#tohaveformvalues)
+ */
 export function toHaveFormValues(formElement, expectedValues) {
     checkHtmlElement(formElement, toHaveFormValues, this);
     if (!formElement.elements) {

package/esm/matchers/to-have-form-values.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-have-form-values.js","sourceRoot":"","sources":["../../src/matchers/to-have-form-values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAG9C,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAQzF,SAAS,oBAAoB,CAAC,QAA4B;IACtD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;IAC1F,CAAC;IACD,QAAQ,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACf,KAAK,OAAO,CAAC,CAAC,CAAC;YACX,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7D,OAAO,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,CAAC;QACD,KAAK,UAAU;YACX,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC7F;YACI,oEAAoE;YACpE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;AACL,CAAC;AAUD,SAAS,YAAY,CAAC,SAAgD,EAAE,IAAY;IAChF,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CACpE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,IAAI,CACpC,CAAC;IACnB,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC,CAAC,qCAAqC;IAC3D,CAAC;IACD,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,CAAC;YACF,OAAO,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C;YACI,OAAO,oBAAoB,CAAC,QAA8B,CAAC,CAAC;IACpE,CAAC;AACL,CAAC;AAED,+CAA+C;AAC/C,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzD,CAAC;AAED,SAAS,gBAAgB,CAAC,SAAgD;IACtE,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAE,OAA4B,CAAC,IAAI,CAAC,CAAC;IAClG,OAAO,KAAK,CAAC,MAAM,CACf,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACZ,GAAG,GAAG;QACN,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC;KACrD,CAAC,EACF,EAAE,CACL,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gBAAgB,CAE5B,WAAoB,EACpB,cAAuC;IAEvC,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACtD,IAAI,CAAE,WAAqD,CAAC,QAAQ,EAAE,CAAC;QACnE,2FAA2F;QAC3F,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAC/E,CAAC;IACD,MAAM,UAAU,GAAG,gBAAgB,CAAC,WAAoD,CAAC,CAAC;IAC1F,OAAO;QACH,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,EAAE,CACjE,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,kBAAkB,CAAC,CACnE;QACD,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC;YAC/D,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;iBAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;iBACnD,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACpE,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC;gBAC9C,wBAAwB,EAAE,mBAAmB;gBAC7C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC;aACnD,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-form-values.js","sourceRoot":"","sources":["../../src/matchers/to-have-form-values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAG9C,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAQzF,SAAS,oBAAoB,CAAC,QAA4B;IACtD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;IAC1F,CAAC;IACD,QAAQ,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACf,KAAK,OAAO,CAAC,CAAC,CAAC;YACX,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7D,OAAO,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,CAAC;QACD,KAAK,UAAU;YACX,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC7F;YACI,oEAAoE;YACpE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;AACL,CAAC;AAUD,SAAS,YAAY,CAAC,SAAgD,EAAE,IAAY;IAChF,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CACpE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,IAAI,CACpC,CAAC;IACnB,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC,CAAC,qCAAqC;IAC3D,CAAC;IACD,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,CAAC;YACF,OAAO,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C;YACI,OAAO,oBAAoB,CAAC,QAA8B,CAAC,CAAC;IACpE,CAAC;AACL,CAAC;AAED,+CAA+C;AAC/C,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzD,CAAC;AAED,SAAS,gBAAgB,CAAC,SAAgD;IACtE,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAE,OAA4B,CAAC,IAAI,CAAC,CAAC;IAClG,OAAO,KAAK,CAAC,MAAM,CACf,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACZ,GAAG,GAAG;QACN,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC;KACrD,CAAC,EACF,EAAE,CACL,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,gBAAgB,CAE5B,WAAoB,EACpB,cAAuC;IAEvC,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACtD,IAAI,CAAE,WAAqD,CAAC,QAAQ,EAAE,CAAC;QACnE,2FAA2F;QAC3F,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAC/E,CAAC;IACD,MAAM,UAAU,GAAG,gBAAgB,CAAC,WAAoD,CAAC,CAAC;IAC1F,OAAO;QACH,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,EAAE,CACjE,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,kBAAkB,CAAC,CACnE;QACD,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC;YAC/D,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;iBAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;iBACnD,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACpE,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC;gBAC9C,wBAAwB,EAAE,mBAAmB;gBAC7C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC;aACnD,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-have-style.d.ts

@@ -1,2 +1,24 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Check if an element has specific css properties with specific values applied.
+ *
+ * Only matches if the element has *all* the expected properties applied, not just some of them.
+ * @example
+ * <button
+ *   data-test-id="submit-button"
+ *   style="background-color: green; display: none"
+ * >
+ *   submit
+ * </button>
+ *
+ * const button = getByTestId('submit-button')
+ * expect(button).toHaveStyle('background-color: green')
+ * expect(button).toHaveStyle({
+ *   'background-color': 'green',
+ *   display: 'none'
+ * })
+ * @see
+ * [testing-library/jest-dom#tohavestyle](https://github.com/testing-library/jest-dom#tohavestyle)
+ */
 export declare function toHaveStyle(this: MatcherState, htmlElement: Element, css: string | Record<string, unknown>): MatcherResult;

package/esm/matchers/to-have-style.js

@@ -46,6 +46,28 @@ function expectedDiff(diffFn, expected, computedStyles) {
     // Remove the "+ Received" annotation because this is a one-way diff
     return (diffOutput ?? "").replace(`${chalk.red("+ Received")}\n`, "");
 }
+/**
+ * @description
+ * Check if an element has specific css properties with specific values applied.
+ *
+ * Only matches if the element has *all* the expected properties applied, not just some of them.
+ * @example
+ * <button
+ *   data-test-id="submit-button"
+ *   style="background-color: green; display: none"
+ * >
+ *   submit
+ * </button>
+ *
+ * const button = getByTestId('submit-button')
+ * expect(button).toHaveStyle('background-color: green')
+ * expect(button).toHaveStyle({
+ *   'background-color': 'green',
+ *   display: 'none'
+ * })
+ * @see
+ * [testing-library/jest-dom#tohavestyle](https://github.com/testing-library/jest-dom#tohavestyle)
+ */
 export function toHaveStyle(htmlElement, css) {
     checkHtmlElement(htmlElement, toHaveStyle, this);
     const parsedCSS = typeof css === "object" ? css : parseCSS(css, toHaveStyle, this);

package/esm/matchers/to-have-style.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-have-style.js","sourceRoot":"","sources":["../../src/matchers/to-have-style.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAIxD,+EAA+E;AAC/E,6EAA6E;AAC7E,SAAS,QAAQ,CAAC,KAA0B;IACxC,OAAO,KAA0B,CAAC;AACtC,CAAC;AAED,SAAS,mBAAmB,CAAC,QAAkB,EAAE,GAAW;IACxD,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,kDAAkD;IAClD,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClC,SAAS,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpC,+DAA+D;QAC/D,qEAAqE;QACrE,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;YAClE,SAAS,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC/C,CAAC;QACD,kEAAkE;QAClE,oEAAoE;QACpE,+DAA+D;QAC/D,sDAAsD;QACtD,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,QAAQ,CAAC,MAAc,EAAE,aAAkC;IAChE,OAAO,CACH,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM;QAC5B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CACxB,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CACd,QAAQ,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK;YACvC,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,KAAK,CACnE,CACJ,CAAC;AACN,CAAC;AAED,SAAS,cAAc,CAAC,MAAc;IAClC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACrB,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;SAC1C,IAAI,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC;AAED,2EAA2E;AAC3E,2BAA2B;AAC3B,SAAS,YAAY,CACjB,MAAqC,EACrC,QAAgB,EAChB,cAAmC;IAEnC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC;SACtC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC;SAC9C,MAAM,CACH,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,EACpF,EAAE,CACL,CAAC;IACN,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9E,oEAAoE;IACpE,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,WAAW,CAEvB,WAAoB,EACpB,GAAqC;IAErC,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACnF,MAAM,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC;IAEnE,MAAM,QAAQ,GAAG,mBAAmB,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC3E,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAE/C,OAAO;QACH,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAClC,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC;YAC1D,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC;gBAC9C,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC;aACpD,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-style.js","sourceRoot":"","sources":["../../src/matchers/to-have-style.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAIxD,+EAA+E;AAC/E,6EAA6E;AAC7E,SAAS,QAAQ,CAAC,KAA0B;IACxC,OAAO,KAA0B,CAAC;AACtC,CAAC;AAED,SAAS,mBAAmB,CAAC,QAAkB,EAAE,GAAW;IACxD,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,kDAAkD;IAClD,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClC,SAAS,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpC,+DAA+D;QAC/D,qEAAqE;QACrE,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;YAClE,SAAS,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC/C,CAAC;QACD,kEAAkE;QAClE,oEAAoE;QACpE,+DAA+D;QAC/D,sDAAsD;QACtD,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,QAAQ,CAAC,MAAc,EAAE,aAAkC;IAChE,OAAO,CACH,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM;QAC5B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CACxB,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CACd,QAAQ,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK;YACvC,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,KAAK,CACnE,CACJ,CAAC;AACN,CAAC;AAED,SAAS,cAAc,CAAC,MAAc;IAClC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACrB,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;SAC1C,IAAI,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC;AAED,2EAA2E;AAC3E,2BAA2B;AAC3B,SAAS,YAAY,CACjB,MAAqC,EACrC,QAAgB,EAChB,cAAmC;IAEnC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC;SACtC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC;SAC9C,MAAM,CACH,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,EACpF,EAAE,CACL,CAAC;IACN,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9E,oEAAoE;IACpE,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,WAAW,CAEvB,WAAoB,EACpB,GAAqC;IAErC,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACnF,MAAM,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC;IAEnE,MAAM,QAAQ,GAAG,mBAAmB,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC3E,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAE/C,OAAO;QACH,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAClC,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC;YAC1D,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC;gBAC9C,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC;aACpD,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-have-text-content.d.ts

@@ -1,4 +1,27 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Check whether the given element has a text content or not.
+ *
+ * When a string argument is passed through, it will perform a partial case-sensitive match to the element
+ * content.
+ *
+ * To perform a case-insensitive match, you can use a RegExp with the `/i` modifier.
+ *
+ * If you want to match the whole content, you can use a RegExp to do it.
+ * @example
+ * <span data-testid="text-content">Text Content</span>
+ *
+ * const element = getByTestId('text-content')
+ * expect(element).toHaveTextContent('Content')
+ * // to match the whole content
+ * expect(element).toHaveTextContent(/^Text Content$/)
+ * // to use case-insentive match
+ * expect(element).toHaveTextContent(/content$/i)
+ * expect(element).not.toHaveTextContent('content')
+ * @see
+ * [testing-library/jest-dom#tohavetextcontent](https://github.com/testing-library/jest-dom#tohavetextcontent)
+ */
 export declare function toHaveTextContent(this: MatcherState, node: Element, checkWith: string | RegExp, options?: {
     normalizeWhitespace: boolean;
 }): MatcherResult;

package/esm/matchers/to-have-text-content.js

@@ -1,4 +1,27 @@
 import { getMessage, checkNode, matches, normalize } from "./utils.js";
+/**
+ * @description
+ * Check whether the given element has a text content or not.
+ *
+ * When a string argument is passed through, it will perform a partial case-sensitive match to the element
+ * content.
+ *
+ * To perform a case-insensitive match, you can use a RegExp with the `/i` modifier.
+ *
+ * If you want to match the whole content, you can use a RegExp to do it.
+ * @example
+ * <span data-testid="text-content">Text Content</span>
+ *
+ * const element = getByTestId('text-content')
+ * expect(element).toHaveTextContent('Content')
+ * // to match the whole content
+ * expect(element).toHaveTextContent(/^Text Content$/)
+ * // to use case-insentive match
+ * expect(element).toHaveTextContent(/content$/i)
+ * expect(element).not.toHaveTextContent('content')
+ * @see
+ * [testing-library/jest-dom#tohavetextcontent](https://github.com/testing-library/jest-dom#tohavetextcontent)
+ */
 export function toHaveTextContent(node, checkWith, options = { normalizeWhitespace: true }) {
     checkNode(node, toHaveTextContent, this);
     const textContent = options.normalizeWhitespace

package/esm/matchers/to-have-text-content.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-have-text-content.js","sourceRoot":"","sources":["../../src/matchers/to-have-text-content.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvE,MAAM,UAAU,iBAAiB,CAE7B,IAAa,EACb,SAA0B,EAC1B,UAA4C,EAAE,mBAAmB,EAAE,IAAI,EAAE;IAEzE,SAAS,CAAC,IAAI,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAEzC,MAAM,WAAW,GAAG,OAAO,CAAC,mBAAmB;QAC3C,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC;QAC7B,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,oCAAoC;IAEpF,MAAM,uBAAuB,GAAG,WAAW,KAAK,EAAE,IAAI,SAAS,KAAK,EAAE,CAAC;IAEvE,OAAO;QACH,IAAI,EAAE,CAAC,uBAAuB,IAAI,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC;QACjE,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,SAAS,EAAE,EAAE,CAAC,EACtF,uBAAuB;gBACnB,CAAC,CAAC,kFAAkF;gBACpF,CAAC,CAAC,oBAAoB,EAAE,oBAAoB,EAChD,SAAS,EACT,UAAU,EACV,WAAW,CACd,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-text-content.js","sourceRoot":"","sources":["../../src/matchers/to-have-text-content.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,iBAAiB,CAE7B,IAAa,EACb,SAA0B,EAC1B,UAA4C,EAAE,mBAAmB,EAAE,IAAI,EAAE;IAEzE,SAAS,CAAC,IAAI,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAEzC,MAAM,WAAW,GAAG,OAAO,CAAC,mBAAmB;QAC3C,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC;QAC7B,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,oCAAoC;IAEpF,MAAM,uBAAuB,GAAG,WAAW,KAAK,EAAE,IAAI,SAAS,KAAK,EAAE,CAAC;IAEvE,OAAO;QACH,IAAI,EAAE,CAAC,uBAAuB,IAAI,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC;QACjE,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,SAAS,EAAE,EAAE,CAAC,EACtF,uBAAuB;gBACnB,CAAC,CAAC,kFAAkF;gBACpF,CAAC,CAAC,oBAAoB,EAAE,oBAAoB,EAChD,SAAS,EACT,UAAU,EACV,WAAW,CACd,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-have-value.d.ts

@@ -1,2 +1,21 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Check whether the given form element has the specified value.
+ *
+ * Accepts `<input>`, `<select>`, and `<textarea>` elements with the exception of `<input type="checkbox">` and
+ * `<input type="radiobox">`, which can be matched only using
+ * [toBeChecked](https://github.com/testing-library/jest-dom#tobechecked) or
+ * [toHaveFormValues](https://github.com/testing-library/jest-dom#tohaveformvalues).
+ * @example
+ * <input
+ *   type="number"
+ *   value="5"
+ *   data-testid="input-number" />
+ *
+ * const numberInput = getByTestId('input-number')
+ * expect(numberInput).toHaveValue(5)
+ * @see
+ * [testing-library/jest-dom#tohavevalue](https://github.com/testing-library/jest-dom#tohavevalue)
+ */
 export declare function toHaveValue(this: MatcherState, htmlElement: Element, expectedValue?: string | string[] | number | null): MatcherResult;

package/esm/matchers/to-have-value.js

@@ -1,5 +1,24 @@
 import { isEqualWith } from "lodash-es";
 import { checkHtmlElement, compareArraysAsSet, getMessage, getSingleElementValue } from "./utils.js";
+/**
+ * @description
+ * Check whether the given form element has the specified value.
+ *
+ * Accepts `<input>`, `<select>`, and `<textarea>` elements with the exception of `<input type="checkbox">` and
+ * `<input type="radiobox">`, which can be matched only using
+ * [toBeChecked](https://github.com/testing-library/jest-dom#tobechecked) or
+ * [toHaveFormValues](https://github.com/testing-library/jest-dom#tohaveformvalues).
+ * @example
+ * <input
+ *   type="number"
+ *   value="5"
+ *   data-testid="input-number" />
+ *
+ * const numberInput = getByTestId('input-number')
+ * expect(numberInput).toHaveValue(5)
+ * @see
+ * [testing-library/jest-dom#tohavevalue](https://github.com/testing-library/jest-dom#tohavevalue)
+ */
 export function toHaveValue(htmlElement, expectedValue) {
     checkHtmlElement(htmlElement, toHaveValue, this);
     if (htmlElement.tagName.toLowerCase() === "input" &&

package/esm/matchers/to-have-value.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-have-value.js","sourceRoot":"","sources":["../../src/matchers/to-have-value.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAGxC,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAErG,MAAM,UAAU,WAAW,CAEvB,WAAoB,EACpB,aAAiD;IAEjD,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAEjD,IACI,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO;QAC7C,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAE,WAAgC,CAAC,IAAI,CAAC,EACxE,CAAC;QACC,MAAM,IAAI,KAAK,CACX,gJAAgJ,CACnJ,CAAC;IACN,CAAC;IAED,MAAM,aAAa,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,aAAa,KAAK,SAAS,CAAC;IAEjD,IAAI,kBAAkB,GAAG,aAAa,CAAC;IACvC,IAAI,kBAAkB,GAAG,aAAa,CAAC;IACvC,IAAI,aAAa,IAAI,aAAa,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;QACpE,kBAAkB,GAAG,GAAG,aAAa,KAAK,OAAO,aAAa,GAAG,CAAC;QAClE,kBAAkB,GAAG,GAAG,aAAa,KAAK,OAAO,aAAa,GAAG,CAAC;IACtE,CAAC;IAED,OAAO;QACH,IAAI,EAAE,YAAY;YACd,CAAC,CAAC,WAAW,CAAC,aAAa,EAAE,aAAa,EAAE,kBAAkB,CAAC;YAC/D,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;QAC5B,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAClC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EACzC,SAAS,EACT,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAClE,CAAC;YACF,OAAO,UAAU,CACb,IAAI,EACJ,OAAO,EACP,wBAAwB,EAAE,aAAa,EACvC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,EAC3C,UAAU,EACV,kBAAkB,CACrB,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-value.js","sourceRoot":"","sources":["../../src/matchers/to-have-value.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAGxC,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAErG;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,WAAW,CAEvB,WAAoB,EACpB,aAAiD;IAEjD,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAEjD,IACI,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO;QAC7C,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAE,WAAgC,CAAC,IAAI,CAAC,EACxE,CAAC;QACC,MAAM,IAAI,KAAK,CACX,gJAAgJ,CACnJ,CAAC;IACN,CAAC;IAED,MAAM,aAAa,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,aAAa,KAAK,SAAS,CAAC;IAEjD,IAAI,kBAAkB,GAAG,aAAa,CAAC;IACvC,IAAI,kBAAkB,GAAG,aAAa,CAAC;IACvC,IAAI,aAAa,IAAI,aAAa,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;QACpE,kBAAkB,GAAG,GAAG,aAAa,KAAK,OAAO,aAAa,GAAG,CAAC;QAClE,kBAAkB,GAAG,GAAG,aAAa,KAAK,OAAO,aAAa,GAAG,CAAC;IACtE,CAAC;IAED,OAAO;QACH,IAAI,EAAE,YAAY;YACd,CAAC,CAAC,WAAW,CAAC,aAAa,EAAE,aAAa,EAAE,kBAAkB,CAAC;YAC/D,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;QAC5B,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAClC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EACzC,SAAS,EACT,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAClE,CAAC;YACF,OAAO,UAAU,CACb,IAAI,EACJ,OAAO,EACP,wBAAwB,EAAE,aAAa,EACvC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,EAC3C,UAAU,EACV,kBAAkB,CACrB,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}