Menu
Open source

scrollIntoViewIfNeeded([options])

Scrolls the element into view if needed.

ParameterTypeDefaultDescription
optionsobjectnull
options.timeoutnumber30000Maximum time in milliseconds. Pass 0 to disable the timeout. Default is overridden by the setDefaultTimeout option on BrowserContext or Page.

Returns

TypeDescription
Promise<void>A promise that resolves when the element is scrolled into view.

Example

JavaScript
import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();
  await page.goto('https://test.k6.io');

  const element = await page.$(".header");
  await element.scrollIntoViewIfNeeded();

  await page.close();
}