dom-testing-library - npm Package Compare versions

Comparing version 1.10.1 to 1.11.0

dist/queries.js

@@ -6,3 +6,3 @@ 'use strict';
 });
-exports.getAllByTestId = exports.getByTestId = exports.queryAllByTestId = exports.queryByTestId = exports.getAllByAltText = exports.getByAltText = exports.queryAllByAltText = exports.queryByAltText = exports.getAllByLabelText = exports.getByLabelText = exports.queryAllByLabelText = exports.queryByLabelText = exports.getAllByText = exports.getByText = exports.queryAllByText = exports.queryByText = exports.getAllByPlaceholderText = exports.getByPlaceholderText = exports.queryAllByPlaceholderText = exports.queryByPlaceholderText = undefined;
+exports.getAllByTitle = exports.getByTitle = exports.queryAllByTitle = exports.queryByTitle = exports.getAllByTestId = exports.getByTestId = exports.queryAllByTestId = exports.queryByTestId = exports.getAllByAltText = exports.getByAltText = exports.queryAllByAltText = exports.queryByAltText = exports.getAllByLabelText = exports.getByLabelText = exports.queryAllByLabelText = exports.queryByLabelText = exports.getAllByText = exports.getByText = exports.queryAllByText = exports.queryByText = exports.getAllByPlaceholderText = exports.getByPlaceholderText = exports.queryAllByPlaceholderText = exports.queryByPlaceholderText = undefined;
 
@@ -90,2 +90,38 @@ var _matches = require('./matches');
 
+var queryAllByTitle = function () {
+  for (var _len2 = arguments.length, args = Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+    args[_key2] = arguments[_key2];
+  }
+
+  return queryAllByAttribute.apply(undefined, ['title'].concat(args, [{ exact: true }]));
+};
+
+var queryByTitle = function () {
+  for (var _len3 = arguments.length, args = Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
+    args[_key3] = arguments[_key3];
+  }
+
+  return queryByAttribute.apply(undefined, ['title'].concat(args, [{ exact: true }]));
+};
+
+function getAllByTitle(container, title) {
+  for (var _len4 = arguments.length, rest = Array(_len4 > 2 ? _len4 - 2 : 0), _key4 = 2; _key4 < _len4; _key4++) {
+    rest[_key4 - 2] = arguments[_key4];
+  }
+
+  var els = queryAllByTitle.apply(undefined, [container, title].concat(rest));
+  if (!els.length) {
+    throw new Error(`Unable to find an element with the title: ${title}. \n\n${debugDOM(container)}`);
+  }
+  return els;
+}
+
+function getByTitle() {
+  for (var _len5 = arguments.length, args = Array(_len5), _key5 = 0; _key5 < _len5; _key5++) {
+    args[_key5] = arguments[_key5];
+  }
+
+  return firstResultOrNull.apply(undefined, [getAllByTitle].concat(args));
+}
+
 // this is just a utility and not an exposed query.
