From 31c892f74d16101689742f796e6cc8ce53f19f57 Mon Sep 17 00:00:00 2001 From: Mathias Bynens Date: Mon, 12 Jul 2021 09:29:44 +0200 Subject: [PATCH] feat(api): make `page.isDragInterceptionEnabled` a method Having it be a getter is surprising and inconsistent, since the other `page.is*` APIs are just methods. Issue: #7150 --- docs/api.md | 4 ++-- src/common/JSHandle.ts | 2 +- src/common/Page.ts | 11 +++++++---- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/api.md b/docs/api.md index 3168c5d17f887..852dbce73fa51 100644 --- a/docs/api.md +++ b/docs/api.md @@ -157,7 +157,7 @@ * [page.goto(url[, options])](#pagegotourl-options) * [page.hover(selector)](#pagehoverselector) * [page.isClosed()](#pageisclosed) - * [page.isDragInterceptionEnabled](#pageisdraginterceptionenabled) + * [page.isDragInterceptionEnabled()](#pageisdraginterceptionenabled) * [page.isJavaScriptEnabled()](#pageisjavascriptenabled) * [page.keyboard](#pagekeyboard) * [page.mainFrame()](#pagemainframe) @@ -2008,7 +2008,7 @@ Shortcut for [page.mainFrame().hover(selector)](#framehoverselector). Indicates that the page has been closed. -#### page.isDragInterceptionEnabled +#### page.isDragInterceptionEnabled() - returns: <[boolean]> diff --git a/src/common/JSHandle.ts b/src/common/JSHandle.ts index cd70f67f26d25..03e9102ce70df 100644 --- a/src/common/JSHandle.ts +++ b/src/common/JSHandle.ts @@ -504,7 +504,7 @@ export class ElementHandle< */ async drag(target: Point): Promise { assert( - this._page.isDragInterceptionEnabled, + this._page.isDragInterceptionEnabled(), 'Drag Interception is not enabled!' ); await this._scrollIntoViewIfNeeded(); diff --git a/src/common/Page.ts b/src/common/Page.ts index 5343e2de90deb..3be8564b9ebd6 100644 --- a/src/common/Page.ts +++ b/src/common/Page.ts @@ -600,6 +600,13 @@ export class Page extends EventEmitter { for (const interceptor of interceptors) interceptor.call(null, fileChooser); } + /** + * @returns `true` if drag events are being intercepted, `false` otherwise. + */ + isDragInterceptionEnabled(): boolean { + return this._userDragInterceptionEnabled; + } + /** * @returns `true` if the page has JavaScript enabled, `false` otherwise. */ @@ -777,10 +784,6 @@ export class Page extends EventEmitter { return this._accessibility; } - get isDragInterceptionEnabled(): boolean { - return this._userDragInterceptionEnabled; - } - /** * @returns An array of all frames attached to the page. */