CodeceptJS
💖 Support Us    
🇺🇦 CodeceptJS was created in Ukraine. #StandWithUkraine

Playwright

# Playwright

Extends Helper

Uses Playwright (opens new window) library to run tests inside:

  • Chromium
  • Firefox
  • Webkit (Safari)

This helper works with a browser out of the box with no additional tools required to install.

Requires playwright or playwright-core package version ^1 to be installed:

npm i playwright@^1.18 --save

or

npm i playwright-core@^1.18 --save

Using playwright-core package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.

# Configuration

This helper should be configured in codecept.conf.js

Type: object (opens new window)

# Properties

# Video Recording Customization

By default, video is saved to output/video dir. You can customize this path by passing dir option to recordVideo option.

video: enables video recording for failed tests; videos are saved into output/videos folder

# Trace Recording Customization

Trace recording provides a complete information on test execution and includes DOM snapshots, screenshots, and network requests logged during run. Traces will be saved to output/trace

  • trace: enables trace recording for failed tests; trace are saved into output/trace folder
  • keepTraceForPassedTests: - save trace for passed tests

# Example #1: Wait for 0 network connections.

{
   helpers: {
     Playwright : {
       url: "http://localhost",
       restart: false,
       waitForNavigation: "networkidle0",
       waitForAction: 500
     }
   }
}

# Example #2: Wait for DOMContentLoaded event

{
   helpers: {
     Playwright : {
       url: "http://localhost",
       restart: false,
       waitForNavigation: "domcontentloaded",
       waitForAction: 500
     }
   }
}

# Example #3: Debug in window mode

{
   helpers: {
     Playwright : {
       url: "http://localhost",
       show: true
     }
   }
}

# Example #4: Connect to remote browser by specifying websocket endpoint (opens new window)

{
   helpers: {
     Playwright: {
       url: "http://localhost",
       chromium: {
         browserWSEndpoint: 'ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a',
         cdpConnection: false // default is false
       }
     }
   }
}

# Example #5: Testing with Chromium extensions

official docs (opens new window)

{
 helpers: {
   Playwright: {
     url: "http://localhost",
     show: true // headless mode not supported for extensions
     chromium: {
       userDataDir: '/tmp/playwright-tmp', // necessary to launch the browser in normal mode instead of incognito,
       args: [
          `--disable-extensions-except=${pathToExtension}`,
          `--load-extension=${pathToExtension}`
       ]
     }
   }
 }
}

# Example #6: Launch tests emulating iPhone 6

const { devices } = require('playwright');

{
 helpers: {
   Playwright: {
     url: "http://localhost",
     emulate: devices['iPhone 6'],
   }
 }
}

# Example #7: Launch test with a specific user locale

{
 helpers: {
  Playwright : {
    url: "http://localhost",
    locale: "fr-FR",
  }
 }
}

  • # Example #8: Launch test with a specific color scheme

{
 helpers: {
  Playwright : {
    url: "http://localhost",
    colorScheme: "dark",
  }
 }
}

Note: When connecting to remote browser show and specific chrome options (e.g. headless or devtools) are ignored.

# Access From Helpers

Receive Playwright client from a custom helper by accessing browser for the Browser object or page for the current Page object:

const { browser } = this.helpers.Playwright;
await browser.pages(); // List of pages in the browser

// get current page
const { page } = this.helpers.Playwright;
await page.url(); // Get the url of the current page

const { browserContext } = this.helpers.Playwright;
await browserContext.cookies(); // get current browser context

# Parameters

  • config

# _addPopupListener

Add the 'dialog' event listener to a page

# Parameters

  • page

# _contextLocator

Grab Locator if called within Context

# Parameters

  • locator any

# _createContextPage

Create a new browser context with a page. Usually it should be run from a custom helper after call of _startBrowser()

# Parameters

# _getPageUrl

Gets page URL including hash.

# _locate

Get elements by different locator types, including strict locator Should be used in custom helpers:

const elements = await this.helpers['Playwright']._locate({name: 'password'});

