Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/k6/next/javascript-api/jslib/testing/retrying-assertions/tobevisible.md, or by sending Accept: text/markdown to https://grafana.com/docs/k6/next/javascript-api/jslib/testing/retrying-assertions/tobevisible/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
This is documentation for the next version of Grafana k6 documentation. For the latest stable release, go to the latest version.
toBeVisible()
The toBeVisible() method asserts that an element is visible on the page. This is a retrying assertion that automatically waits for the element to become visible.
Syntax
await expect(locator).toBeVisible();
await expect(locator).not.toBeVisible();
await expect(locator).toBeVisible(options);Parameters
| Parameter | Type | Description |
|---|---|---|
| options | RetryConfig | Optional configuration options |
Returns
| Type | Description |
|---|---|
| Promise | A promise that resolves when the assertion passes |
Description
The toBeVisible() method checks if an element is visible on the page. An element is considered visible if:
- It exists in the DOM
- It has non-zero dimensions
- It is not hidden by CSS (
display: none,visibility: hidden, etc.) - It is not outside the viewport bounds
This is a retrying assertion that will automatically re-check the element’s visibility until it becomes visible or the timeout is reached.
Usage
import { browser } from 'k6/browser';
import { expect } from 'https://jslib.k6.io/k6-testing/0.6.1/index.js';
export const options = {
scenarios: {
ui: {
executor: 'shared-iterations',
options: {
browser: {
type: 'chromium',
},
},
},
}
};
export default async function () {
const page = await browser.newPage();
await page.goto('https://quickpizza.grafana.com/');
// Wait for element to be visible
await expect(page.locator('h1')).toBeVisible();
await expect(page.locator('button[name="pizza-please"]')).toBeVisible();
}Was this page helpful?
Related resources from Grafana Labs