@@ -107,4 +143,4 @@ // There are no plans to expose this.
 function queryByAttribute() {
-  for (var _len2 = arguments.length, args = Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-    args[_key2] = arguments[_key2];
+  for (var _len6 = arguments.length, args = Array(_len6), _key6 = 0; _key6 < _len6; _key6++) {
+    args[_key6] = arguments[_key6];
   }
@@ -118,4 +154,4 @@
 var queryByTestId = function () {
-  for (var _len3 = arguments.length, args = Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
-    args[_key3] = arguments[_key3];
+  for (var _len7 = arguments.length, args = Array(_len7), _key7 = 0; _key7 < _len7; _key7++) {
+    args[_key7] = arguments[_key7];
   }
@@ -126,4 +162,4 @@
 var queryAllByTestId = function () {
-  for (var _len4 = arguments.length, args = Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
-    args[_key4] = arguments[_key4];
+  for (var _len8 = arguments.length, args = Array(_len8), _key8 = 0; _key8 < _len8; _key8++) {
+    args[_key8] = arguments[_key8];
   }
@@ -150,4 +186,4 @@
 function getAllByTestId(container, id) {
-  for (var _len5 = arguments.length, rest = Array(_len5 > 2 ? _len5 - 2 : 0), _key5 = 2; _key5 < _len5; _key5++) {
-    rest[_key5 - 2] = arguments[_key5];
+  for (var _len9 = arguments.length, rest = Array(_len9 > 2 ? _len9 - 2 : 0), _key9 = 2; _key9 < _len9; _key9++) {
+    rest[_key9 - 2] = arguments[_key9];
   }
@@ -163,4 +199,4 @@
 function getByTestId() {
-  for (var _len6 = arguments.length, args = Array(_len6), _key6 = 0; _key6 < _len6; _key6++) {
-    args[_key6] = arguments[_key6];
+  for (var _len10 = arguments.length, args = Array(_len10), _key10 = 0; _key10 < _len10; _key10++) {
+    args[_key10] = arguments[_key10];
   }
@@ -172,4 +208,4 @@
 function getAllByPlaceholderText(container, text) {
-  for (var _len7 = arguments.length, rest = Array(_len7 > 2 ? _len7 - 2 : 0), _key7 = 2; _key7 < _len7; _key7++) {
-    rest[_key7 - 2] = arguments[_key7];
+  for (var _len11 = arguments.length, rest = Array(_len11 > 2 ? _len11 - 2 : 0), _key11 = 2; _key11 < _len11; _key11++) {
+    rest[_key11 - 2] = arguments[_key11];
   }
@@ -185,4 +221,4 @@
 function getByPlaceholderText() {
-  for (var _len8 = arguments.length, args = Array(_len8), _key8 = 0; _key8 < _len8; _key8++) {
-    args[_key8] = arguments[_key8];
+  for (var _len12 = arguments.length, args = Array(_len12), _key12 = 0; _key12 < _len12; _key12++) {
+    args[_key12] = arguments[_key12];
   }
@@ -194,4 +230,4 @@
 function getAllByLabelText(container, text) {
-  for (var _len9 = arguments.length, rest = Array(_len9 > 2 ? _len9 - 2 : 0), _key9 = 2; _key9 < _len9; _key9++) {
-    rest[_key9 - 2] = arguments[_key9];
+  for (var _len13 = arguments.length, rest = Array(_len13 > 2 ? _len13 - 2 : 0), _key13 = 2; _key13 < _len13; _key13++) {
+    rest[_key13 - 2] = arguments[_key13];
   }
@@ -212,4 +248,4 @@
 function getByLabelText() {
-  for (var _len10 = arguments.length, args = Array(_len10), _key10 = 0; _key10 < _len10; _key10++) {
-    args[_key10] = arguments[_key10];
+  for (var _len14 = arguments.length, args = Array(_len14), _key14 = 0; _key14 < _len14; _key14++) {
+    args[_key14] = arguments[_key14];
   }
@@ -221,4 +257,4 @@
 function getAllByText(container, text) {
-  for (var _len11 = arguments.length, rest = Array(_len11 > 2 ? _len11 - 2 : 0), _key11 = 2; _key11 < _len11; _key11++) {
-    rest[_key11 - 2] = arguments[_key11];
+  for (var _len15 = arguments.length, rest = Array(_len15 > 2 ? _len15 - 2 : 0), _key15 = 2; _key15 < _len15; _key15++) {
+    rest[_key15 - 2] = arguments[_key15];
   }
@@ -234,4 +270,4 @@
 function getByText() {
-  for (var _len12 = arguments.length, args = Array(_len12), _key12 = 0; _key12 < _len12; _key12++) {
-    args[_key12] = arguments[_key12];
+  for (var _len16 = arguments.length, args = Array(_len16), _key16 = 0; _key16 < _len16; _key16++) {
+    args[_key16] = arguments[_key16];
   }
@@ -251,4 +287,4 @@
 function getByAltText() {
-  for (var _len13 = arguments.length, args = Array(_len13), _key13 = 0; _key13 < _len13; _key13++) {
-    args[_key13] = arguments[_key13];
+  for (var _len17 = arguments.length, args = Array(_len17), _key17 = 0; _key17 < _len17; _key17++) {
+    args[_key17] = arguments[_key17];
   }
@@ -279,3 +315,7 @@
 exports.getAllByTestId = getAllByTestId;
+exports.queryByTitle = queryByTitle;
+exports.queryAllByTitle = queryAllByTitle;
+exports.getByTitle = getByTitle;
+exports.getAllByTitle = getAllByTitle;
 
 /* eslint complexity:["error", 14] */

package.json

 {
   "name": "dom-testing-library",
-  "version": "1.10.1",
+  "version": "1.11.0",
   "description": "Simple and complete DOM testing utilities that encourage good testing practices.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -79,2 +79,3 @@ <div align="center">
   * [`getByAltText(container: HTMLElement, text: TextMatch): HTMLElement`](#getbyalttextcontainer-htmlelement-text-textmatch-htmlelement)
+  * [`getByTitle(container: HTMLElement, title: ExactTextMatch): HTMLElement`](#getbytitlecontainer-htmlelement-title-exacttextmatch-htmlelement)
   * [`getByTestId(container: HTMLElement, text: ExactTextMatch): HTMLElement`](#getbytestidcontainer-htmlelement-text-exacttextmatch-htmlelement)
@@ -254,2 +255,11 @@ * [`wait`](#wait)
 
+### `getByTitle(container: HTMLElement, title: ExactTextMatch): HTMLElement`
+
+This will return the element that has the matching `title` attribute.
+
+```javascript
+// <span title="Delete" id="2" />
+const deleteElement = getByTitle(container, 'Delete')
+```
+
 ### `getByTestId(container: HTMLElement, text: ExactTextMatch): HTMLElement`
@@ -256,0 +266,0 @@

No alert changes

Improved metrics

Total package byte prevSize

70527

increased by2.73%

Lines of code

830

increased by4.14%

Number of lines in readme file

798

increased by1.27%

No dependency changes