Menu
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
import { check } from 'k6';
import { browser } from 'k6/browser';

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' });

  const login = page.locator('input[name="login"]');

  // Fill an input element with some text that we will later clear.
  await login.type('admin');

  // This checks that the element has been filled with text.
  let value = await login.inputValue();
  check(page, {
    not_empty: (p) => input != '',
  });

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

  // This checks that the element is now empty.
  value = await login.inputValue();
  check(page, {
    empty: () => value == '',
  });

  await page.close();
}