# Parameters

  • locator

# _locateCheckable

Find a checkbox by providing human readable text: NOTE: Assumes the checkable element exists

this.helpers['Playwright']._locateCheckable('I agree with terms and conditions').then // ...

# Parameters

  • locator
  • providedContext

# _locateClickable

Find a clickable element by providing human readable text:

this.helpers['Playwright']._locateClickable('Next page').then // ...

# Parameters

  • locator

# _locateFields

Find field elements by providing human readable text:

this.helpers['Playwright']._locateFields('Your email').then // ...

# Parameters

  • locator

# _setPage

Set current page

# Parameters

# acceptPopup

Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt. Don't confuse popups with modal windows, as created by various libraries (opens new window).

# amAcceptingPopups

Set the automatic popup response to Accept. This must be set before a popup is triggered.

I.amAcceptingPopups();
I.click('#triggerPopup');
I.acceptPopup();

# amCancellingPopups

Set the automatic popup response to Cancel/Dismiss. This must be set before a popup is triggered.

I.amCancellingPopups();
I.click('#triggerPopup');
I.cancelPopup();

# amOnPage

Opens a web page in a browser. Requires relative or absolute url. If url starts with /, opens a web page of a site defined in url config parameter.

I.amOnPage('/'); // opens main page of website
I.amOnPage('https://github.com'); // opens github
I.amOnPage('/login'); // opens a login page

# Parameters

Returns void automatically synchronized promise with recorder #!

# appendField

Appends text to a input field or textarea. Field is located by name, label, CSS or XPath

I.appendField('#myTextField', 'appended');

# Parameters

# attachFile

Attaches a file to element located by label, name, CSS or XPath Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located). File will be uploaded to remote system (if tests are running remotely).

I.attachFile('Avatar', 'data/avatar.jpg');
I.attachFile('form input[name=avatar]', 'data/avatar.jpg');

# Parameters

# cancelPopup

Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.

# checkOption

Selects a checkbox or radio button. Element is located by label or name or CSS or XPath.

The second parameter is a context (CSS or XPath locator) to narrow the search.

I.checkOption('#agree');
I.checkOption('I Agree to Terms and Conditions');
I.checkOption('agree', '//form');

# Parameters

# clearCookie

Clears a cookie by name, if none provided clears all cookies.

I.clearCookie();
I.clearCookie('test');

# Parameters

  • cookie string (opens new window)? (optional, null by default) cookie name ⚠️ returns a promise which is synchronized internally by recorder

# clearField

Clears a <textarea> or text <input> element's value.

I.clearField('Email');
I.clearField('user[email]');
I.clearField('#email');

# Parameters

# click

Perform a click on a link or a button, given by a locator. If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched. For images, the "alt" attribute and inner text of any parent links are searched.

The second parameter is a context (CSS or XPath locator) to narrow the search.

// simple link
I.click('Logout');
// button of form
I.click('Submit');
// CSS button
I.click('#form input[type=submit]');
// XPath
I.click('//form/*[@type=submit]');
// link in context
I.click('Logout', '#nav');
// using strict locator
I.click({css: 'nav a.login'});

# Parameters

Clicks link and waits for navigation (deprecated)

# Parameters

  • locator
  • context

# closeCurrentTab

Close current tab and switches to previous.

I.closeCurrentTab();

# closeOtherTabs

Close all tabs except for the current one.

I.closeOtherTabs();

# dontSee

Opposite to see. Checks that a text is not present on a page. Use context parameter to narrow down the search.

I.dontSee('Login'); // assume we are already logged in.
I.dontSee('Login', '.nav'); // no login inside .nav element

# Parameters

# dontSeeCheckboxIsChecked

Verifies that the specified checkbox is not checked.

I.dontSeeCheckboxIsChecked('#agree'); // located by ID
I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label
I.dontSeeCheckboxIsChecked('agree'); // located by name

# Parameters

# dontSeeCookie

Checks that cookie with given name does not exist.

I.dontSeeCookie('auth'); // no auth cookie

