fix(types): Accept false as valid scrollBehavior value (#40)

dmtrKovalenko · Apr 18, 2021 · 3f7c7d7 · 3f7c7d7
1 parent 4462edb
commit 3f7c7d7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -103,7 +103,8 @@ Options:
 - `Optional` **pointer**: \"mouse\" \| \"pen\"
 - `Optional` x coordinate to click **x**: number
 - `Optional` y coordinate to click **y**: number
-- `Optional`  **position**: "topLeft" | "top" | "topRight" | "left"  | "center" | "right" | "bottomLeft" | "bottom" | "bottomRight"
+- `Optional` **position**: "topLeft" | "top" | "topRight" | "left"  | "center" | "right" | "bottomLeft" | "bottom" | "bottomRight"
+- `Optional` **scrollBehavior**: "center" | "top" | "bottom" | "nearest" | false
 
 > Make sure that `x` and `y` has a bigger priority than `position`.
 
@@ -120,6 +121,7 @@ Options:
 
 - `Optional` **pointer**: \"mouse\" \| \"pen\"
 - `Optional` **position**: "topLeft" | "top" | "topRight" | "left"  | "center" | "right" | "bottomLeft" | "bottom" | "bottomRight"
+- `Optional` **scrollBehavior**: "center" | "top" | "bottom" | "nearest" | false
 
 ## cy.realPress
 

diff --git a/src/getCypressElementCoordinates.ts b/src/getCypressElementCoordinates.ts
@@ -10,7 +10,8 @@ export type Position =
   | "bottomRight"
   | { x: number; y: number };
 
-export type ScrollBehaviorOptions = "center" | "top" | "bottom" | "nearest";
+type ScrollBehaviorPosition = "center" | "top" | "bottom" | "nearest";
+export type ScrollBehaviorOptions = ScrollBehaviorPosition | false;
 
 function getPositionedCoordinates(
   x0: number,
@@ -52,7 +53,7 @@ function getPositionedCoordinates(
  */
 function scrollIntoView(
   htmlElement: HTMLElement,
-  scrollBehavior: ScrollBehaviorOptions = "center"
+  scrollBehavior: ScrollBehaviorPosition = "center"
 ) {
   let block: ScrollLogicalPosition;