feat: add displayed to chai

victormejia · Oct 2, 2019 · d301ec8 · d301ec8
1 parent 0515b8b
commit d301ec8
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 2 deletions.
diff --git a/doc/chai.md b/doc/chai.md
@@ -9,6 +9,7 @@ We added a few helpers to add additional context and reduce boilerplate. They tu
 *   [`.text`](#text)
 *   [`.value`](#value)
 *   [`.enabled`](#enabled)
+*   [`.displayed`](#displayed)
 *   [`.exist`](#exist)
 *   [`.elements`](#elements)
 
@@ -72,6 +73,18 @@ expect(await pageObject.isEnabled()).to.be.ok;
 await expect(pageObject).enabled.to.eventually.be.ok;
 ```
 
+### `.displayed`
+
+```js
+// before
+expect(await pageObject.isDisplayed()).to.be.ok;
+```
+
+```js
+// after
+await expect(pageObject).displayed.to.eventually.be.ok;
+```
+
 ### `.exist`
 
 ```js

diff --git a/packages/chai/index.js b/packages/chai/index.js
@@ -38,6 +38,12 @@ const properties = {
     pageObjectMethod: 'isEnabled',
     pageObjectString: 'element',
   },
+  displayed: {
+    type: 'addProperty',
+    PageObject: Element,
+    pageObjectMethod: 'isDisplayed',
+    pageObjectString: 'element',
+  },
   exist: {
     type: 'overwriteProperty',
     PageObject: BaseElement,

diff --git a/packages/chai/package.json b/packages/chai/package.json
@@ -32,7 +32,7 @@
     "sinon": "^7.3.2"
   },
   "peerDependencies": {
-    "@faltest/browser": "",
-    "@faltest/page-objects": ""
+    "@faltest/browser": ">=1.3.0",
+    "@faltest/page-objects": ">=1.7.0"
   }
 }
diff --git a/packages/chai/test/integration/index-test.js b/packages/chai/test/integration/index-test.js
@@ -186,6 +186,16 @@ describe(function() {
       fail: 'expected false to be truthy',
       failNegated: 'expected true to be falsy',
     },
+    displayed: {
+      PageObject: Element,
+      pageObjectMethod: 'isDisplayed',
+      actualPass: true,
+      actualFail: false,
+      append: expectTo => expectTo.be.ok,
+      pageObjectString: 'element',
+      fail: 'expected false to be truthy',
+      failNegated: 'expected true to be falsy',
+    },
     exist: {
       builtIn: Promise.resolve(true),
       PageObject: BaseElement,