# Parameters

# dontSeeCurrentUrlEquals

Checks that current url is not equal to provided one. If a relative url provided, a configured url will be prepended to it.

I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok

# Parameters

# dontSeeElement

Opposite to seeElement. Checks that element is not visible (or in DOM)

I.dontSeeElement('.modal'); // modal is not shown

# Parameters

# dontSeeElementInDOM

Opposite to seeElementInDOM. Checks that element is not on page.

I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not

# Parameters

# dontSeeInCurrentUrl

Checks that current url does not contain a provided fragment.

# Parameters

# dontSeeInField

Checks that value of input field or textarea doesn't equal to given value Opposite to seeInField.

I.dontSeeInField('email', '[email protected]'); // field by name
I.dontSeeInField({ css: 'form input.email' }, '[email protected]'); // field by CSS

# Parameters

# dontSeeInSource

Checks that the current page does not contains the given string in its raw source code.

I.dontSeeInSource('<!--'); // no comments in source

# Parameters

# dontSeeInTitle

Checks that title does not contain text.

I.dontSeeInTitle('Error');

# Parameters

# doubleClick

Performs a double-click on an element matched by link|button|label|CSS or XPath. Context can be specified as second parameter to narrow search.

I.doubleClick('Edit');
I.doubleClick('Edit', '.actions');
I.doubleClick({css: 'button.accept'});
I.doubleClick('.btn.edit');

# Parameters

# dragAndDrop

Drag an item to a destination element.

I.dragAndDrop('#dragHandle', '#container');

# Parameters

# dragSlider

Drag the scrubber of a slider to a given position For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.

I.dragSlider('#slider', 30);
I.dragSlider('#slider', -70);

# Parameters

# executeScript

Executes a script on the page:

I.executeScript(() => window.alert('Hello world'));

Additional parameters of the function can be passed as an object argument:

I.executeScript(({x, y}) => x + y, {x, y});

You can pass only one parameter into a function but you can pass in array or object.

I.executeScript(([x, y]) => x + y, [x, y]);

If a function returns a Promise it will wait for its resolution.

# Parameters

Returns Promise (opens new window)<any>

# fillField

Fills a text field or textarea, after clearing its value, with the given string. Field is located by name, label, CSS, or XPath.

// by label
I.fillField('Email', '[email protected]');
// by name
I.fillField('password', secret('123456'));
// by CSS
I.fillField('form#login input[name=username]', 'John');
// or by strict locator
I.fillField({css: 'form#login input[name=username]'}, 'John');

# Parameters

# forceClick

Perform an emulated click on a link or a button, given by a locator. Unlike normal click instead of sending native event, emulates a click with JavaScript. This works on hidden, animated or inactive elements as well.

If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched. For images, the "alt" attribute and inner text of any parent links are searched.

The second parameter is a context (CSS or XPath locator) to narrow the search.

// simple link
I.forceClick('Logout');
// button of form
I.forceClick('Submit');
// CSS button
I.forceClick('#form input[type=submit]');
// XPath
I.forceClick('//form/*[@type=submit]');
// link in context
I.forceClick('Logout', '#nav');
// using strict locator
I.forceClick({css: 'nav a.login'});

# Parameters

# grabAttributeFrom

Retrieves an attribute from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async with await operator. If more than one element is found - attribute of first element is returned.

let hint = await I.grabAttributeFrom('#tooltip', 'title');

# Parameters

Returns Promise (opens new window)<string (opens new window)> attribute value

# grabAttributeFromAll

Retrieves an array of attributes from elements located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async with await operator.

let hints = await I.grabAttributeFromAll('.tooltip', 'title');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> attribute value

# grabBrowserLogs

Get JS log from browser.

const logs = await I.grabBrowserLogs();
const errors = logs.map(l => ({ type: l.type(), text: l.text() })).filter(l => l.type === 'error');
console.log(JSON.stringify(errors));

Learn more about console messages (opens new window)

Returns Promise (opens new window)<Array (opens new window)<any>>

