@najemi-software/vitest-dom 0.24.0 → 0.25.0

package/esm/matchers/to-be-visible.d.ts

@@ -1,2 +1,28 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * 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 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 attribute
+ * * if `<details />` it has the open attribute
+ * @example
+ * <div
+ *   data-testid="zero-opacity"
+ *   style="opacity: 0"
+ * >
+ *   Zero Opacity
+ * </div>
+ *
+ * <div data-testid="visible">Visible Example</div>
+ *
+ * expect(getByTestId('zero-opacity')).not.toBeVisible()
+ * expect(getByTestId('visible')).toBeVisible()
+ * @see
+ * [testing-library/jest-dom#tobevisible](https://github.com/testing-library/jest-dom#tobevisible)
+ */
 export declare function toBeVisible(this: MatcherState, element: Element): MatcherResult;

package/esm/matchers/to-be-visible.js

@@ -22,6 +22,32 @@ function isElementVisible(element, previousElement) {
         isAttributeVisible(element, previousElement) &&
         (!element.parentElement || isElementVisible(element.parentElement, element)));
 }
+/**
+ * @description
+ * 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 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 attribute
+ * * if `<details />` it has the open attribute
+ * @example
+ * <div
+ *   data-testid="zero-opacity"
+ *   style="opacity: 0"
+ * >
+ *   Zero Opacity
+ * </div>
+ *
+ * <div data-testid="visible">Visible Example</div>
+ *
+ * expect(getByTestId('zero-opacity')).not.toBeVisible()
+ * expect(getByTestId('visible')).toBeVisible()
+ * @see
+ * [testing-library/jest-dom#tobevisible](https://github.com/testing-library/jest-dom#tobevisible)
+ */
 export function toBeVisible(element) {
     checkHtmlElement(element, toBeVisible, this);
     const isInDocument = element.ownerDocument === element.getRootNode({ composed: true });

package/esm/matchers/to-be-visible.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-be-visible.js","sourceRoot":"","sources":["../../src/matchers/to-be-visible.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,SAAS,cAAc,CAAC,OAAgB;IACpC,MAAM,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,WAAY,CAAC;IAEhE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACnE,OAAO,OAAO,KAAK,MAAM,IAAI,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,UAAU,IAAI,OAAO,KAAK,GAAG,CAAC;AACzG,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAgB,EAAE,eAAyB;IACnE,IAAI,iBAA0B,CAAC;IAE/B,IAAI,eAAe,EAAE,CAAC;QAClB,iBAAiB;YACb,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,eAAe,CAAC,QAAQ,KAAK,SAAS;gBACpE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;gBAC9B,CAAC,CAAC,IAAI,CAAC;IACnB,CAAC;SAAM,CAAC;QACJ,iBAAiB,GAAG,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7F,CAAC;IAED,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,iBAAiB,CAAC;AAChE,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB,EAAE,eAAyB;IACjE,OAAO,CACH,cAAc,CAAC,OAAO,CAAC;QACvB,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC;QAC5C,CAAC,CAAC,OAAO,CAAC,aAAa,IAAI,gBAAgB,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAC/E,CAAC;AACN,CAAC;AAED,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,KAAK,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACvF,MAAM,SAAS,GAAG,YAAY,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC5D,OAAO;QACH,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACvC,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,oBAAoB,EAAE,WAAW,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mCAAmC,GAAG;gBAC3F,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE;aAC5D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-be-visible.js","sourceRoot":"","sources":["../../src/matchers/to-be-visible.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,SAAS,cAAc,CAAC,OAAgB;IACpC,MAAM,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,WAAY,CAAC;IAEhE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACnE,OAAO,OAAO,KAAK,MAAM,IAAI,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,UAAU,IAAI,OAAO,KAAK,GAAG,CAAC;AACzG,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAgB,EAAE,eAAyB;IACnE,IAAI,iBAA0B,CAAC;IAE/B,IAAI,eAAe,EAAE,CAAC;QAClB,iBAAiB;YACb,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,eAAe,CAAC,QAAQ,KAAK,SAAS;gBACpE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;gBAC9B,CAAC,CAAC,IAAI,CAAC;IACnB,CAAC;SAAM,CAAC;QACJ,iBAAiB,GAAG,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7F,CAAC;IAED,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,iBAAiB,CAAC;AAChE,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB,EAAE,eAAyB;IACjE,OAAO,CACH,cAAc,CAAC,OAAO,CAAC;QACvB,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC;QAC5C,CAAC,CAAC,OAAO,CAAC,aAAa,IAAI,gBAAgB,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAC/E,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,KAAK,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACvF,MAAM,SAAS,GAAG,YAAY,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC5D,OAAO;QACH,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACvC,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,oBAAoB,EAAE,WAAW,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mCAAmC,GAAG;gBAC3F,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE;aAC5D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-contain-element.d.ts

@@ -1,2 +1,19 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Allows you to assert whether an element contains another element as a descendant or not.
+ * @example
+ * <span data-testid="ancestor">
+ *   <span data-testid="descendant"></span>
+ * </span>
+ *
+ * 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)
+ * @see
+ * [testing-library/jest-dom#tocontainelement](https://github.com/testing-library/jest-dom#tocontainelement)
+ */
 export declare function toContainElement(this: MatcherState, container: Element, element: HTMLElement | SVGElement | null): MatcherResult;

package/esm/matchers/to-contain-element.js

@@ -1,4 +1,21 @@
 import { checkHtmlElement } from "./utils.js";
+/**
+ * @description
+ * Allows you to assert whether an element contains another element as a descendant or not.
+ * @example
+ * <span data-testid="ancestor">
+ *   <span data-testid="descendant"></span>
+ * </span>
+ *
+ * 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)
+ * @see
+ * [testing-library/jest-dom#tocontainelement](https://github.com/testing-library/jest-dom#tocontainelement)
+ */
 export function toContainElement(container, element) {
     checkHtmlElement(container, toContainElement, this);
     if (element !== null) {

package/esm/matchers/to-contain-element.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-contain-element.js","sourceRoot":"","sources":["../../src/matchers/to-contain-element.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,UAAU,gBAAgB,CAE5B,SAAkB,EAClB,OAAwC;IAExC,gBAAgB,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAEpD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACnB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;IAED,OAAO;QACH,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC;QACjC,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,mBAAmB,EAAE,SAAS,EAAE,SAAS,CAAC;gBAC5F,EAAE;gBACF,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,IACzE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,mBAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;SAC7E,CAAC;aACG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-contain-element.js","sourceRoot":"","sources":["../../src/matchers/to-contain-element.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,gBAAgB,CAE5B,SAAkB,EAClB,OAAwC;IAExC,gBAAgB,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAEpD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACnB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;IAED,OAAO;QACH,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC;QACjC,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,mBAAmB,EAAE,SAAS,EAAE,SAAS,CAAC;gBAC5F,EAAE;gBACF,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,IACzE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,mBAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;SAC7E,CAAC;aACG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-contain-html.d.ts

@@ -1,2 +1,12 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Assert whether a string representing a HTML element is contained in another element.
+ * @example
+ * <span data-testid="parent"><span data-testid="child"></span></span>
+ *
+ * expect(getByTestId('parent')).toContainHTML('<span data-testid="child"></span>')
+ * @see
+ * [testing-library/jest-dom#tocontainhtml](https://github.com/testing-library/jest-dom#tocontainhtml)
+ */
 export declare function toContainHTML(this: MatcherState, container: Element, htmlText: string): MatcherResult;

package/esm/matchers/to-contain-html.js

@@ -4,6 +4,16 @@ function getNormalizedHtml(container, htmlText) {
     div.innerHTML = htmlText;
     return div.innerHTML;
 }
+/**
+ * @description
+ * Assert whether a string representing a HTML element is contained in another element.
+ * @example
+ * <span data-testid="parent"><span data-testid="child"></span></span>
+ *
+ * expect(getByTestId('parent')).toContainHTML('<span data-testid="child"></span>')
+ * @see
+ * [testing-library/jest-dom#tocontainhtml](https://github.com/testing-library/jest-dom#tocontainhtml)
+ */
 export function toContainHTML(container, htmlText) {
     checkHtmlElement(container, toContainHTML, this);
     if (typeof htmlText !== "string") {

package/esm/matchers/to-contain-html.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-contain-html.js","sourceRoot":"","sources":["../../src/matchers/to-contain-html.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,SAAS,iBAAiB,CAAC,SAAkB,EAAE,QAAgB;IAC3D,MAAM,GAAG,GAAG,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACzD,GAAG,CAAC,SAAS,GAAG,QAAQ,CAAC;IACzB,OAAO,GAAG,CAAC,SAAS,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,aAAa,CAAqB,SAAkB,EAAE,QAAgB;IAClF,gBAAgB,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;IAEjD,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,gDAAgD,QAAQ,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,OAAO;QACH,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC1E,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,gBAAgB,EAAE,SAAS,EAAE,EAAE,CAAC;gBAClF,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;gBAC1C,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE;aAC7D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-contain-html.js","sourceRoot":"","sources":["../../src/matchers/to-contain-html.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,SAAS,iBAAiB,CAAC,SAAkB,EAAE,QAAgB;IAC3D,MAAM,GAAG,GAAG,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACzD,GAAG,CAAC,SAAS,GAAG,QAAQ,CAAC;IACzB,OAAO,GAAG,CAAC,SAAS,CAAC;AACzB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAqB,SAAkB,EAAE,QAAgB;IAClF,gBAAgB,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;IAEjD,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,gDAAgD,QAAQ,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,OAAO;QACH,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC1E,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,gBAAgB,EAAE,SAAS,EAAE,EAAE,CAAC;gBAClF,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;gBAC1C,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE;aAC7D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-have-accessible-description.d.ts

@@ -1,3 +1,28 @@
 import type { expect } from "vitest";
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * This allows 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 either
+ * [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring)
+ * or [expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp).
+ * @example
+ * <a data-testid="link" href="/" aria-label="Home page" title="A link to start over">Start</a>
+ * <a data-testid="extra-link" href="/about" aria-label="About page">About</a>
+ * <img src="avatar.jpg" data-testid="avatar" alt="User profile pic" />
+ * <img src="logo.jpg" data-testid="logo" alt="Company logo" aria-describedby="t1" />
+ * <span id="t1" role="presentation">The logo of Our Company</span>
+ *
+ * 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')
+ * @see
+ * [testing-library/jest-dom#tohaveaccessibledescription](https://github.com/testing-library/jest-dom#tohaveaccessibledescription)
+ */
 export declare function toHaveAccessibleDescription(this: MatcherState, htmlElement: Element, expectedAccessibleDescription?: string | RegExp | typeof expect.stringContaining): MatcherResult;

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

@@ -1,5 +1,30 @@
 import { computeAccessibleDescription } from "dom-accessibility-api";
 import { checkHtmlElement, getMessage } from "./utils.js";
+/**
+ * @description
+ * This allows 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 either
+ * [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring)
+ * or [expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp).
+ * @example
+ * <a data-testid="link" href="/" aria-label="Home page" title="A link to start over">Start</a>
+ * <a data-testid="extra-link" href="/about" aria-label="About page">About</a>
+ * <img src="avatar.jpg" data-testid="avatar" alt="User profile pic" />
+ * <img src="logo.jpg" data-testid="logo" alt="Company logo" aria-describedby="t1" />
+ * <span id="t1" role="presentation">The logo of Our Company</span>
+ *
+ * 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')
+ * @see
+ * [testing-library/jest-dom#tohaveaccessibledescription](https://github.com/testing-library/jest-dom#tohaveaccessibledescription)
+ */
 export function toHaveAccessibleDescription(htmlElement, expectedAccessibleDescription) {
     checkHtmlElement(htmlElement, toHaveAccessibleDescription, this);
     const actualAccessibleDescription = computeAccessibleDescription(htmlElement);

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

@@ -1 +1 @@
-{"version":3,"file":"to-have-accessible-description.js","sourceRoot":"","sources":["../../src/matchers/to-have-accessible-description.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AAIrE,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D,MAAM,UAAU,2BAA2B,CAEvC,WAAoB,EACpB,6BAAgF;IAEhF,gBAAgB,CAAC,WAAW,EAAE,2BAA2B,EAAE,IAAI,CAAC,CAAC;IACjE,MAAM,2BAA2B,GAAG,4BAA4B,CAAC,WAAW,CAAC,CAAC;IAC9E,MAAM,oBAAoB,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;IAEpD,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,oBAAoB,EAAE,CAAC;QACvB,yFAAyF;QACzF,8CAA8C;QAC9C,IAAI,GAAG,2BAA2B,KAAK,EAAE,CAAC;IAC9C,CAAC;SAAM,CAAC;QACJ,IAAI;YACA,6BAA6B,YAAY,MAAM;gBAC3C,CAAC,CAAC,6BAA6B,CAAC,IAAI,CAAC,2BAA2B,CAAC;gBACjE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,EAAE,6BAA6B,CAAC,CAAC;IACtF,CAAC;IAED,OAAO;QACH,IAAI;QAEJ,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,CAClB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,2BAA2B,CAAC,IAAI,EAAE,EACjE,SAAS,EACT,EAAE,CACL,EACD,oBAAoB,EAAE,8BAA8B,EACpD,6BAA6B,EAC7B,UAAU,EACV,2BAA2B,CAC9B,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-accessible-description.js","sourceRoot":"","sources":["../../src/matchers/to-have-accessible-description.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AAIrE,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,2BAA2B,CAEvC,WAAoB,EACpB,6BAAgF;IAEhF,gBAAgB,CAAC,WAAW,EAAE,2BAA2B,EAAE,IAAI,CAAC,CAAC;IACjE,MAAM,2BAA2B,GAAG,4BAA4B,CAAC,WAAW,CAAC,CAAC;IAC9E,MAAM,oBAAoB,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;IAEpD,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,oBAAoB,EAAE,CAAC;QACvB,yFAAyF;QACzF,8CAA8C;QAC9C,IAAI,GAAG,2BAA2B,KAAK,EAAE,CAAC;IAC9C,CAAC;SAAM,CAAC;QACJ,IAAI;YACA,6BAA6B,YAAY,MAAM;gBAC3C,CAAC,CAAC,6BAA6B,CAAC,IAAI,CAAC,2BAA2B,CAAC;gBACjE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,EAAE,6BAA6B,CAAC,CAAC;IACtF,CAAC;IAED,OAAO;QACH,IAAI;QAEJ,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,CAClB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,2BAA2B,CAAC,IAAI,EAAE,EACjE,SAAS,EACT,EAAE,CACL,EACD,oBAAoB,EAAE,8BAA8B,EACpD,6BAA6B,EAC7B,UAAU,EACV,2BAA2B,CAC9B,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}

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

@@ -1,2 +1,40 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * 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 either
+ * [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring)
+ * or [expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp).
+ *
+ * @example
+ * <input aria-label="Has Error" aria-invalid="true" aria-errormessage="error-message" />
+ * <div id="error-message" role="alert">This field is invalid</div>
+ *
+ * <input aria-label="No Error Attributes" />
+ * <input aria-label="Not Invalid" aria-invalid="false" aria-errormessage="error-message" />
+ *
+ * // 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()
+ *
+ * @see
+ * [testing-library/jest-dom#tohaveaccessibleerrormessage](https://github.com/testing-library/jest-dom#tohaveaccessibleerrormessage)
+ */
 export declare function toHaveAccessibleErrorMessage<State extends MatcherState>(this: State, htmlElement: HTMLElement, expectedAccessibleErrorMessage?: string | RegExp | State): MatcherResult;

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

@@ -2,6 +2,44 @@ import { checkHtmlElement, getMessage, normalize } from "./utils.js";
 const ariaInvalidName = "aria-invalid";
 const validStates = ["false"];
 // See `aria-errormessage` spec at https://www.w3.org/TR/wai-aria-1.2/#aria-errormessage
+/**
+ * @description
+ * 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 either
+ * [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring)
+ * or [expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp).
+ *
+ * @example
+ * <input aria-label="Has Error" aria-invalid="true" aria-errormessage="error-message" />
+ * <div id="error-message" role="alert">This field is invalid</div>
+ *
+ * <input aria-label="No Error Attributes" />
+ * <input aria-label="Not Invalid" aria-invalid="false" aria-errormessage="error-message" />
+ *
+ * // 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()
+ *
+ * @see
+ * [testing-library/jest-dom#tohaveaccessibleerrormessage](https://github.com/testing-library/jest-dom#tohaveaccessibleerrormessage)
+ */
 export function toHaveAccessibleErrorMessage(htmlElement, expectedAccessibleErrorMessage) {
     checkHtmlElement(htmlElement, toHaveAccessibleErrorMessage, this);
     const to = this.isNot ? "not to" : "to";

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

@@ -1 +1 @@
-{"version":3,"file":"to-have-accessible-errormessage.js","sourceRoot":"","sources":["../../src/matchers/to-have-accessible-errormessage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAErE,MAAM,eAAe,GAAG,cAAc,CAAC;AACvC,MAAM,WAAW,GAAG,CAAC,OAAO,CAAC,CAAC;AAE9B,wFAAwF;AACxF,MAAM,UAAU,4BAA4B,CAExC,WAAwB,EACxB,8BAAwD;IAExD,gBAAgB,CAAC,WAAW,EAAE,4BAA4B,EAAE,IAAI,CAAC,CAAC;IAClE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IACxC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAAC,CAAC,+BAA+B,CAAC;IAElG,mBAAmB;IACnB,MAAM,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;IACrE,MAAM,qBAAqB,GAAG,CAAC,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAE7E,IAAI,qBAAqB,EAAE,CAAC;QACxB,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE;gBACV,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EACzC,oFAAoF,EACpF,EAAE,EACF,UAAU,EACV,sBAAsB,cAAc,GAAG,CAC1C,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,8EAA8E;IAC9E,MAAM,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACjE,MAAM,UAAU,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAe,CAAC,CAAC;IAEvG,yCAAyC;IACzC,IAAI,UAAU,EAAE,CAAC;QACb,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE;gBACV,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EACzC,yDAAyD,EACzD,GAAG,eAAe,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,EACtC,UAAU,EACV,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC;oBACpC,CAAC,CAAC,GAAG,eAAe,KAAK,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE;oBACpE,CAAC,CAAC,IAAI,CACb,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,MAAM,KAAK,GAAG,SAAS,CACnB,cAAc,IAAI,IAAI;QAClB,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,WAAW,IAAI,EAAE,CAAC;QAC/E,CAAC,CAAC,EAAE,CACX,CAAC;IAEF,OAAO;QACH,IAAI,EACA,8BAA8B,KAAK,SAAS;YACxC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YAChB,CAAC,CAAC,8BAA8B,YAAY,MAAM;gBAChD,CAAC,CAAC,8BAA8B,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC5C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,8BAA8B,CAAC;QAE9D,OAAO,EAAE,GAAG,EAAE;YACV,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EACzC,oBAAoB,EAAE,gCAAgC,EACtD,8BAA8B,IAAI,EAAE,EACpC,UAAU,EACV,KAAK,CACR,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-accessible-errormessage.js","sourceRoot":"","sources":["../../src/matchers/to-have-accessible-errormessage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAErE,MAAM,eAAe,GAAG,cAAc,CAAC;AACvC,MAAM,WAAW,GAAG,CAAC,OAAO,CAAC,CAAC;AAE9B,wFAAwF;AACxF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,UAAU,4BAA4B,CAExC,WAAwB,EACxB,8BAAwD;IAExD,gBAAgB,CAAC,WAAW,EAAE,4BAA4B,EAAE,IAAI,CAAC,CAAC;IAClE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IACxC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAAC,CAAC,+BAA+B,CAAC;IAElG,mBAAmB;IACnB,MAAM,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;IACrE,MAAM,qBAAqB,GAAG,CAAC,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAE7E,IAAI,qBAAqB,EAAE,CAAC;QACxB,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE;gBACV,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EACzC,oFAAoF,EACpF,EAAE,EACF,UAAU,EACV,sBAAsB,cAAc,GAAG,CAC1C,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,8EAA8E;IAC9E,MAAM,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACjE,MAAM,UAAU,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAe,CAAC,CAAC;IAEvG,yCAAyC;IACzC,IAAI,UAAU,EAAE,CAAC;QACb,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE;gBACV,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EACzC,yDAAyD,EACzD,GAAG,eAAe,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,EACtC,UAAU,EACV,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC;oBACpC,CAAC,CAAC,GAAG,eAAe,KAAK,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE;oBACpE,CAAC,CAAC,IAAI,CACb,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,MAAM,KAAK,GAAG,SAAS,CACnB,cAAc,IAAI,IAAI;QAClB,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,WAAW,IAAI,EAAE,CAAC;QAC/E,CAAC,CAAC,EAAE,CACX,CAAC;IAEF,OAAO;QACH,IAAI,EACA,8BAA8B,KAAK,SAAS;YACxC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YAChB,CAAC,CAAC,8BAA8B,YAAY,MAAM;gBAChD,CAAC,CAAC,8BAA8B,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC5C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,8BAA8B,CAAC;QAE9D,OAAO,EAAE,GAAG,EAAE;YACV,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EACzC,oBAAoB,EAAE,gCAAgC,EACtD,8BAA8B,IAAI,EAAE,EACpC,UAAU,EACV,KAAK,CACR,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-have-accessible-name.d.ts

@@ -1,3 +1,33 @@
 import type { expect } from "vitest";
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * This allows 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 either
+ * [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring)
+ * or [expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp).
+ * @example
+ * <img data-testid="img-alt" src="" alt="Test alt" />
+ * <img data-testid="img-empty-alt" src="" alt="" />
+ * <svg data-testid="svg-title"><title>Test title</title></svg>
+ * <button data-testid="button-img-alt"><img src="" alt="Test" /></button>
+ * <p><img data-testid="img-paragraph" src="" alt="" /> Test content</p>
+ * <button data-testid="svg-button"><svg><title>Test</title></svg></p>
+ * <div><svg data-testid="svg-without-title"></svg></div>
+ * <input data-testid="input-title" title="test" />
+ *
+ * expect(getByTestId('img-alt')).toHaveAccessibleName('Test alt')
+ * expect(getByTestId('img-empty-alt')).not.toHaveAccessibleName()
+ * expect(getByTestId('svg-title')).toHaveAccessibleName('Test title')
+ * expect(getByTestId('button-img-alt')).toHaveAccessibleName()
+ * expect(getByTestId('img-paragraph')).not.toHaveAccessibleName()
+ * expect(getByTestId('svg-button')).toHaveAccessibleName()
+ * expect(getByTestId('svg-without-title')).not.toHaveAccessibleName()
+ * expect(getByTestId('input-title')).toHaveAccessibleName()
+ * @see
+ * [testing-library/jest-dom#tohaveaccessiblename](https://github.com/testing-library/jest-dom#tohaveaccessiblename)
+ */
 export declare function toHaveAccessibleName(this: MatcherState, htmlElement: Element, expectedAccessibleName?: string | RegExp | typeof expect.stringContaining): MatcherResult;

package/esm/matchers/to-have-accessible-name.js

@@ -1,5 +1,35 @@
 import { computeAccessibleName } from "dom-accessibility-api";
 import { checkHtmlElement, getMessage } from "./utils.js";
+/**
+ * @description
+ * This allows 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 either
+ * [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring)
+ * or [expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp).
+ * @example
+ * <img data-testid="img-alt" src="" alt="Test alt" />
+ * <img data-testid="img-empty-alt" src="" alt="" />
+ * <svg data-testid="svg-title"><title>Test title</title></svg>
+ * <button data-testid="button-img-alt"><img src="" alt="Test" /></button>
+ * <p><img data-testid="img-paragraph" src="" alt="" /> Test content</p>
+ * <button data-testid="svg-button"><svg><title>Test</title></svg></p>
+ * <div><svg data-testid="svg-without-title"></svg></div>
+ * <input data-testid="input-title" title="test" />
+ *
+ * expect(getByTestId('img-alt')).toHaveAccessibleName('Test alt')
+ * expect(getByTestId('img-empty-alt')).not.toHaveAccessibleName()
+ * expect(getByTestId('svg-title')).toHaveAccessibleName('Test title')
+ * expect(getByTestId('button-img-alt')).toHaveAccessibleName()
+ * expect(getByTestId('img-paragraph')).not.toHaveAccessibleName()
+ * expect(getByTestId('svg-button')).toHaveAccessibleName()
+ * expect(getByTestId('svg-without-title')).not.toHaveAccessibleName()
+ * expect(getByTestId('input-title')).toHaveAccessibleName()
+ * @see
+ * [testing-library/jest-dom#tohaveaccessiblename](https://github.com/testing-library/jest-dom#tohaveaccessiblename)
+ */
 export function toHaveAccessibleName(htmlElement, expectedAccessibleName) {
     checkHtmlElement(htmlElement, toHaveAccessibleName, this);
     const actualAccessibleName = computeAccessibleName(htmlElement);

package/esm/matchers/to-have-accessible-name.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-have-accessible-name.js","sourceRoot":"","sources":["../../src/matchers/to-have-accessible-name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAI9D,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D,MAAM,UAAU,oBAAoB,CAEhC,WAAoB,EACpB,sBAAyE;IAEzE,gBAAgB,CAAC,WAAW,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;IAC1D,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAChE,MAAM,oBAAoB,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;IAEpD,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,oBAAoB,EAAE,CAAC;QACvB,yFAAyF;QACzF,uCAAuC;QACvC,IAAI,GAAG,oBAAoB,KAAK,EAAE,CAAC;IACvC,CAAC;SAAM,CAAC;QACJ,IAAI;YACA,sBAAsB,YAAY,MAAM;gBACpC,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,oBAAoB,CAAC;gBACnD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,sBAAsB,CAAC,CAAC;IACxE,CAAC;IAED,OAAO;QACH,IAAI;QAEJ,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,CAClB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,oBAAoB,CAAC,IAAI,EAAE,EAC1D,SAAS,EACT,EAAE,CACL,EACD,oBAAoB,EAAE,uBAAuB,EAC7C,sBAAsB,EACtB,UAAU,EACV,oBAAoB,CACvB,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-accessible-name.js","sourceRoot":"","sources":["../../src/matchers/to-have-accessible-name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAI9D,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,oBAAoB,CAEhC,WAAoB,EACpB,sBAAyE;IAEzE,gBAAgB,CAAC,WAAW,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;IAC1D,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAChE,MAAM,oBAAoB,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;IAEpD,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,oBAAoB,EAAE,CAAC;QACvB,yFAAyF;QACzF,uCAAuC;QACvC,IAAI,GAAG,oBAAoB,KAAK,EAAE,CAAC;IACvC,CAAC;SAAM,CAAC;QACJ,IAAI;YACA,sBAAsB,YAAY,MAAM;gBACpC,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,oBAAoB,CAAC;gBACnD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,sBAAsB,CAAC,CAAC;IACxE,CAAC;IAED,OAAO;QACH,IAAI;QAEJ,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,CAClB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,oBAAoB,CAAC,IAAI,EAAE,EAC1D,SAAS,EACT,EAAE,CACL,EACD,oBAAoB,EAAE,uBAAuB,EAC7C,sBAAsB,EACtB,UAAU,EACV,oBAAoB,CACvB,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}

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

@@ -1,2 +1,24 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Allows you to check if a given element has an attribute or not.
+ *
+ * You can also optionally check that the attribute has a specific expected value or partial match using
+ * [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring) or
+ * [expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp).
+ * @example
+ * <button
+ *   data-testid="ok-button"
+ *   type="submit"
+ *   disabled
+ * >
+ *   ok
+ * </button>
+ *
+ * expect(button).toHaveAttribute('disabled')
+ * expect(button).toHaveAttribute('type', 'submit')
+ * expect(button).not.toHaveAttribute('type', 'button')
+ * @see
+ * [testing-library/jest-dom#tohaveattribute](https://github.com/testing-library/jest-dom#tohaveattribute)
+ */
 export declare function toHaveAttribute(this: MatcherState, htmlElement: Element, name: string, expectedValue?: unknown): MatcherResult;

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

@@ -7,6 +7,28 @@ function getAttributeComment(stringify, name, value) {
         ? `element.hasAttribute(${stringify(name)})`
         : `element.getAttribute(${stringify(name)}) === ${stringify(value)}`;
 }
+/**
+ * @description
+ * Allows you to check if a given element has an attribute or not.
+ *
+ * You can also optionally check that the attribute has a specific expected value or partial match using
+ * [expect.stringContaining](https://jestjs.io/docs/en/expect.html#expectnotstringcontainingstring) or
+ * [expect.stringMatching](https://jestjs.io/docs/en/expect.html#expectstringmatchingstring-regexp).
+ * @example
+ * <button
+ *   data-testid="ok-button"
+ *   type="submit"
+ *   disabled
+ * >
+ *   ok
+ * </button>
+ *
+ * expect(button).toHaveAttribute('disabled')
+ * expect(button).toHaveAttribute('type', 'submit')
+ * expect(button).not.toHaveAttribute('type', 'button')
+ * @see
+ * [testing-library/jest-dom#tohaveattribute](https://github.com/testing-library/jest-dom#tohaveattribute)
+ */
 export function toHaveAttribute(htmlElement, name, expectedValue) {
     checkHtmlElement(htmlElement, toHaveAttribute, this);
     const isExpectedValuePresent = expectedValue !== undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"to-have-attribute.js","sourceRoot":"","sources":["../../src/matchers/to-have-attribute.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D,SAAS,cAAc,CAAC,SAAqC,EAAE,IAAY,EAAE,KAAc;IACvF,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;AACtE,CAAC;AAED,SAAS,mBAAmB,CAAC,SAAqC,EAAE,IAAY,EAAE,KAAc;IAC5F,OAAO,KAAK,KAAK,SAAS;QACtB,CAAC,CAAC,wBAAwB,SAAS,CAAC,IAAI,CAAC,GAAG;QAC5C,CAAC,CAAC,wBAAwB,SAAS,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;AAC7E,CAAC;AAED,MAAM,UAAU,eAAe,CAE3B,WAAoB,EACpB,IAAY,EACZ,aAAuB;IAEvB,gBAAgB,CAAC,WAAW,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;IACrD,MAAM,sBAAsB,GAAG,aAAa,KAAK,SAAS,CAAC;IAC3D,MAAM,YAAY,GAAG,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACpD,MAAM,aAAa,GAAG,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACrD,OAAO;QACH,IAAI,EAAE,sBAAsB;YACxB,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,aAAa,CAAC;YAC3D,CAAC,CAAC,YAAY;QAClB,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,MAAM,iBAAiB,GAAG,YAAY;gBAClC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC;gBAC3D,CAAC,CAAC,IAAI,CAAC;YACX,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAClC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAC7C,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAC9B;gBACI,cAAc,EAAE,sBAAsB;oBAClC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC;oBACzC,CAAC,CAAC,SAAS;gBACf,OAAO,EAAE,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC;aAC1E,CACJ,CAAC;YACF,OAAO,UAAU,CACb,IAAI,EACJ,OAAO,EACP,wBAAwB,EAAE,iBAAiB,EAC3C,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC,EACzD,UAAU,EACV,iBAAiB,CACpB,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-have-attribute.js","sourceRoot":"","sources":["../../src/matchers/to-have-attribute.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D,SAAS,cAAc,CAAC,SAAqC,EAAE,IAAY,EAAE,KAAc;IACvF,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;AACtE,CAAC;AAED,SAAS,mBAAmB,CAAC,SAAqC,EAAE,IAAY,EAAE,KAAc;IAC5F,OAAO,KAAK,KAAK,SAAS;QACtB,CAAC,CAAC,wBAAwB,SAAS,CAAC,IAAI,CAAC,GAAG;QAC5C,CAAC,CAAC,wBAAwB,SAAS,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;AAC7E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,eAAe,CAE3B,WAAoB,EACpB,IAAY,EACZ,aAAuB;IAEvB,gBAAgB,CAAC,WAAW,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;IACrD,MAAM,sBAAsB,GAAG,aAAa,KAAK,SAAS,CAAC;IAC3D,MAAM,YAAY,GAAG,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACpD,MAAM,aAAa,GAAG,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACrD,OAAO;QACH,IAAI,EAAE,sBAAsB;YACxB,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,aAAa,CAAC;YAC3D,CAAC,CAAC,YAAY;QAClB,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,MAAM,iBAAiB,GAAG,YAAY;gBAClC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC;gBAC3D,CAAC,CAAC,IAAI,CAAC;YACX,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAClC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAC7C,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAC9B;gBACI,cAAc,EAAE,sBAAsB;oBAClC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC;oBACzC,CAAC,CAAC,SAAS;gBACf,OAAO,EAAE,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC;aAC1E,CACJ,CAAC;YACF,OAAO,UAAU,CACb,IAAI,EACJ,OAAO,EACP,wBAAwB,EAAE,iBAAiB,EAC3C,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC,EACzD,UAAU,EACV,iBAAiB,CACpB,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}

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

@@ -1,2 +1,27 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * 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.
+ * @example
+ * <button
+ *   data-testid="delete-button"
+ *   class="btn xs btn-danger"
+ * >
+ *   delete item
+ * </button>
+ *
+ * <div data-testid="no-classes">no classes</div>
+ *
+ * const deleteButton = getByTestId('delete-button')
+ * const noClasses = getByTestId('no-classes')
+ * expect(deleteButton).toHaveClass('btn')
+ * expect(deleteButton).toHaveClass('btn-danger xs')
+ * expect(deleteButton).toHaveClass('btn xs btn-danger', {exact: true})
+ * expect(deleteButton).not.toHaveClass('btn xs btn-danger', {exact: true})
+ * expect(noClasses).not.toHaveClass()
+ * @see
+ * [testing-library/jest-dom#tohaveclass](https://github.com/testing-library/jest-dom#tohaveclass)
+ */
 export declare function toHaveClass(this: MatcherState, htmlElement: Element, ...params: string[]): MatcherResult;

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

@@ -21,6 +21,31 @@ function splitClassNames(str) {
 function isSubset(subset, superset) {
     return subset.every((item) => superset.includes(item));
 }
+/**
+ * @description
+ * 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.
+ * @example
+ * <button
+ *   data-testid="delete-button"
+ *   class="btn xs btn-danger"
+ * >
+ *   delete item
+ * </button>
+ *
+ * <div data-testid="no-classes">no classes</div>
+ *
+ * const deleteButton = getByTestId('delete-button')
+ * const noClasses = getByTestId('no-classes')
+ * expect(deleteButton).toHaveClass('btn')
+ * expect(deleteButton).toHaveClass('btn-danger xs')
+ * expect(deleteButton).toHaveClass('btn xs btn-danger', {exact: true})
+ * expect(deleteButton).not.toHaveClass('btn xs btn-danger', {exact: true})
+ * expect(noClasses).not.toHaveClass()
+ * @see
+ * [testing-library/jest-dom#tohaveclass](https://github.com/testing-library/jest-dom#tohaveclass)
+ */
 export function toHaveClass(htmlElement, ...params) {
     checkHtmlElement(htmlElement, toHaveClass, this);
     const { expectedClassNames, options } = getExpectedClassNamesAndOptions(params);

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

@@ -1 +1 @@
-{"version":3,"file":"to-have-class.js","sourceRoot":"","sources":["../../src/matchers/to-have-class.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAM1D,SAAS,+BAA+B,CAAC,MAA0C;IAC/E,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC;IAC/B,IAAI,kBAA6C,EAAE,OAA2B,CAAC;IAE/E,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAChC,kBAAkB,GAAG,MAAkB,CAAC;QACxC,OAAO,GAAG,SAAS,CAAC;IACxB,CAAC;SAAM,CAAC;QACJ,kBAAkB,GAAI,MAAmB,CAAC,MAAM,CAAC,SAAmB,CAAC,CAAC;QACtE,OAAO,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IAC/B,CAAC;IACD,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC;AAC3C,CAAC;AAED,SAAS,eAAe,CAAC,GAA8B;IACnD,IAAI,CAAC,GAAG,EAAE,CAAC;QACP,OAAO,EAAE,CAAC;IACd,CAAC;IACD,OAAO,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,QAAQ,CAAC,MAAgB,EAAE,QAAkB;IAClD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,WAAW,CAAqB,WAAoB,EAAE,GAAG,MAAgB;IACrF,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjD,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,GAAG,+BAA+B,CAAC,MAAM,CAAC,CAAC;IAEhF,MAAM,QAAQ,GAAG,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CACtC,CAAC,GAAa,EAAE,SAAS,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,EACpE,EAAE,CACL,CAAC;IAEF,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO;YACH,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;YACzE,OAAO,EAAE,GAAG,EAAE;gBACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;gBACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAClB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EACzC,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAC/C,EACD,wBAAwB,EAAE,+BAA+B,EACzD,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAClB,UAAU,EACV,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CACrB,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC;QACtB,CAAC,CAAC;YACI,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;YAClC,OAAO,EAAE,GAAG,EAAE;gBACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;gBACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAClB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EACzC,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAC/C,EACD,wBAAwB,EAAE,aAAa,EACvC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAClB,UAAU,EACV,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CACrB,CAAC;YACN,CAAC;SACJ;QACH,CAAC,CAAC;YACI,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK;YAC9C,OAAO,EAAE,GAAG,EAAE,CACV,IAAI,CAAC,KAAK;gBACN,CAAC,CAAC,UAAU,CACN,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,kBAAkB,EAAE,SAAS,EAAE,EAAE,CAAC,EACzD,sCAAsC,EACtC,QAAQ,EACR,UAAU,EACV,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CACrB;gBACH,CAAC,CAAC;oBACI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,cAAc,EAAE,SAAS,CAAC;oBACjD,+CAA+C;iBAClD,CAAC,IAAI,CAAC,IAAI,CAAC;SACzB,CAAC;AACZ,CAAC"}
+{"version":3,"file":"to-have-class.js","sourceRoot":"","sources":["../../src/matchers/to-have-class.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAM1D,SAAS,+BAA+B,CAAC,MAA0C;IAC/E,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC;IAC/B,IAAI,kBAA6C,EAAE,OAA2B,CAAC;IAE/E,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAChC,kBAAkB,GAAG,MAAkB,CAAC;QACxC,OAAO,GAAG,SAAS,CAAC;IACxB,CAAC;SAAM,CAAC;QACJ,kBAAkB,GAAI,MAAmB,CAAC,MAAM,CAAC,SAAmB,CAAC,CAAC;QACtE,OAAO,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IAC/B,CAAC;IACD,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC;AAC3C,CAAC;AAED,SAAS,eAAe,CAAC,GAA8B;IACnD,IAAI,CAAC,GAAG,EAAE,CAAC;QACP,OAAO,EAAE,CAAC;IACd,CAAC;IACD,OAAO,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,QAAQ,CAAC,MAAgB,EAAE,QAAkB;IAClD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,WAAW,CAAqB,WAAoB,EAAE,GAAG,MAAgB;IACrF,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjD,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,GAAG,+BAA+B,CAAC,MAAM,CAAC,CAAC;IAEhF,MAAM,QAAQ,GAAG,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CACtC,CAAC,GAAa,EAAE,SAAS,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,EACpE,EAAE,CACL,CAAC;IAEF,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO;YACH,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;YACzE,OAAO,EAAE,GAAG,EAAE;gBACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;gBACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAClB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EACzC,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAC/C,EACD,wBAAwB,EAAE,+BAA+B,EACzD,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAClB,UAAU,EACV,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CACrB,CAAC;YACN,CAAC;SACJ,CAAC;IACN,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC;QACtB,CAAC,CAAC;YACI,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;YAClC,OAAO,EAAE,GAAG,EAAE;gBACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;gBACxC,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAClB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EACzC,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAC/C,EACD,wBAAwB,EAAE,aAAa,EACvC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAClB,UAAU,EACV,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CACrB,CAAC;YACN,CAAC;SACJ;QACH,CAAC,CAAC;YACI,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK;YAC9C,OAAO,EAAE,GAAG,EAAE,CACV,IAAI,CAAC,KAAK;gBACN,CAAC,CAAC,UAAU,CACN,IAAI,EACJ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,kBAAkB,EAAE,SAAS,EAAE,EAAE,CAAC,EACzD,sCAAsC,EACtC,QAAQ,EACR,UAAU,EACV,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CACrB;gBACH,CAAC,CAAC;oBACI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,cAAc,EAAE,SAAS,CAAC;oBACjD,+CAA+C;iBAClD,CAAC,IAAI,CAAC,IAAI,CAAC;SACzB,CAAC;AACZ,CAAC"}

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

@@ -1,4 +1,51 @@
 import type { expect } from "vitest";
 import type { MatcherResult, MatcherState } from "./types.js";
-/** @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 declare function toHaveDescription(this: MatcherState, htmlElement: Element, checkWith?: string | RegExp | typeof expect.stringContaining): MatcherResult;