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

Documentation

toBeChecked()

Open source

toBeChecked()

The toBeChecked() method asserts that a checkbox or radio button is checked. This is a retrying assertion that automatically waits for the element to become checked.

Syntax

await expect(locator).toBeChecked();
await expect(locator).not.toBeChecked();
await expect(locator).toBeChecked(options);

Parameters

Parameter	Type	Description
options	RetryConfig	Optional configuration options

Returns

Type	Description
Promise	A promise that resolves when the assertion passes

Description

The toBeChecked() method checks if a checkbox or radio button is checked. This assertion is specifically designed for form elements that have a checked state.

This is a retrying assertion that will automatically re-check the element’s state until it becomes checked or the timeout is reached.

Usage

import { browser } from 'k6/browser';
import { expect } from 'https://jslib.k6.io/k6-testing/0.5.0/index.js';

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

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

  // Go to a test page that demonstrates checkbox functionality
  await page.goto('https://quickpizza.grafana.com');

  // Check a checkbox
  await page.locator('#accept-terms').check();
  await expect(page.locator('#accept-terms')).toBeChecked();

  // Check a radio button
  await page.locator('input[name="gender"][value="male"]').check();
  await expect(page.locator('input[name="gender"][value="male"]')).toBeChecked();

  // Verify another option is not checked
  await expect(page.locator('input[name="gender"][value="female"]')).not.toBeChecked();
}