# grabCookie

Gets a cookie object by name. If none provided gets all cookies. Resumes test execution, so should be used inside async function with await operator.

let cookie = await I.grabCookie('auth');
assert(cookie.value, '123456');

# Parameters

Returns (Promise (opens new window)<string (opens new window)> | Promise (opens new window)<Array (opens new window)<string (opens new window)>>) attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.

# grabCssPropertyFrom

Grab CSS property for given locator Resumes test execution, so should be used inside an async function with await operator. If more than one element is found - value of first element is returned.

const value = await I.grabCssPropertyFrom('h3', 'font-weight');

# Parameters

Returns Promise (opens new window)<string (opens new window)> CSS value

# grabCssPropertyFromAll

Grab array of CSS properties for given locator Resumes test execution, so should be used inside an async function with await operator.

const values = await I.grabCssPropertyFromAll('h3', 'font-weight');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> CSS value

# grabCurrentUrl

Get current URL from browser. Resumes test execution, so should be used inside an async function.

let url = await I.grabCurrentUrl();
console.log(`Current URL is [${url}]`);

Returns Promise (opens new window)<string (opens new window)> current URL

# grabDataFromPerformanceTiming

Grab the data from performance timing using Navigation Timing API. The returned data will contain following things in ms:

  • responseEnd,
  • domInteractive,
  • domContentLoadedEventEnd,
  • loadEventEnd Resumes test execution, so should be used inside an async function with await operator.
await I.amOnPage('https://example.com');
let data = await I.grabDataFromPerformanceTiming();
//Returned data
{ // all results are in [ms]
  responseEnd: 23,
  domInteractive: 44,
  domContentLoadedEventEnd: 196,
  loadEventEnd: 241
}

Returns Promise (opens new window)<any> automatically synchronized promise through #recorder

# grabElementBoundingRect

Grab the width, height, location of given locator. Provide width or heightas second param to get your desired prop. Resumes test execution, so should be used inside an async function with await operator.

Returns an object with x, y, width, height keys.

const value = await I.grabElementBoundingRect('h3');
// value is like { x: 226.5, y: 89, width: 527, height: 220 }

To get only one metric use second parameter:

const width = await I.grabElementBoundingRect('h3', 'width');
// width == 527

# Parameters

Returns (Promise (opens new window)<DOMRect> | Promise (opens new window)<number (opens new window)>) Element bounding rectangle

# grabHTMLFrom

Retrieves the innerHTML from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async function with await operator. If more than one element is found - HTML of first element is returned.

let postHTML = await I.grabHTMLFrom('#post');

# Parameters

Returns Promise (opens new window)<string (opens new window)> HTML code for an element

# grabHTMLFromAll

Retrieves all the innerHTML from elements located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async function with await operator.

let postHTMLs = await I.grabHTMLFromAll('.post');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> HTML code for an element

# grabNumberOfOpenTabs

Grab number of open tabs. Resumes test execution, so should be used inside async function with await operator.

let tabs = await I.grabNumberOfOpenTabs();

Returns Promise (opens new window)<number (opens new window)> number of open tabs

# grabNumberOfVisibleElements

Grab number of visible elements by locator. Resumes test execution, so should be used inside async function with await operator.

let numOfElements = await I.grabNumberOfVisibleElements('p');

# Parameters

Returns Promise (opens new window)<number (opens new window)> number of visible elements

# grabPageScrollPosition

Retrieves a page scroll position and returns it to test. Resumes test execution, so should be used inside an async function with await operator.

let { x, y } = await I.grabPageScrollPosition();

Returns Promise (opens new window)<PageScrollPosition> scroll position

# grabPopupText

Grab the text within the popup. If no popup is visible then it will return null

await I.grabPopupText();

Returns Promise (opens new window)<(string (opens new window) | null)>

# grabSource

Retrieves page source and returns it to test. Resumes test execution, so should be used inside async function with await operator.

let pageSource = await I.grabSource();

Returns Promise (opens new window)<string (opens new window)> source code

