added _I scroll to {string}_ step (#65)

AlexGalichenko · Oleksandr_Halichenko · web-flow · commit 2a058c39df11 · 2023-08-16T10:51:52.000+03:00
Co-authored-by: Oleksandr_Halichenko &lt;oleksandr_halichenko@epam.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :beetle: - bugfix
 :x: - deprecation
 
+## [0.31.0]
+- :rocket: added _I scroll to {string}_ step
+
 ## [0.30.0]
 Deprecated:
 - :x: screenshot property moved to browser/driver config.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/steps-playwright",
-  "version": "0.30.0",
+  "version": "0.31.0",
   "description": "steps to interact with playwright",
   "main": "./index.js",
   "scripts": {
@@ -23,11 +23,11 @@
   },
   "homepage": "https://github.com/qavajs/steps-playwright#readme",
   "devDependencies": {
-    "@cucumber/cucumber": "^9.3.0",
-    "@qavajs/cli": "^0.27.0",
+    "@cucumber/cucumber": "^9.4.0",
+    "@qavajs/cli": "^0.28.0",
     "@qavajs/console-formatter": "^0.5.0",
-    "@qavajs/html-formatter": "^0.13.0",
-    "@qavajs/memory": "^1.6.1",
+    "@qavajs/html-formatter": "^0.14.0",
+    "@qavajs/memory": "^1.6.2",
     "@qavajs/po-playwright": "^0.11.0",
     "@qavajs/webstorm-adapter": "^8.0.0",
     "@qavajs/xunit-formatter": "^0.0.4",
@@ -38,11 +38,11 @@
     "express": "^4.18.2",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.6",
-    "vitest": "^0.33.0"
+    "vitest": "^0.34.1"
   },
   "dependencies": {
-    "@playwright/test": "^1.36.2",
+    "@playwright/test": "^1.37.0",
     "@qavajs/validation": "^0.6.0",
-    "playwright": "^1.36.2"
+    "playwright": "^1.37.0"
   }
 }
diff --git a/src/actions.ts b/src/actions.ts
@@ -242,6 +242,16 @@ When('I scroll by {string}', async function (offset: string) {
     }, [x, y]);
 });
 
+/**
+ * Scroll to element
+ * @param {string} alias - alias of element
+ * @example I scroll to 'Element'
+ */
+When('I scroll to {string}', async function (alias) {
+    const element = await getElement(alias);
+    await element.scrollIntoViewIfNeeded();
+});
+
 /**
  * Scroll by provided offset in element
  * @param {string} - offset string in 'x, y' format
diff --git a/test-e2e/apps/scroll.html b/test-e2e/apps/scroll.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>@qavajs</title>
+    <style>
+        body {
+            height: 4000px;
+            width: 3000px;
+        }
+        #scrollElement {
+            position: absolute;
+            top: 3000px;
+            left: 2000px;
+        }
+    </style>
+</head>
+<body>
+<div id="scrollElement">I'm here</div>
+</body>
+</html>
diff --git a/test-e2e/features/scroll.feature b/test-e2e/features/scroll.feature
@@ -0,0 +1,11 @@
+Feature: scroll
+
+  Background:
+    When I open '$scrollPage' url
+
+  Scenario: scroll to element wait
+    When I scroll to 'Scroll Element'
+    Then I wait until 'Scroll Element' to be in viewport
+
+  Scenario: scroll to element wait
+    Then I expect 'Scroll Element' not to be in viewport
diff --git a/test-e2e/memory/index.ts b/test-e2e/memory/index.ts
@@ -9,7 +9,7 @@ export default class Memory {
     mockPage = file(resolve('./test-e2e/apps/mock.html'));
     storagePage = file(resolve('./test-e2e/apps/storage.html'));
     dragDropPage = file(resolve('./test-e2e/apps/dragdrop.html'));
-
+    scrollPage = file(resolve('./test-e2e/apps/scroll.html'));
     array = (...args: Array<any>) => args;
 
     // @ts-ignore
diff --git a/test-e2e/page_object/index.ts b/test-e2e/page_object/index.ts
@@ -48,6 +48,7 @@ export default class App {
     EventHandler = $('#mouseEvent');
     KeyboardEventHandler = $('#keyboardEvent');
 
+    ScrollElement = $('#scrollElement');
 }
 
 class IgnoreHierarchyComponent extends Component {
diff --git a/test-e2e/webui.ts b/test-e2e/webui.ts
@@ -34,7 +34,6 @@ const common = {
     memory: new Memory(),
     pageObject: new App(),
     parallel: 4,
-    publishQuiet: true,
     retry: 1,
     service: [localServer],
     tags: 'not @skip'

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ export default class App {`
`48`	`48`	`EventHandler = $('#mouseEvent');`
`49`	`49`	`KeyboardEventHandler = $('#keyboardEvent');`
`50`	`50`
	`51`	`+ ScrollElement = $('#scrollElement');`
`51`	`52`	`}`
`52`	`53`
`53`	`54`	`class IgnoreHierarchyComponent extends Component {`