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.

Open source

toHaveTitle()

The toHaveTitle() method asserts that a page has a specific title. This is a retrying assertion that automatically waits for the page to have the expected title.

Syntax

JavaScript
await expect(page).toHaveTitle(expected);
await expect(page).not.toHaveTitle(expected);
await expect(page).toHaveTitle(expected, options);

Parameters

ParameterTypeDescription
expectedstring | RegExpThe expected title
optionsRetryConfigOptional configuration options

Returns

TypeDescription
PromiseA promise that resolves when the assertion passes

Description

The toHaveTitle() method checks if a page has a specific title. It retrives the title from the page’s <title> element in the document’s <head>.

When a string is provided, it performs an exact match. When a RegExp is provided, it tests the title against the regular expression pattern.

This is a retrying assertion that will automatically re-check the page’s title until it matches the expected value or the timeout is reached.

Usage

JavaScript
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();
  
  // Navigate and check exact title match
  await page.goto('https://quickpizza.grafana.com/');
  await expect(page).toHaveTitle('QuickPizza');

  // Check title with regex pattern
  await expect(page).toHaveTitle(/QuickPizza/);
  await expect(page).toHaveTitle(/^Quick/);
}