# grabTextFrom

Retrieves a text from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async with await operator.

let pin = await I.grabTextFrom('#pin');

If multiple elements found returns first element.

# Parameters

Returns Promise (opens new window)<string (opens new window)> attribute value

# grabTextFromAll

Retrieves all texts from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async with await operator.

let pins = await I.grabTextFromAll('#pin li');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> attribute value

# grabTitle

Retrieves a page title and returns it to test. Resumes test execution, so should be used inside async with await operator.

let title = await I.grabTitle();

Returns Promise (opens new window)<string (opens new window)> title

# grabValueFrom

Retrieves a value from a form element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async function with await operator. If more than one element is found - value of first element is returned.

let email = await I.grabValueFrom('input[name=email]');

# Parameters

Returns Promise (opens new window)<string (opens new window)> attribute value

# grabValueFromAll

Retrieves an array of value from a form located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async function with await operator.

let inputs = await I.grabValueFromAll('//form/input');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> attribute value

# handleDownloads

Handles a file download. A file name is required to save the file on disk. Files are saved to "output" directory.

Should be used with FileSystem helper (opens new window) to check that file were downloaded correctly.

I.handleDownloads('downloads/avatar.jpg');
I.click('Download Avatar');
I.amInPath('output/downloads');
I.waitForFile('avatar.jpg', 5);

# Parameters

Returns Promise (opens new window)<void>

# haveRequestHeaders

Set headers for all next requests

I.haveRequestHeaders({
   'X-Sent-By': 'CodeceptJS',
});

# Parameters

# makeApiRequest

Performs api request (opens new window) using the cookies from the current browser session.

const users = await I.makeApiRequest('GET', '/api/users', { params: { page: 1 }});
users[0]
I.makeApiRequest('PATCH', )

This is Playwright's built-in alternative to using REST helper's sendGet, sendPost, etc methods.

# Parameters

Returns Promise (opens new window)<object (opens new window)> response

# mockRoute

Mocks network request using browserContext.route (opens new window) of Playwright

I.mockRoute(/(.png$)|(.jpg$)/, route => route.abort());

This method allows intercepting and mocking requests & responses. Learn more about it (opens new window)

# Parameters

# moveCursorTo

Moves cursor to element matched by locator. Extra shift can be set with offsetX and offsetY options.

I.moveCursorTo('.tooltip');
I.moveCursorTo('#submit', 5,5);

# Parameters

# openNewTab

Open new tab and automatically switched to new tab

I.openNewTab();

You can pass in page options (opens new window) to emulate device on this page

// enable mobile
I.openNewTab({ isMobile: true });

# Parameters

  • options

# pressKey

Presses a key in the browser (on a focused element).

Hint: For populating text field or textarea, it is recommended to use fillField.

I.pressKey('Backspace');

To press a key in combination with modifier keys, pass the sequence as an array. All modifier keys ('Alt', 'Control', 'Meta', 'Shift') will be released afterwards.

I.pressKey(['Control', 'Z']);

For specifying operation modifier key based on operating system it is suggested to use 'CommandOrControl'. This will press 'Command' (also known as 'Meta') on macOS machines and 'Control' on non-macOS machines.

I.pressKey(['CommandOrControl', 'Z']);

Some of the supported key names are:

  • 'AltLeft' or 'Alt'
  • 'AltRight'
  • 'ArrowDown'
  • 'ArrowLeft'
  • 'ArrowRight'
  • 'ArrowUp'
  • 'Backspace'
  • 'Clear'
  • 'ControlLeft' or 'Control'
  • 'ControlRight'
  • 'Command'
  • 'CommandOrControl'
  • 'Delete'
  • 'End'
  • 'Enter'
  • 'Escape'
  • 'F1' to 'F12'
  • 'Home'
  • 'Insert'
  • 'MetaLeft' or 'Meta'
  • 'MetaRight'
  • 'Numpad0' to 'Numpad9'
  • 'NumpadAdd'
  • 'NumpadDecimal'
  • 'NumpadDivide'
  • 'NumpadMultiply'
  • 'NumpadSubtract'
  • 'PageDown'
  • 'PageUp'
  • 'Pause'
  • 'Return'
  • 'ShiftLeft' or 'Shift'
  • 'ShiftRight'
  • 'Space'
  • 'Tab'

