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.

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

clear([options])

Clears text boxes and input fields (input, textarea or contenteditable elements) of any existing values.

ParameterTypeDefaultDescription
optionsobjectnull
options.forcebooleanfalseSetting this to true will bypass the actionability checks (visible, stable, enabled).
options.noWaitAfterbooleanfalseIf set to true and a navigation occurs from performing this action, it will not wait for it to complete.
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 fulfills when the clear action is finished.

Example

JavaScript
JavaScript 
import { browser } from 'k6/browser';
import { check } from "https://jslib.k6.io/k6-utils/1.5.0/index.js";

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

export default async function () {
  const context = await browser.newContext();
  const page = await context.newPage();

  await page.goto("https://test.k6.io/my_messages.php", {
    waitUntil: 'networkidle',
  });

  // Fill an input element with some text that we will later clear
  const login = page.locator('input[name="login"]');
  await login.type('admin');

  // Check that the element has been filled with text
  await check(login, {
    'not empty': async lo => await lo.inputValue() != '',
  });

  // Now clear the text from the element
  await login.clear();

  // Check that the element is now empty
  await check(login, {
    empty: async lo => await lo.inputValue() == '',
  });

  await page.close();
}