This is documentation for the next version of Grafana k6 documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/browserbreadcrumb arrow Locatorbreadcrumb arrow isInViewport([options])
Open source

isInViewport([options])

Checks whether the element intersects the browser viewport. This matches Playwright’s toBeInViewport semantics.

ParameterTypeDefaultDescription
optionsobjectnull
options.rationumber0The minimum ratio of the element that must be within the viewport for it to count as in viewport, from 0 to 1. The default of 0 means any visible pixel counts.
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<bool>A Promise that fulfills with true if the element is in the viewport, else false.

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 button = page.locator('button#submit');
  if (await button.isInViewport()) {
    await button.click();
  }
}