# Parameters

# pressKeyDown

Presses a key in the browser and leaves it in a down state.

To make combinations with modifier key and user operation (e.g. 'Control' + click).

I.pressKeyDown('Control');
I.click('#element');
I.pressKeyUp('Control');

# Parameters

  • key string (opens new window) name of key to press down. ⚠️ returns a promise which is synchronized internally by recorder

# pressKeyUp

Releases a key in the browser which was previously set to a down state.

To make combinations with modifier key and user operation (e.g. 'Control' + click).

I.pressKeyDown('Control');
I.click('#element');
I.pressKeyUp('Control');

# Parameters

# refreshPage

Reload the current page.

I.refreshPage();

⚠️ returns a promise which is synchronized internally by recorder

# resizeWindow

Resize the current window to provided width and height. First parameter can be set to maximize.

# Parameters

  • width number (opens new window) width in pixels or maximize.
  • height number (opens new window) height in pixels. ⚠️ returns a promise which is synchronized internally by recorderUnlike other drivers Playwright changes the size of a viewport, not the window! Playwright does not control the window of a browser so it can't adjust its real size. It also can't maximize a window.Update configuration to change real window size on start:```js // inside codecept.conf.js // @codeceptjs/configure package must be installed { setWindowSize } = require('@codeceptjs/configure');

# restartBrowser

Restart browser with a new context and a new page

// Restart browser and use a new timezone
I.restartBrowser({ timezoneId: 'America/Phoenix' });
// Open URL in a new page in changed timezone
I.amOnPage('/');
// Restart browser, allow reading/copying of text from/into clipboard in Chrome
I.restartBrowser({ permissions: ['clipboard-read', 'clipboard-write'] });

# Parameters

# rightClick

Performs right click on a clickable element matched by semantic locator, CSS or XPath.

// right click element with id el
I.rightClick('#el');
// right click link or button with text "Click me"
I.rightClick('Click me');
// right click button with text "Click me" inside .context
I.rightClick('Click me', '.context');

# Parameters

# saveElementScreenshot

Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js). Filename is relative to output folder.

I.saveElementScreenshot(`#submit`,'debug.png');

# Parameters

# saveScreenshot

Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js). Filename is relative to output folder. Optionally resize the window to the full available page scrollHeight and scrollWidth to capture the entire page by passing true in as the second argument.

I.saveScreenshot('debug.png');
I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot

# Parameters

# scrollPageToBottom

Scroll page to the bottom.

I.scrollPageToBottom();

⚠️ returns a promise which is synchronized internally by recorder

# scrollPageToTop

Scroll page to the top.

I.scrollPageToTop();

⚠️ returns a promise which is synchronized internally by recorder

# scrollTo

Scrolls to element matched by locator. Extra shift can be set with offsetX and offsetY options.

I.scrollTo('footer');
I.scrollTo('#submit', 5, 5);

# Parameters

# see

Checks that a page contains a visible text. Use context parameter to narrow down the search.

I.see('Welcome'); // text welcome on a page
I.see('Welcome', '.content'); // text inside .content div
I.see('Register', {css: 'form.register'}); // use strict locator

# Parameters

# seeAttributesOnElements

Checks that all elements with given locator have given attributes.

I.seeAttributesOnElements('//form', { method: "post"});

# Parameters

# seeCheckboxIsChecked

Verifies that the specified checkbox is checked.

I.seeCheckboxIsChecked('Agree');
I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});

# Parameters

# seeCookie

Checks that cookie with given name exists.

I.seeCookie('Auth');

# Parameters

# seeCssPropertiesOnElements

Checks that all elements with given locator have given CSS properties.

I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});

# Parameters

