@applitools/screenshoter/src/scroll-into-viewport.js

Applitools universal screenshoter for web and native applications

const utils = require('@applitools/utils')

async function scrollIntoViewport({context, scroller, region}) {
  const elementContextRegion = region ? {...region} : await scroller.getClientRegion()
  const contextViewportLocation = await context.getLocationInViewport()
  const elementViewportRegion = utils.geometry.offset(elementContextRegion, contextViewportLocation)
  const viewportRegion = await context.main.getRegion()
  if (utils.geometry.contains(viewportRegion, elementViewportRegion)) return {x: 0, y: 0}

  let currentContext = context
  let remainingOffset = {x: elementContextRegion.x, y: elementContextRegion.y}
  while (currentContext) {
    const scrollingElement = await currentContext.getScrollingElement()
    if (!scrollingElement) {
      currentContext = currentContext.parent
      continue
    }

    const scrollableRegion = await scrollingElement.getClientRegion()
    const requiredOffset = {
      x: Math.max(
        remainingOffset.x - (scrollableRegion.x + Math.max(scrollableRegion.width - elementContextRegion.width, 0)),
        0,
      ),
      y: Math.max(
        remainingOffset.y - (scrollableRegion.y + Math.max(scrollableRegion.height - elementContextRegion.height, 0)),
        0,
      ),
    }
    const actualOffset = await scroller.moveTo(requiredOffset, scrollingElement)

    remainingOffset = utils.geometry.offset(
      utils.geometry.offsetNegative(remainingOffset, actualOffset),
      utils.geometry.location(await currentContext.getClientRegion()),
    )
    currentContext = currentContext.parent
  }
  return remainingOffset
}

module.exports = scrollIntoViewport