@najemi-software/vitest-dom 0.24.0 → 0.25.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.25.0] - 2026-09-27
+
+### Changed
+
+- Move matcher docstrings from the TestingLibraryMatchers interface to the matcher functions
+
 ## [0.24.0] - 2026-09-27
 
 ### Changed
@@ -233,6 +239,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
+[0.25.0]: https://github.com/Najemi-Software/vitest-dom/compare/v0.24.0...v0.25.0
 [0.24.0]: https://github.com/Najemi-Software/vitest-dom/compare/v0.23.0...v0.24.0
 [0.23.0]: https://github.com/Najemi-Software/vitest-dom/compare/v0.22.0...v0.23.0
 [0.22.0]: https://github.com/Najemi-Software/vitest-dom/compare/v0.21.0...v0.22.0

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

@@ -1,2 +1,25 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Assert whether the given element is checked.
+ *
+ * It accepts an `input` of type `checkbox` or `radio` and elements with a `role` of `radio` with a valid
+ * `aria-checked` attribute of "true" or "false".
+ * @example
+ * <input
+ *   type="checkbox"
+ *   checked
+ *   data-testid="input-checkbox" />
+ * <input
+ *   type="radio"
+ *   value="foo"
+ *   data-testid="input-radio" />
+ *
+ * const inputCheckbox = getByTestId('input-checkbox')
+ * const inputRadio = getByTestId('input-radio')
+ * expect(inputCheckbox).toBeChecked()
+ * expect(inputRadio).not.toBeChecked()
+ * @see
+ * [testing-library/jest-dom#tobechecked](https://github.com/testing-library/jest-dom#tobechecked)
+ */
 export declare function toBeChecked(this: MatcherState, element: Element): MatcherResult;

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

@@ -10,6 +10,29 @@ const ROLES_SUPPORTING_CHECKED = [
     "switch",
     "treeitem",
 ];
+/**
+ * @description
+ * Assert whether the given element is checked.
+ *
+ * It accepts an `input` of type `checkbox` or `radio` and elements with a `role` of `radio` with a valid
+ * `aria-checked` attribute of "true" or "false".
+ * @example
+ * <input
+ *   type="checkbox"
+ *   checked
+ *   data-testid="input-checkbox" />
+ * <input
+ *   type="radio"
+ *   value="foo"
+ *   data-testid="input-radio" />
+ *
+ * const inputCheckbox = getByTestId('input-checkbox')
+ * const inputRadio = getByTestId('input-radio')
+ * expect(inputCheckbox).toBeChecked()
+ * expect(inputRadio).not.toBeChecked()
+ * @see
+ * [testing-library/jest-dom#tobechecked](https://github.com/testing-library/jest-dom#tobechecked)
+ */
 export function toBeChecked(element) {
     checkHtmlElement(element, toBeChecked, this);
     const isValidInput = () => {

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

@@ -1 +1 @@
-{"version":3,"file":"to-be-checked.js","sourceRoot":"","sources":["../../src/matchers/to-be-checked.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D,mDAAmD;AACnD,sDAAsD;AACtD,MAAM,wBAAwB,GAAG;IAC7B,UAAU;IACV,kBAAkB;IAClB,eAAe;IACf,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,UAAU;CACb,CAAC;AAEF,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAE7C,MAAM,YAAY,GAAG,GAAG,EAAE;QACtB,OAAO,CACH,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO;YACzC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAE,OAA4B,CAAC,IAAI,CAAC,CACrE,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,GAAG,EAAE;QAC5B,OAAO,CACH,mBAAmB,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACjD,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CACzE,CAAC;IACN,CAAC,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,kBAAkB,EAAE,EAAE,CAAC;QAC3C,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE,CACV,qEAAqE,sBAAsB,EAAE,iGAAiG;SACrM,CAAC;IACN,CAAC;IAED,MAAM,SAAS,GAAG,GAAG,EAAE;QACnB,IAAI,YAAY,EAAE;YAAE,OAAQ,OAA4B,CAAC,OAAO,CAAC;QACjE,OAAO,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,MAAM,CAAC;IAC3D,CAAC,CAAC;IAEF,OAAO;QACH,IAAI,EAAE,SAAS,EAAE;QACjB,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACzC,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;gBACjC,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;AAED,SAAS,sBAAsB;IAC3B,OAAO,UAAU,CACb,wBAAwB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,CAAC,EACxD,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAChC,CAAC;AACN,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAmB;IAC5C,OAAO,IAAI,KAAK,IAAI,IAAI,wBAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACpE,CAAC"}
+{"version":3,"file":"to-be-checked.js","sourceRoot":"","sources":["../../src/matchers/to-be-checked.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D,mDAAmD;AACnD,sDAAsD;AACtD,MAAM,wBAAwB,GAAG;IAC7B,UAAU;IACV,kBAAkB;IAClB,eAAe;IACf,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,UAAU;CACb,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAE7C,MAAM,YAAY,GAAG,GAAG,EAAE;QACtB,OAAO,CACH,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO;YACzC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAE,OAA4B,CAAC,IAAI,CAAC,CACrE,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,GAAG,EAAE;QAC5B,OAAO,CACH,mBAAmB,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACjD,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CACzE,CAAC;IACN,CAAC,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,kBAAkB,EAAE,EAAE,CAAC;QAC3C,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE,CACV,qEAAqE,sBAAsB,EAAE,iGAAiG;SACrM,CAAC;IACN,CAAC;IAED,MAAM,SAAS,GAAG,GAAG,EAAE;QACnB,IAAI,YAAY,EAAE;YAAE,OAAQ,OAA4B,CAAC,OAAO,CAAC;QACjE,OAAO,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,MAAM,CAAC;IAC3D,CAAC,CAAC;IAEF,OAAO;QACH,IAAI,EAAE,SAAS,EAAE;QACjB,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACzC,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;gBACjC,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;AAED,SAAS,sBAAsB;IAC3B,OAAO,UAAU,CACb,wBAAwB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,CAAC,EACxD,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAChC,CAAC;AACN,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAmB;IAC5C,OAAO,IAAI,KAAK,IAAI,IAAI,wBAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACpE,CAAC"}

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

@@ -1,3 +1,41 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Allows you to check whether an element is disabled from the user's perspective.
+ *
+ * Matches if the element is a form control and the `disabled` attribute is specified on this element or the
+ * element is a descendant of a form element with a `disabled` attribute.
+ * @example
+ * <button
+ *   data-testid="button"
+ *   type="submit"
+ *   disabled
+ * >
+ *   submit
+ * </button>
+ *
+ * expect(getByTestId('button')).toBeDisabled()
+ * @see
+ * [testing-library/jest-dom#tobedisabled](https://github.com/testing-library/jest-dom#tobedisabled)
+ */
 export declare function toBeDisabled(this: MatcherState, element: Element): MatcherResult;
+/**
+ * @description
+ * Allows you to check whether an element is not disabled from the user's perspective.
+ *
+ * Works like `not.toBeDisabled()`.
+ *
+ * Use this matcher to avoid double negation in your tests.
+ * @example
+ * <button
+ *   data-testid="button"
+ *   type="submit"
+ * >
+ *   submit
+ * </button>
+ *
+ * expect(getByTestId('button')).toBeEnabled()
+ * @see
+ * [testing-library/jest-dom#tobeenabled](https://github.com/testing-library/jest-dom#tobeenabled)
+ */
 export declare function toBeEnabled(this: MatcherState, element: Element): MatcherResult;

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

@@ -39,6 +39,25 @@ function isAncestorDisabled(element) {
 function isElementOrAncestorDisabled(element) {
     return canElementBeDisabled(element) && (isElementDisabled(element) || isAncestorDisabled(element));
 }
+/**
+ * @description
+ * Allows you to check whether an element is disabled from the user's perspective.
+ *
+ * Matches if the element is a form control and the `disabled` attribute is specified on this element or the
+ * element is a descendant of a form element with a `disabled` attribute.
+ * @example
+ * <button
+ *   data-testid="button"
+ *   type="submit"
+ *   disabled
+ * >
+ *   submit
+ * </button>
+ *
+ * expect(getByTestId('button')).toBeDisabled()
+ * @see
+ * [testing-library/jest-dom#tobedisabled](https://github.com/testing-library/jest-dom#tobedisabled)
+ */
 export function toBeDisabled(element) {
     checkHtmlElement(element, toBeDisabled, this);
     const isDisabled = isElementOrAncestorDisabled(element);
@@ -55,6 +74,25 @@ export function toBeDisabled(element) {
         },
     };
 }
+/**
+ * @description
+ * Allows you to check whether an element is not disabled from the user's perspective.
+ *
+ * Works like `not.toBeDisabled()`.
+ *
+ * Use this matcher to avoid double negation in your tests.
+ * @example
+ * <button
+ *   data-testid="button"
+ *   type="submit"
+ * >
+ *   submit
+ * </button>
+ *
+ * expect(getByTestId('button')).toBeEnabled()
+ * @see
+ * [testing-library/jest-dom#tobeenabled](https://github.com/testing-library/jest-dom#tobeenabled)
+ */
 export function toBeEnabled(element) {
     checkHtmlElement(element, toBeEnabled, this);
     const isEnabled = !isElementOrAncestorDisabled(element);

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

@@ -1 +1 @@
-{"version":3,"file":"to-be-disabled.js","sourceRoot":"","sources":["../../src/matchers/to-be-disabled.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEtD,wCAAwC;AACxC,MAAM,SAAS,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAE9F;;;;;;;;GAQG;AACH,SAAS,4BAA4B,CAAC,OAAgB,EAAE,MAAe;IACnE,OAAO,CACH,MAAM,CAAC,OAAO,CAAC,KAAK,QAAQ;QAC5B,MAAM,CAAC,MAAM,CAAC,KAAK,UAAU;QAC7B,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,IAAI,IAAI,CAAC,CACtG,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,OAAgB,EAAE,MAAe;IAChE,OAAO,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AACvF,CAAC;AAED,SAAS,eAAe,CAAC,GAAW;IAChC,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,OAAgB;IAC1C,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC5B,OAAO,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAgB;IACvC,OAAO,oBAAoB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;AAC7E,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAgB;IACxC,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IACrC,OAAO,MAAM,KAAK,IAAI,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;AACzG,CAAC;AAED,SAAS,2BAA2B,CAAC,OAAgB;IACjD,OAAO,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;AACxG,CAAC;AAED,MAAM,UAAU,YAAY,CAAqB,OAAgB;IAC7D,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAExD,OAAO;QACH,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACxC,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,CAAC;gBACjF,EAAE;gBACF,oBAAoB,EAAE,YAAY;gBAClC,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;AAED,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAE7C,MAAM,SAAS,GAAG,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAExD,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;gBACjC,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-disabled.js","sourceRoot":"","sources":["../../src/matchers/to-be-disabled.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEtD,wCAAwC;AACxC,MAAM,SAAS,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAE9F;;;;;;;;GAQG;AACH,SAAS,4BAA4B,CAAC,OAAgB,EAAE,MAAe;IACnE,OAAO,CACH,MAAM,CAAC,OAAO,CAAC,KAAK,QAAQ;QAC5B,MAAM,CAAC,MAAM,CAAC,KAAK,UAAU;QAC7B,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,IAAI,IAAI,CAAC,CACtG,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,OAAgB,EAAE,MAAe;IAChE,OAAO,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AACvF,CAAC;AAED,SAAS,eAAe,CAAC,GAAW;IAChC,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,OAAgB;IAC1C,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC5B,OAAO,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAgB;IACvC,OAAO,oBAAoB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;AAC7E,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAgB;IACxC,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IACrC,OAAO,MAAM,KAAK,IAAI,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;AACzG,CAAC;AAED,SAAS,2BAA2B,CAAC,OAAgB;IACjD,OAAO,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;AACxG,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,YAAY,CAAqB,OAAgB;IAC7D,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAExD,OAAO;QACH,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACxC,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,CAAC;gBACjF,EAAE;gBACF,oBAAoB,EAAE,YAAY;gBAClC,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;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAE7C,MAAM,SAAS,GAAG,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAExD,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;gBACjC,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-be-empty-dom-element.d.ts

@@ -1,2 +1,15 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Assert whether an element has content or not.
+ * @example
+ * <span data-testid="not-empty">
+ *   <span data-testid="empty"></span>
+ * </span>
+ *
+ * expect(getByTestId('empty')).toBeEmptyDOMElement()
+ * expect(getByTestId('not-empty')).not.toBeEmptyDOMElement()
+ * @see
+ * [testing-library/jest-dom#tobeemptydomelement](https://github.com/testing-library/jest-dom#tobeemptydomelement)
+ */
 export declare function toBeEmptyDOMElement(this: MatcherState, element: Element): MatcherResult;

package/esm/matchers/to-be-empty-dom-element.js

@@ -1,4 +1,17 @@
 import { checkHtmlElement } from "./utils.js";
+/**
+ * @description
+ * Assert whether an element has content or not.
+ * @example
+ * <span data-testid="not-empty">
+ *   <span data-testid="empty"></span>
+ * </span>
+ *
+ * expect(getByTestId('empty')).toBeEmptyDOMElement()
+ * expect(getByTestId('not-empty')).not.toBeEmptyDOMElement()
+ * @see
+ * [testing-library/jest-dom#tobeemptydomelement](https://github.com/testing-library/jest-dom#tobeemptydomelement)
+ */
 export function toBeEmptyDOMElement(element) {
     checkHtmlElement(element, toBeEmptyDOMElement, this);
     return {

package/esm/matchers/to-be-empty-dom-element.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-be-empty-dom-element.js","sourceRoot":"","sources":["../../src/matchers/to-be-empty-dom-element.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,UAAU,mBAAmB,CAAqB,OAAgB;IACpE,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAErD,OAAO;QACH,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC;QAC7B,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,sBAAsB,EAAE,SAAS,EAAE,EAAE,CAAC;gBACxF,EAAE;gBACF,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;aACrD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CAAC,OAAgB;IACpC,MAAM,oBAAoB,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC;IAClG,OAAO,oBAAoB,CAAC,MAAM,KAAK,CAAC,CAAC;AAC7C,CAAC"}
+{"version":3,"file":"to-be-empty-dom-element.js","sourceRoot":"","sources":["../../src/matchers/to-be-empty-dom-element.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CAAqB,OAAgB;IACpE,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAErD,OAAO;QACH,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC;QAC7B,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,sBAAsB,EAAE,SAAS,EAAE,EAAE,CAAC;gBACxF,EAAE;gBACF,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;aACrD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CAAC,OAAgB;IACpC,MAAM,oBAAoB,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC;IAClG,OAAO,oBAAoB,CAAC,MAAM,KAAK,CAAC,CAAC;AAC7C,CAAC"}

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

@@ -1,3 +1,17 @@
 import type { MatcherResult, MatcherState } from "./types.js";
-/** @deprecated */
+/**
+ * @deprecated
+ * since v5.9.0
+ * @description
+ * Assert whether an element has content or not.
+ * @example
+ * <span data-testid="not-empty">
+ *   <span data-testid="empty"></span>
+ * </span>
+ *
+ * expect(getByTestId('empty')).toBeEmpty()
+ * expect(getByTestId('not-empty')).not.toBeEmpty()
+ * @see
+ * [testing-library/jest-dom#tobeempty](https://github.com/testing-library/jest-dom#tobeempty)
+ */
 export declare function toBeEmpty(this: MatcherState, element: Element): MatcherResult;

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

@@ -1,5 +1,19 @@
 import { checkHtmlElement, deprecate } from "./utils.js";
-/** @deprecated */
+/**
+ * @deprecated
+ * since v5.9.0
+ * @description
+ * Assert whether an element has content or not.
+ * @example
+ * <span data-testid="not-empty">
+ *   <span data-testid="empty"></span>
+ * </span>
+ *
+ * expect(getByTestId('empty')).toBeEmpty()
+ * expect(getByTestId('not-empty')).not.toBeEmpty()
+ * @see
+ * [testing-library/jest-dom#tobeempty](https://github.com/testing-library/jest-dom#tobeempty)
+ */
 export function toBeEmpty(element) {
     deprecate("toBeEmpty", "Please use instead toBeEmptyDOMElement for finding empty nodes in the DOM.");
     checkHtmlElement(element, toBeEmpty, this);

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

@@ -1 +1 @@
-{"version":3,"file":"to-be-empty.js","sourceRoot":"","sources":["../../src/matchers/to-be-empty.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEzD,kBAAkB;AAClB,MAAM,UAAU,SAAS,CAAqB,OAAgB;IAC1D,SAAS,CAAC,WAAW,EAAE,4EAA4E,CAAC,CAAC;IACrG,gBAAgB,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAE3C,OAAO;QACH,IAAI,EAAE,OAAO,CAAC,SAAS,KAAK,EAAE;QAC9B,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,YAAY,EAAE,SAAS,EAAE,EAAE,CAAC;gBAC9E,EAAE;gBACF,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;aACrD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-be-empty.js","sourceRoot":"","sources":["../../src/matchers/to-be-empty.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEzD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS,CAAqB,OAAgB;IAC1D,SAAS,CAAC,WAAW,EAAE,4EAA4E,CAAC,CAAC;IACrG,gBAAgB,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAE3C,OAAO;QACH,IAAI,EAAE,OAAO,CAAC,SAAS,KAAK,EAAE;QAC9B,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,YAAY,EAAE,SAAS,EAAE,EAAE,CAAC;gBAC9E,EAAE;gBACF,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;aACrD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-be-in-the-document.d.ts

@@ -1,2 +1,13 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Assert whether an element is present in the document or not.
+ * @example
+ * <svg data-testid="svg-element"></svg>
+ *
+ * expect(queryByTestId('svg-element')).toBeInTheDocument()
+ * expect(queryByTestId('does-not-exist')).not.toBeInTheDocument()
+ * @see
+ * [testing-library/jest-dom#tobeinthedocument](https://github.com/testing-library/jest-dom#tobeinthedocument)
+ */
 export declare function toBeInTheDocument(this: MatcherState, element: Element): MatcherResult;

package/esm/matchers/to-be-in-the-document.js

@@ -1,4 +1,15 @@
 import { checkHtmlElement } from "./utils.js";
+/**
+ * @description
+ * Assert whether an element is present in the document or not.
+ * @example
+ * <svg data-testid="svg-element"></svg>
+ *
+ * expect(queryByTestId('svg-element')).toBeInTheDocument()
+ * expect(queryByTestId('does-not-exist')).not.toBeInTheDocument()
+ * @see
+ * [testing-library/jest-dom#tobeinthedocument](https://github.com/testing-library/jest-dom#tobeinthedocument)
+ */
 export function toBeInTheDocument(element) {
     if (element !== null || !this.isNot) {
         checkHtmlElement(element, toBeInTheDocument, this);

package/esm/matchers/to-be-in-the-document.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-be-in-the-document.js","sourceRoot":"","sources":["../../src/matchers/to-be-in-the-document.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,UAAU,iBAAiB,CAAqB,OAAgB;IAClE,IAAI,OAAO,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClC,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,KAAK,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAE1G,MAAM,UAAU,GAAG,GAAG,EAAE;QACpB,OAAO,mDAAmD,IAAI,CAAC,KAAK,CAAC,SAAS,CAC1E,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAC1B,UAAU,CAAC;IAChB,CAAC,CAAC;IACF,MAAM,aAAa,GAAG,GAAG,EAAE;QACvB,OAAO,4CAA4C,CAAC;IACxD,CAAC,CAAC;IAEF,OAAO;QACH,IAAI;QACJ,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,oBAAoB,EAAE,SAAS,EAAE,EAAE,CAAC;gBACtF,EAAE;gBACF,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;aACzE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-be-in-the-document.js","sourceRoot":"","sources":["../../src/matchers/to-be-in-the-document.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAqB,OAAgB;IAClE,IAAI,OAAO,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClC,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,KAAK,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAE1G,MAAM,UAAU,GAAG,GAAG,EAAE;QACpB,OAAO,mDAAmD,IAAI,CAAC,KAAK,CAAC,SAAS,CAC1E,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAC1B,UAAU,CAAC;IAChB,CAAC,CAAC;IACF,MAAM,aAAa,GAAG,GAAG,EAAE;QACvB,OAAO,4CAA4C,CAAC;IACxD,CAAC,CAAC;IAEF,OAAO;QACH,IAAI;QACJ,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,oBAAoB,EAAE,SAAS,EAAE,EAAE,CAAC;gBACtF,EAAE;gBACF,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;aACzE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/esm/matchers/to-be-in-the-dom.d.ts

@@ -1,3 +1,14 @@
 import type { MatcherResult, MatcherState } from "./types.js";
-/** @deprecated */
+/**
+ * @deprecated
+ * since v1.9.0
+ * @description
+ * Assert whether a value is a DOM element, or not. Contrary to what its name
+ * implies, this matcher only checks that you passed to it a valid DOM
+ * element.
+ *
+ * It does not have a clear definition of what "the DOM" is. Therefore, it
+ * does not check whether that element is contained anywhere.
+ * @see [testing-library/jest-dom#toBeInTheDom](https://github.com/testing-library/jest-dom#toBeInTheDom)
+ */
 export declare function toBeInTheDOM(this: MatcherState, element: Element, container?: HTMLElement | SVGElement): MatcherResult;

package/esm/matchers/to-be-in-the-dom.js

@@ -1,5 +1,16 @@
 import { checkHtmlElement, deprecate } from "./utils.js";
-/** @deprecated */
+/**
+ * @deprecated
+ * since v1.9.0
+ * @description
+ * Assert whether a value is a DOM element, or not. Contrary to what its name
+ * implies, this matcher only checks that you passed to it a valid DOM
+ * element.
+ *
+ * It does not have a clear definition of what "the DOM" is. Therefore, it
+ * does not check whether that element is contained anywhere.
+ * @see [testing-library/jest-dom#toBeInTheDom](https://github.com/testing-library/jest-dom#toBeInTheDom)
+ */
 export function toBeInTheDOM(element, container) {
     deprecate("toBeInTheDOM", "Please use toBeInTheDocument for searching the entire document and toContainElement for searching a specific container.");
     if (element) {

package/esm/matchers/to-be-in-the-dom.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-be-in-the-dom.js","sourceRoot":"","sources":["../../src/matchers/to-be-in-the-dom.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEzD,kBAAkB;AAClB,MAAM,UAAU,YAAY,CAExB,OAAgB,EAChB,SAAoC;IAEpC,SAAS,CACL,cAAc,EACd,yHAAyH,CAC5H,CAAC;IAEF,IAAI,OAAO,EAAE,CAAC;QACV,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACZ,gBAAgB,CAAC,SAAS,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,OAAO;QACH,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO;QACzD,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,eAAe,EAAE,SAAS,EAAE,EAAE,CAAC;gBACjF,EAAE;gBACF,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE;aAChF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}
+{"version":3,"file":"to-be-in-the-dom.js","sourceRoot":"","sources":["../../src/matchers/to-be-in-the-dom.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEzD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAExB,OAAgB,EAChB,SAAoC;IAEpC,SAAS,CACL,cAAc,EACd,yHAAyH,CAC5H,CAAC;IAEF,IAAI,OAAO,EAAE,CAAC;QACV,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACZ,gBAAgB,CAAC,SAAS,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,OAAO;QACH,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO;QACzD,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,eAAe,EAAE,SAAS,EAAE,EAAE,CAAC;gBACjF,EAAE;gBACF,WAAW;gBACX,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE;aAChF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;KACJ,CAAC;AACN,CAAC"}

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

@@ -1,3 +1,39 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * Check if a form element, or the entire `form`, is currently invalid.
+ *
+ * An `input`, `select`, `textarea`, or `form` element is invalid if it has an `aria-invalid` attribute with no
+ * value or a value of "true", or if the result of `checkValidity()` is false.
+ * @example
+ * <input data-testid="no-aria-invalid" />
+ *
+ * <form data-testid="invalid-form">
+ *   <input required />
+ * </form>
+ *
+ * expect(getByTestId('no-aria-invalid')).not.toBeInvalid()
+ * expect(getByTestId('invalid-form')).toBeInvalid()
+ * @see
+ * [testing-library/jest-dom#tobeinvalid](https://github.com/testing-library/jest-dom#tobeinvalid)
+ */
 export declare function toBeInvalid(this: MatcherState, element: Element): MatcherResult;
+/**
+ * @description
+ * Allows you to check if a form element is currently required.
+ *
+ * An `input`, `select`, `textarea`, or `form` element is invalid if it has an `aria-invalid` attribute with no
+ * value or a value of "false", or if the result of `checkValidity()` is true.
+ * @example
+ * <input data-testid="aria-invalid" aria-invalid />
+ *
+ * <form data-testid="valid-form">
+ *   <input />
+ * </form>
+ *
+ * expect(getByTestId('no-aria-invalid')).not.toBeValid()
+ * expect(getByTestId('invalid-form')).toBeInvalid()
+ * @see
+ * [testing-library/jest-dom#tobevalid](https://github.com/testing-library/jest-dom#tobevalid)
+ */
 export declare function toBeValid(this: MatcherState, element: Element): MatcherResult;

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

@@ -15,6 +15,24 @@ function isElementInvalid(element) {
         return isHaveAriaInvalid;
     }
 }
+/**
+ * @description
+ * Check if a form element, or the entire `form`, is currently invalid.
+ *
+ * An `input`, `select`, `textarea`, or `form` element is invalid if it has an `aria-invalid` attribute with no
+ * value or a value of "true", or if the result of `checkValidity()` is false.
+ * @example
+ * <input data-testid="no-aria-invalid" />
+ *
+ * <form data-testid="invalid-form">
+ *   <input required />
+ * </form>
+ *
+ * expect(getByTestId('no-aria-invalid')).not.toBeInvalid()
+ * expect(getByTestId('invalid-form')).toBeInvalid()
+ * @see
+ * [testing-library/jest-dom#tobeinvalid](https://github.com/testing-library/jest-dom#tobeinvalid)
+ */
 export function toBeInvalid(element) {
     checkHtmlElement(element, toBeInvalid, this);
     const isInvalid = isElementInvalid(element);
@@ -31,6 +49,24 @@ export function toBeInvalid(element) {
         },
     };
 }
+/**
+ * @description
+ * Allows you to check if a form element is currently required.
+ *
+ * An `input`, `select`, `textarea`, or `form` element is invalid if it has an `aria-invalid` attribute with no
+ * value or a value of "false", or if the result of `checkValidity()` is true.
+ * @example
+ * <input data-testid="aria-invalid" aria-invalid />
+ *
+ * <form data-testid="valid-form">
+ *   <input />
+ * </form>
+ *
+ * expect(getByTestId('no-aria-invalid')).not.toBeValid()
+ * expect(getByTestId('invalid-form')).toBeInvalid()
+ * @see
+ * [testing-library/jest-dom#tobevalid](https://github.com/testing-library/jest-dom#tobevalid)
+ */
 export function toBeValid(element) {
     checkHtmlElement(element, toBeValid, this);
     const isValid = !isElementInvalid(element);

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

@@ -1 +1 @@
-{"version":3,"file":"to-be-invalid.js","sourceRoot":"","sources":["../../src/matchers/to-be-invalid.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEtD,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAE1D,SAAS,0BAA0B,CAAC,OAAgB;IAChD,OAAO,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC;AACpG,CAAC;AAED,SAAS,wBAAwB,CAC7B,OAAgB;IAEhB,OAAO,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB;IACtC,MAAM,iBAAiB,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAC9D,IAAI,wBAAwB,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,OAAO,iBAAiB,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IACzD,CAAC;SAAM,CAAC;QACJ,OAAO,iBAAiB,CAAC;IAC7B,CAAC;AACL,CAAC;AAED,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAE7C,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE5C,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,qBAAqB;gBAC3C,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;AAED,MAAM,UAAU,SAAS,CAAqB,OAAgB;IAC1D,gBAAgB,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAE3C,MAAM,OAAO,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE3C,OAAO;QACH,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACrC,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,CAAC;gBAC9E,EAAE;gBACF,oBAAoB,EAAE,mBAAmB;gBACzC,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-invalid.js","sourceRoot":"","sources":["../../src/matchers/to-be-invalid.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEtD,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAE1D,SAAS,0BAA0B,CAAC,OAAgB;IAChD,OAAO,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC;AACpG,CAAC;AAED,SAAS,wBAAwB,CAC7B,OAAgB;IAEhB,OAAO,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB;IACtC,MAAM,iBAAiB,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAC9D,IAAI,wBAAwB,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,OAAO,iBAAiB,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IACzD,CAAC;SAAM,CAAC;QACJ,OAAO,iBAAiB,CAAC;IAC7B,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,WAAW,CAAqB,OAAgB;IAC5D,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAE7C,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE5C,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,qBAAqB;gBAC3C,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;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,SAAS,CAAqB,OAAgB;IAC1D,gBAAgB,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IAE3C,MAAM,OAAO,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE3C,OAAO;QACH,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACrC,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,CAAC;gBAC9E,EAAE;gBACF,oBAAoB,EAAE,mBAAmB;gBACzC,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-be-partially-checked.d.ts

@@ -1,2 +1,39 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * This allows you to check whether the given element is partially checked.
+ * It accepts an input of type checkbox and elements with a role of checkbox
+ * with a aria-checked="mixed", or input of type checkbox with indeterminate
+ * set to true
+ *
+ * @example
+ * <input type="checkbox" aria-checked="mixed" data-testid="aria-checkbox-mixed" />
+ * <input type="checkbox" checked data-testid="input-checkbox-checked" />
+ * <input type="checkbox" data-testid="input-checkbox-unchecked" />
+ * <div role="checkbox" aria-checked="true" data-testid="aria-checkbox-checked" />
+ * <div
+ *   role="checkbox"
+ *   aria-checked="false"
+ *   data-testid="aria-checkbox-unchecked"
+ * />
+ * <input type="checkbox" data-testid="input-checkbox-indeterminate" />
+ *
+ * const ariaCheckboxMixed = getByTestId('aria-checkbox-mixed')
+ * const inputCheckboxChecked = getByTestId('input-checkbox-checked')
+ * const inputCheckboxUnchecked = getByTestId('input-checkbox-unchecked')
+ * const ariaCheckboxChecked = getByTestId('aria-checkbox-checked')
+ * const ariaCheckboxUnchecked = getByTestId('aria-checkbox-unchecked')
+ * const inputCheckboxIndeterminate = getByTestId('input-checkbox-indeterminate')
+ *
+ * expect(ariaCheckboxMixed).toBePartiallyChecked()
+ * expect(inputCheckboxChecked).not.toBePartiallyChecked()
+ * expect(inputCheckboxUnchecked).not.toBePartiallyChecked()
+ * expect(ariaCheckboxChecked).not.toBePartiallyChecked()
+ * expect(ariaCheckboxUnchecked).not.toBePartiallyChecked()
+ *
+ * inputCheckboxIndeterminate.indeterminate = true
+ * expect(inputCheckboxIndeterminate).toBePartiallyChecked()
+ * @see
+ * [testing-library/jest-dom#tobepartiallychecked](https://github.com/testing-library/jest-dom#tobepartiallychecked)
+ */
 export declare function toBePartiallyChecked(this: MatcherState, element: Element): MatcherResult;

package/esm/matchers/to-be-partially-checked.js

@@ -1,4 +1,41 @@
 import { checkHtmlElement } from "./utils.js";
+/**
+ * @description
+ * This allows you to check whether the given element is partially checked.
+ * It accepts an input of type checkbox and elements with a role of checkbox
+ * with a aria-checked="mixed", or input of type checkbox with indeterminate
+ * set to true
+ *
+ * @example
+ * <input type="checkbox" aria-checked="mixed" data-testid="aria-checkbox-mixed" />
+ * <input type="checkbox" checked data-testid="input-checkbox-checked" />
+ * <input type="checkbox" data-testid="input-checkbox-unchecked" />
+ * <div role="checkbox" aria-checked="true" data-testid="aria-checkbox-checked" />
+ * <div
+ *   role="checkbox"
+ *   aria-checked="false"
+ *   data-testid="aria-checkbox-unchecked"
+ * />
+ * <input type="checkbox" data-testid="input-checkbox-indeterminate" />
+ *
+ * const ariaCheckboxMixed = getByTestId('aria-checkbox-mixed')
+ * const inputCheckboxChecked = getByTestId('input-checkbox-checked')
+ * const inputCheckboxUnchecked = getByTestId('input-checkbox-unchecked')
+ * const ariaCheckboxChecked = getByTestId('aria-checkbox-checked')
+ * const ariaCheckboxUnchecked = getByTestId('aria-checkbox-unchecked')
+ * const inputCheckboxIndeterminate = getByTestId('input-checkbox-indeterminate')
+ *
+ * expect(ariaCheckboxMixed).toBePartiallyChecked()
+ * expect(inputCheckboxChecked).not.toBePartiallyChecked()
+ * expect(inputCheckboxUnchecked).not.toBePartiallyChecked()
+ * expect(ariaCheckboxChecked).not.toBePartiallyChecked()
+ * expect(ariaCheckboxUnchecked).not.toBePartiallyChecked()
+ *
+ * inputCheckboxIndeterminate.indeterminate = true
+ * expect(inputCheckboxIndeterminate).toBePartiallyChecked()
+ * @see
+ * [testing-library/jest-dom#tobepartiallychecked](https://github.com/testing-library/jest-dom#tobepartiallychecked)
+ */
 export function toBePartiallyChecked(element) {
     checkHtmlElement(element, toBePartiallyChecked, this);
     const isValidInput = () => {

package/esm/matchers/to-be-partially-checked.js.map

@@ -1 +1 @@
-{"version":3,"file":"to-be-partially-checked.js","sourceRoot":"","sources":["../../src/matchers/to-be-partially-checked.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,UAAU,oBAAoB,CAAqB,OAAgB;IACrE,gBAAgB,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;IAEtD,MAAM,YAAY,GAAG,GAAG,EAAE;QACtB,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO,IAAK,OAA4B,CAAC,IAAI,KAAK,UAAU,CAAC;IAC1G,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,GAAG,EAAE;QAC5B,OAAO,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC;IACvD,CAAC,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,kBAAkB,EAAE,EAAE,CAAC;QAC3C,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE,CACV,2KAA2K;SAClL,CAAC;IACN,CAAC;IAED,MAAM,kBAAkB,GAAG,GAAG,EAAE;QAC5B,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC;QAErE,IAAI,YAAY,EAAE,EAAE,CAAC;YACjB,OAAQ,OAA4B,CAAC,aAAa,IAAI,WAAW,CAAC;QACtE,CAAC;QAED,OAAO,WAAW,CAAC;IACvB,CAAC,CAAC;IAEF,OAAO;QACH,IAAI,EAAE,kBAAkB,EAAE;QAC1B,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YAClD,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,uBAAuB,EAAE,SAAS,EAAE,EAAE,CAAC;gBACzF,EAAE;gBACF,oBAAoB,EAAE,qBAAqB;gBAC3C,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-partially-checked.js","sourceRoot":"","sources":["../../src/matchers/to-be-partially-checked.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,UAAU,oBAAoB,CAAqB,OAAgB;IACrE,gBAAgB,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;IAEtD,MAAM,YAAY,GAAG,GAAG,EAAE;QACtB,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO,IAAK,OAA4B,CAAC,IAAI,KAAK,UAAU,CAAC;IAC1G,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,GAAG,EAAE;QAC5B,OAAO,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC;IACvD,CAAC,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,kBAAkB,EAAE,EAAE,CAAC;QAC3C,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,EAAE,CACV,2KAA2K;SAClL,CAAC;IACN,CAAC;IAED,MAAM,kBAAkB,GAAG,GAAG,EAAE;QAC5B,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC;QAErE,IAAI,YAAY,EAAE,EAAE,CAAC;YACjB,OAAQ,OAA4B,CAAC,aAAa,IAAI,WAAW,CAAC;QACtE,CAAC;QAED,OAAO,WAAW,CAAC;IACvB,CAAC,CAAC;IAEF,OAAO;QACH,IAAI,EAAE,kBAAkB,EAAE;QAC1B,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YAClD,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,uBAAuB,EAAE,SAAS,EAAE,EAAE,CAAC;gBACzF,EAAE;gBACF,oBAAoB,EAAE,qBAAqB;gBAC3C,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-be-required.d.ts

@@ -1,2 +1,19 @@
 import type { MatcherResult, MatcherState } from "./types.js";
+/**
+ * @description
+ * This allows you to check if a form element is currently required.
+ *
+ * An element is required if it is having a `required` or `aria-required="true"` attribute.
+ * @example
+ * <input data-testid="required-input" required />
+ * <div
+ *   data-testid="supported-role"
+ *   role="tree"
+ *   required />
+ *
+ * expect(getByTestId('required-input')).toBeRequired()
+ * expect(getByTestId('supported-role')).not.toBeRequired()
+ * @see
+ * [testing-library/jest-dom#toberequired](https://github.com/testing-library/jest-dom#toberequired)
+ */
 export declare function toBeRequired(this: MatcherState, element: Element): MatcherResult;

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

@@ -21,6 +21,23 @@ function isElementRequiredByARIA(element) {
             (element.hasAttribute("role") &&
                 SUPPORTED_ARIA_ROLES.includes(element.getAttribute("role") ?? ""))));
 }
+/**
+ * @description
+ * This allows you to check if a form element is currently required.
+ *
+ * An element is required if it is having a `required` or `aria-required="true"` attribute.
+ * @example
+ * <input data-testid="required-input" required />
+ * <div
+ *   data-testid="supported-role"
+ *   role="tree"
+ *   required />
+ *
+ * expect(getByTestId('required-input')).toBeRequired()
+ * expect(getByTestId('supported-role')).not.toBeRequired()
+ * @see
+ * [testing-library/jest-dom#toberequired](https://github.com/testing-library/jest-dom#toberequired)
+ */
 export function toBeRequired(element) {
     checkHtmlElement(element, toBeRequired, this);
     const isRequired = isRequiredOnFormTagsExceptInput(element) ||

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

@@ -1 +1 @@
-{"version":3,"file":"to-be-required.js","sourceRoot":"","sources":["../../src/matchers/to-be-required.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEtD,wCAAwC;AACxC,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;AAEzC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAEvD,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAEzF,MAAM,oBAAoB,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;AAE1F,SAAS,+BAA+B,CAAC,OAAgB;IACrD,OAAO,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,0BAA0B,CAAC,OAAgB;IAChD,OAAO,CACH,MAAM,CAAC,OAAO,CAAC,KAAK,OAAO;QAC3B,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC;QAChC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;YAC1B,CAAC,uBAAuB,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACtE,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CACrC,CAAC;AACN,CAAC;AAED,SAAS,uBAAuB,CAAC,OAAgB;IAC7C,OAAO,CACH,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC;QACrC,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,KAAK,MAAM;QAChD,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACrC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;gBACzB,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAC9E,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAqB,OAAgB;IAC7D,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAE9C,MAAM,UAAU,GACZ,+BAA+B,CAAC,OAAO,CAAC;QACxC,0BAA0B,CAAC,OAAO,CAAC;QACnC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAErC,OAAO;QACH,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACxC,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,CAAC;gBACjF,EAAE;gBACF,oBAAoB,EAAE,YAAY;gBAClC,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-required.js","sourceRoot":"","sources":["../../src/matchers/to-be-required.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEtD,wCAAwC;AACxC,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;AAEzC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAEvD,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAEzF,MAAM,oBAAoB,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;AAE1F,SAAS,+BAA+B,CAAC,OAAgB;IACrD,OAAO,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,0BAA0B,CAAC,OAAgB;IAChD,OAAO,CACH,MAAM,CAAC,OAAO,CAAC,KAAK,OAAO;QAC3B,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC;QAChC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;YAC1B,CAAC,uBAAuB,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACtE,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CACrC,CAAC;AACN,CAAC;AAED,SAAS,uBAAuB,CAAC,OAAgB;IAC7C,OAAO,CACH,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC;QACrC,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,KAAK,MAAM;QAChD,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACrC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;gBACzB,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAC9E,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,YAAY,CAAqB,OAAgB;IAC7D,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAE9C,MAAM,UAAU,GACZ,+BAA+B,CAAC,OAAO,CAAC;QACxC,0BAA0B,CAAC,OAAO,CAAC;QACnC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAErC,OAAO;QACH,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,GAAG,EAAE;YACV,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YACxC,OAAO;gBACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,CAAC;gBACjF,EAAE;gBACF,oBAAoB,EAAE,YAAY;gBAClC,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"}