# seeCurrentUrlEquals

Checks that current url is equal to provided one. If a relative url provided, a configured url will be prepended to it. So both examples will work:

I.seeCurrentUrlEquals('/register');
I.seeCurrentUrlEquals('http://my.site.com/register');

# Parameters

# seeElement

Checks that a given Element is visible Element is located by CSS or XPath.

I.seeElement('#modal');

# Parameters

# seeElementInDOM

Checks that a given Element is present in the DOM Element is located by CSS or XPath.

I.seeElementInDOM('#modal');

# Parameters

# seeInCurrentUrl

Checks that current url contains a provided fragment.

I.seeInCurrentUrl('/register'); // we are on registration page

# Parameters

# seeInField

Checks that the given input field or textarea equals to given value. For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.

I.seeInField('Username', 'davert');
I.seeInField({css: 'form textarea'},'Type your comment here');
I.seeInField('form input[type=hidden]','hidden_value');
I.seeInField('#searchform input','Search');

# Parameters

# seeInPopup

Checks that the active JavaScript popup, as created by window.alert|window.confirm|window.prompt, contains the given string.

I.seeInPopup('Popup text');

# Parameters

# seeInSource

Checks that the current page contains the given string in its raw source code.

I.seeInSource('<h1>Green eggs &amp; ham</h1>');

# Parameters

# seeInTitle

Checks that title contains text.

I.seeInTitle('Home Page');

# Parameters

# seeNumberOfElements

Asserts that an element appears a given number of times in the DOM. Element is located by label or name or CSS or XPath.

I.seeNumberOfElements('#submitBtn', 1);

# Parameters

# seeNumberOfVisibleElements

Asserts that an element is visible a given number of times. Element is located by CSS or XPath.

I.seeNumberOfVisibleElements('.buttons', 3);

# Parameters

# seeTextEquals

Checks that text is equal to provided one.

I.seeTextEquals('text', 'h1');

# Parameters

# seeTitleEquals

Checks that title is equal to provided one.

I.seeTitleEquals('Test title.');

# Parameters

# selectOption

Selects an option in a drop-down select. Field is searched by label | name | CSS | XPath. Option is selected by visible text or by value.

I.selectOption('Choose Plan', 'Monthly'); // select by label
I.selectOption('subscription', 'Monthly'); // match option by text
I.selectOption('subscription', '0'); // or by value
I.selectOption('//form/select[@name=account]','Premium');
I.selectOption('form select[name=account]', 'Premium');
I.selectOption({css: 'form select[name=account]'}, 'Premium');

Provide an array for the second argument to select multiple options.

I.selectOption('Which OS do you use?', ['Android', 'iOS']);

# Parameters

# setCookie

Sets cookie(s).

Can be a single cookie object or an array of cookies:

I.setCookie({name: 'auth', value: true});

// as array
I.setCookie([
  {name: 'auth', value: true},
  {name: 'agree', value: true}
]);

# Parameters

  • cookie (Cookie | Array (opens new window)<Cookie>) a cookie object or array of cookie objects. ⚠️ returns a promise which is synchronized internally by recorder

# stopMockingRoute

Stops network mocking created by mockRoute.

I.stopMockingRoute(/(.png$)|(.jpg$)/);
I.stopMockingRoute(/(.png$)|(.jpg$)/, previouslySetHandler);

If no handler is passed, all mock requests for the rote are disabled.

# Parameters

# switchTo

Switches frame or in case of null locator reverts to parent.

I.switchTo('iframe'); // switch to first iframe
I.switchTo(); // switch back to main page

# Parameters

# switchToNextTab

Switch focus to a particular tab by its number. It waits tabs loading and then switch tab

I.switchToNextTab();
I.switchToNextTab(2);

# Parameters

# switchToPreviousTab

Switch focus to a particular tab by its number. It waits tabs loading and then switch tab

I.switchToPreviousTab();
I.switchToPreviousTab(2);

# Parameters

# type

Types out the given text into an active field. To slow down typing use a second parameter, to set interval between key presses. Note: Should be used when fillField is not an option.

