Add ScrollOption for native full page screenshot (#169)

saucelabs · Dec 18, 2024 · d6f02a8 · d6f02a8
1 parent bc9e061
commit d6f02a8
Show file tree

Hide file tree

Showing 3 changed files with 114 additions and 5 deletions.
diff --git a/visual-js/.changeset/silent-jeans-reflect.md b/visual-js/.changeset/silent-jeans-reflect.md
@@ -0,0 +1,7 @@
+---
+"@saucelabs/visual": minor
+"@saucelabs/nightwatch-sauce-visual-service": minor
+"@saucelabs/wdio-sauce-visual-service": minor
+---
+
+Added control over scrolling to the top before and after capturing a native full-page screenshot.
diff --git a/visual-js/visual/src/graphql/__generated__/graphql.ts b/visual-js/visual/src/graphql/__generated__/graphql.ts
diff --git a/visual-js/visual/src/types.ts b/visual-js/visual/src/types.ts
@@ -1,4 +1,8 @@
-import { RegionIn, SelectorIn } from './graphql/__generated__/graphql';
+import {
+  RegionIn,
+  ScrollOption,
+  SelectorIn,
+} from './graphql/__generated__/graphql';
 import { SelectiveRegionOptions } from './common/selective-region';
 import { SauceRegion } from './common/regions';
 
@@ -34,6 +38,10 @@ export type FullPageScreenshotOptions<T> =
        * Selector of an element that we should crop the screenshot to. Available only on native apps.
        */
       nativeClipSelector?: SelectorIn;
+      /**
+       * Change scroll behaviour before and after taking full page screenshot. Available only on native apps.
+       */
+      scrollOption?: ScrollOption;
     };
 
 export type Ignorable<T> = T | T[] | Promise<T> | Promise<T[]> | RegionIn;