Text

getText

Check if a text content is visible on the page, identified by the string.

Utility Function

await getText(page, <TEXT CONTENT>)

Playwright

await expect(page.getByText(<TEXT CONTENT>, { exact: true })).toBeVisible();

Parameters

string | number

tip

Make sure the string / number you add is exact (including correct case) otherwise this test will fail.

Use getTextPartialMatch for a more leniant selector

import { getText } from "plugandplaywright";

export async function layoutCheck(page) {
  await getText(page, "Text content to check");
}

getTextPartialMatch

Check if text content is visible on the page, identified by the text content itself.

Your string doesn't have to be exact

Utility Function

await getText(page, <TEXT CONTENT>)

Playwright

await expect(page.getByText(<TEXT CONTENT>)).toBeVisible()

Parameters

string | number

tip

Your parameter does not have to be a full string, or captialised correctly

import { getTextPartialMatch } from "plugandplaywright";

export async function layoutCheck(page) {
  await getTextPartialMatch(page, "Text content tO Ch");
}

clickText

Click a piece of text that is visible on the page, identified by the text content.

Utility Function

await clickText(page, <TEXT CONTENT>)

Playwright

await page.getByText(<TEXT CONTENT>, { exact: true }).click(); 
await page.waitForLoadState("load");

Parameters

string | number

Not only click the text but auto wait for the load to complete.

This means the test will wait until the page is ready for the next action.

tip

Make sure the string / number you add is exact (including correct case) otherwise this test will fail.

Use clickTextPartialMatch for a more leniant selector

import { clickText } from "plugandplaywright";

export async function layoutCheck(page) {
  await clickText(page, "Text Content to CLick");
}

clickTextPartialMatch

Click a piece of text that is visible on the page, identified by the text content.

Utility Function

await clickTextPartialMatch(page, <TEXT CONTENT>)

Playwright

await page.getByText(<TEXT CONTENT>).click(); 
await page.waitForLoadState("load");

Parameters

string | number

Not only click the text but auto wait for the load to complete.

This means the test will wait until the page is ready for the next action.

tip

Your parameter does not have to be a full string, or captialised correctly

import { clickTextPartialMatch } from "plugandplaywright";

export async function layoutCheck(page) {
  await clickTextPartialMatch(page, "text conten");
}

hoverText

Hover on a piece of text that is visible on the page, identified by the text content.

Utility Function

await hoverText(page, <TEXT CONTENT>)

Playwright

await page.getByText(<TEXT CONTENT>, { exact: true }).hover(); 

Parameters

string | number

tip

Make sure the string / number you add is exact (including correct case) otherwise this test will fail.

Use hoverTextPartialMatch for a more leniant selector

import { hoverText } from "plugandplaywright";

export async function layoutCheck(page) {
  await hoverText(page, "Text Content to Hover");
}

hoverTextPartialMatch

Hover on a piece of text that is visible on the page, identified by the text content.

Utility Function

await hoverTextPartialMatch(page, <TEXT CONTENT>)

Playwright

await page.getByText(<TEXT CONTENT>).hover(); 

Parameters

string | number

tip

Your parameter does not have to be a full string, or captialised correctly

import { hoverTextPartialMatch } from "plugandplaywright";

export async function layoutCheck(page) {
  await hoverTextPartialMatch(page, "text conten");
}

scrollToText

Scroll the page til this text is within the viewport.

Utility Function

await scrollToText(page, <TEXT CONTENT>)

Playwright

await page.getByText(<TEXT CONTENT>, {exact: true}).scrollIntoViewIfNeeded(); 

Parameters

string | number

tip

Make sure the string / number you add is exact (including correct case) otherwise this test will fail.

Use scrollToTextPartialMatch for a more leniant selector

import { scrollToText } from "plugandplaywright";

export async function layoutCheck(page) {
  await scrollToText(page, "Text Content to Scroll To");
}

scrollToTextPartialMatch

Scroll the page til this text is within the viewport.

Utility Function

await scrollToTextPartialMatch(page, <TEXT CONTENT>)

Playwright

await page.getByText(<TEXT CONTENT>).scrollIntoViewIfNeeded(); 

Parameters

string | number

tip

Your parameter does not have to be a full string, or captialised correctly

import { scrollToTextPartialMatch } from "plugandplaywright";

export async function layoutCheck(page) {
  await scrollToTextPartialMatch(page, "t to Scroll To");
}