// passing in a string
I.type('Type this out.');

// typing values with a 100ms interval
I.type('4141555311111111', 100);

// passing in an array
I.type(['T', 'E', 'X', 'T']);

# Parameters

# uncheckOption

Unselects a checkbox or radio button. Element is located by label or name or CSS or XPath.

The second parameter is a context (CSS or XPath locator) to narrow the search.

I.uncheckOption('#agree');
I.uncheckOption('I Agree to Terms and Conditions');
I.uncheckOption('agree', '//form');

# Parameters

# usePlaywrightTo

Use Playwright API inside a test.

First argument is a description of an action. Second argument is async function that gets this helper as parameter.

{ page (opens new window), browserContext (opens new window) browser (opens new window) } objects from Playwright API are available.

I.usePlaywrightTo('emulate offline mode', async ({ browserContext }) => {
  await browserContext.setOffline(true);
});

# Parameters

# wait

Pauses execution for a number of seconds.

I.wait(2); // wait 2 secs

# Parameters

  • sec number (opens new window) number of second to wait. ⚠️ returns a promise which is synchronized internally by recorder

# waitForClickable

Waits for element to be clickable (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitForClickable('.btn.continue');
I.waitForClickable('.btn.continue', 5); // wait for 5 secs

# Parameters

# waitForDetached

Waits for an element to become not attached to the DOM on a page (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitForDetached('#popup');

# Parameters

# waitForElement

Waits for element to be present on page (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitForElement('.btn.continue');
I.waitForElement('.btn.continue', 5); // wait for 5 secs

# Parameters

# waitForEnabled

Waits for element to become enabled (by default waits for 1sec). Element can be located by CSS or XPath.

# Parameters

# waitForFunction

Waits for a function to return true (waits for 1 sec by default). Running in browser context.

I.waitForFunction(fn[, [args[, timeout]])

I.waitForFunction(() => window.requests == 0);
I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec

# Parameters

# waitForInvisible

Waits for an element to be removed or become invisible on a page (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitForInvisible('#popup');

# Parameters

# waitForNavigation

Waits for navigation to finish. By default takes configured waitForNavigation option.

See Playwright's reference (opens new window)

# Parameters

  • opts any

# waitForRequest

Waits for a network request.

I.waitForRequest('http://example.com/resource');
I.waitForRequest(request => request.url() === 'http://example.com' && request.method() === 'GET');

# Parameters

# waitForResponse

Waits for a network response.

I.waitForResponse('http://example.com/resource');
I.waitForResponse(response => response.url() === 'https://example.com' && response.status() === 200);

# Parameters

# waitForText

Waits for a text to appear (by default waits for 1sec). Element can be located by CSS or XPath. Narrow down search results by providing context.

I.waitForText('Thank you, form has been submitted');
I.waitForText('Thank you, form has been submitted', 5, '#modal');

# Parameters

# waitForValue

Waits for the specified value to be in value attribute.

I.waitForValue('//input', "GoodValue");

# Parameters

# waitForVisible

Waits for an element to become visible on a page (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitForVisible('#popup');

# Parameters

# waitInUrl

Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.

I.waitInUrl('/info', 2);

# Parameters

# waitNumberOfVisibleElements

Waits for a specified number of elements on the page.

I.waitNumberOfVisibleElements('a', 3);

# Parameters

# waitToHide

Waits for an element to hide (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitToHide('#popup');

# Parameters

# waitUrlEquals

Waits for the entire URL to match the expected

I.waitUrlEquals('/info', 2);
I.waitUrlEquals('http://127.0.0.1:8000/info');

# Parameters

Last Updated: 2/15/2023, 4:41:45 AM

More Information

Videos

Books & Posts

Examples

Cookbook →

Commercial Services →

Trainings →

Testomat.io →
Plan your end 2 end tests, collaborate, synchronize with code & get reports!
Join Testomat.io while it is in beta and get a huge discount!

Support us via OpenCollective!