From d99a29658bb7c5f34ce1966d7b2de78e09348e6c Mon Sep 17 00:00:00 2001 From: karishmas6 Date: Sat, 8 Jun 2024 22:59:31 +0530 Subject: [PATCH] docs: wheel event handler --- server/src/browser-management/inputHandlers.ts | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/server/src/browser-management/inputHandlers.ts b/server/src/browser-management/inputHandlers.ts index 000244da..10d5f1ab 100644 --- a/server/src/browser-management/inputHandlers.ts +++ b/server/src/browser-management/inputHandlers.ts @@ -147,6 +147,17 @@ const onWheel = async (scrollDeltas: ScrollDeltas) => { await handleWrapper(handleWheel, scrollDeltas); }; +/** + * A wheel event handler. + * Reproduces the wheel event on the remote browser instance. + * Scroll is not generated for the workflow pair. This is because + * Playwright scrolls elements into focus on any action. + * @param generator - the workflow generator {@link Generator} + * @param page - the active page of the remote browser + * @param deltaX - the delta x of the wheel event + * @param deltaY - the delta y of the wheel event + * @category BrowserManagement + */ const handleWheel = async (generator: WorkflowGenerator, page: Page, { deltaX, deltaY }: ScrollDeltas) => { await page.mouse.wheel(deltaX, deltaY); logger.log('debug', `Scrolled horizontally ${deltaX} pixels and vertically ${deltaY} pixels`);