Merge pull request #21 from ShellyDCMS/add-get-slot-text

Get text from slot
ShellyDCMS · Sep 30, 2023 · 4e84496 · 4e84496
2 parents accd48f + 6c07c67
commit 4e84496
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 7 deletions.
diff --git a/documents/classes/CypressAngularComponentHelper.md b/documents/classes/CypressAngularComponentHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v1.0.33](../README.md) / [Modules](../modules.md) / CypressAngularComponentHelper
+[@shellygo/cypress-test-utils - v1.0.34](../README.md) / [Modules](../modules.md) / CypressAngularComponentHelper
 
 # Class: CypressAngularComponentHelper<T\>
 

diff --git a/documents/classes/CypressHelper.md b/documents/classes/CypressHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v1.0.33](../README.md) / [Modules](../modules.md) / CypressHelper
+[@shellygo/cypress-test-utils - v1.0.34](../README.md) / [Modules](../modules.md) / CypressHelper
 
 # Class: CypressHelper
 
@@ -69,6 +69,7 @@ The get property will hold methods which will give our tests access to the “ou
 | `requestHeader` | (`alias`: `string`) => `Chainable`<{ `[key: string]`: `string` \| `string`[];  }\> |
 | `requestQueryParams` | (`alias`: `string`) => `Chainable`<{ `[k: string]`: `string`;  }\> |
 | `requestUrl` | (`alias`: `string`) => `Chainable`<`string`\> |
+| `slotText` | (`selector`: `string`, `index?`: `number`) => `Chainable`<``null`` \| `JQuery`<`HTMLSlotElement`\>\> \| `Chainable`<`string` \| `JQuery`<`HTMLSlotElement`\>\> |
 | `spy` | (`name`: `string`) => `Chainable`<`JQuery`<`HTMLElement`\>\> |
 | `spyFromFunction` | (`func`: `Function`) => `Chainable`<`JQuery`<`HTMLElement`\>\> |
 | `stub` | (`name`: `string`) => `Chainable`<`JQuery`<`HTMLElement`\>\> |
@@ -237,6 +238,18 @@ Get intercepted request's url
 
 -----
 
+**slotText**: (`selector`: `string`, `index?`: `number`) => `Chainable`<``null`` \| `JQuery`<`HTMLSlotElement`\>\> \| `Chainable`<`string` \| `JQuery`<`HTMLSlotElement`\>\>
+
+To be used with shadow DOM only
+
+**`Example`**
+
+```ts
+expect(helper.get.slotText("main-cta-button", 2).should("include", "CTA"))
+```
+
+-----
+
 **spy**: (`name`: `string`) => `Chainable`<`JQuery`<`HTMLElement`\>\>
 
 Get spy by alias

diff --git a/documents/classes/CypressLitComponentHelper.md b/documents/classes/CypressLitComponentHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v1.0.33](../README.md) / [Modules](../modules.md) / CypressLitComponentHelper
+[@shellygo/cypress-test-utils - v1.0.34](../README.md) / [Modules](../modules.md) / CypressLitComponentHelper
 
 # Class: CypressLitComponentHelper
 

diff --git a/documents/classes/CypressReactComponentHelper.md b/documents/classes/CypressReactComponentHelper.md
@@ -1,4 +1,4 @@
-[@shellygo/cypress-test-utils - v1.0.33](../README.md) / [Modules](../modules.md) / CypressReactComponentHelper
+[@shellygo/cypress-test-utils - v1.0.34](../README.md) / [Modules](../modules.md) / CypressReactComponentHelper
 
 # Class: CypressReactComponentHelper
 

diff --git a/documents/modules.md b/documents/modules.md
@@ -1,6 +1,6 @@
-[@shellygo/cypress-test-utils - v1.0.33](README.md) / Modules
+[@shellygo/cypress-test-utils - v1.0.34](README.md) / Modules
 
-# @shellygo/cypress-test-utils - v1.0.33
+# @shellygo/cypress-test-utils - v1.0.34
 
 ## Table of contents
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@shellygo/cypress-test-utils",
   "description": "Test Automation Utilities",
-  "version": "1.0.33",
+  "version": "1.0.34",
   "author": "Shelly Goldblit",
   "private": false,
   "license": "MIT",

diff --git a/src/cypress-helper-spec.cy.ts b/src/cypress-helper-spec.cy.ts
@@ -221,6 +221,10 @@ describe("cypress helper tests", () => {
     get.elementsText("header").should("eq", "My First Heading");
   });
 
+  it.skip("should get slot's text", () => {
+    get.slotText("with-slot").should("eq", "Text in Slot");
+  });
+
   it("should get env variable", () => {
     expect(get.env("env1")).to.eq("value1");
   });

diff --git a/src/cypress-helper.ts b/src/cypress-helper.ts
@@ -442,6 +442,21 @@ export class CypressHelper {
       index: number = 0
     ): Cypress.Chainable<string> =>
       this.get.nthBySelector(selector, index).invoke("text"),
+    /**
+     * To be used with shadow DOM only
+     * @example
+     * ```ts
+     * expect(helper.get.slotText("main-cta-button", 2).should("include", "CTA"))
+     * ```
+     * @param selector
+     * @param [index = 0]
+     * @returns {Cypress.Chainable<string>}
+     */
+    slotText: (selector: string, index: number = 0) =>
+      this.get
+        .nthBySelector(selector, index)
+        .find("slot")
+        .then(slot => slot.get(0).assignedNodes()[0].textContent),
     /**
      * Get value of input element
      * @example