Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source

frameLocator(selector)

Shorthand for locator(selector).contentFrame(). Returns a FrameLocator for the iframe that matches the given selector. Use this to interact with elements inside iframes without calling locator() and contentFrame() separately.

ParameterTypeDescription
selectorstringA selector that resolves to an iframe element (for example iframe#payment or iframe[name="form"]).

Returns

TypeDescription
FrameLocatorA FrameLocator for the matched iframe.

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();

  try {
    await page.setContent(`
      <div class="widget"><iframe id="my_frame" src="https://quickpizza.grafana.com"></iframe></div>
    `);

    // Shorthand: instead of page.locator('.widget').locator('#my_frame').contentFrame()
    const frame = page.locator('.widget').frameLocator('#my_frame');
    await frame.getByText('Pizza, Please!').click();
  } finally {
    await page.close();
  }
}