playwright/docs/src/assertions.md

id	title
assertions	Assertions

Playwright provides convenience APIs for common tasks, like reading the text content of an element. These APIs can be used in your test assertions.

Text content

const content = await page.textContent('nav:first-child');
expect(content).toBe('home');

content = await page.text_content("nav:first-child")
assert content == "home"

content = page.text_content("nav:first-child")
assert content == "home"

API reference

• [method: Page.innerText]
• [method: ElementHandle.innerText]

Inner text

const text = await page.innerText('.selected');
expect(text).toBe('value');

text = await page.inner_text(".selected")
assert text == "value"

text = page.inner_text(".selected")
assert text == "value"

API reference

• [method: Page.innerText]
• [method: ElementHandle.innerText]

Attribute value

const alt = await page.getAttribute('input', 'alt');
expect(alt).toBe('Text');

checked = await page.get_attribute("input", "alt")
assert alt == "Text"

checked = page.get_attribute("input", "alt")
assert alt == "Text"

Checkbox state

const checked = await page.isChecked('input');
expect(checked).toBeTruthy();

checked = await page.is_checked("input")
assert checked

checked = page.is_checked("input")
assert checked

API reference

• [method: Page.isChecked]
• [method: ElementHandle.isChecked]

JS expression

const content = await page.$eval('nav:first-child', e => e.textContent);
expect(content).toBe('home');

content = await page.eval_on_selector("nav:first-child", "e => e.textContent")
assert content == "home"

content = page.eval_on_selector("nav:first-child", "e => e.textContent")
assert content == "home"

API reference

• [method: Page.evalOnSelector]
• [method: JSHandle.evaluate]

Inner HTML

const html = await page.innerHTML('div.result');
expect(html).toBe('<p>Result</p>');

html = await page.inner_html("div.result")
assert html == "<p>Result</p>"

html = page.inner_html("div.result")
assert html == "<p>Result</p>"

API reference

• [method: Page.innerHTML]
• [method: ElementHandle.innerHTML]

Visibility

const visible = await page.isVisible('input');
expect(visible).toBeTruthy();

visible = await page.is_visible("input")
assert visible

visible = page.is_visible("input")
assert visible

API reference

• [method: Page.isVisible]
• [method: ElementHandle.isVisible]

Enabled state

const enabled = await page.isEnabled('input');
expect(visible).toBeTruthy();

enabled = await page.is_enabled("input")
assert enabled

enabled = page.is_enabled("input")
assert enabled

API reference

• [method: Page.isEnabled]
• [method: ElementHandle.isEnabled]

Custom assertions

With Playwright, you can also write custom JavaScript to run in the context of the browser. This is useful in situations where you want to assert for values that are not covered by the convenience APIs above.

// Assert local storage value
const userId = page.evaluate(() => window.localStorage.getItem('userId'));
expect(userId).toBeTruthy();

// Assert value for input element
await page.waitForSelector('#search');
const value = await page.$eval('#search', el => el.value);
expect(value === 'query').toBeTruthy();

// Assert computed style
const fontSize = await page.$eval('div', el => window.getComputedStyle(el).fontSize);
expect(fontSize === '16px').toBeTruthy();

// Assert list length
const length = await page.$$eval('li.selected', (items) => items.length);
expect(length === 3).toBeTruthy();

# Assert local storage value
user_id = page.evaluate("() => window.localStorage.getItem('user_id')")
assert user_id

# Assert value for input element
await page.wait_for_selector('#search')
value = await page.eval_on_selector('#search', 'el => el.value')
assert value == 'query'

# Assert computed style
font_size = await page.eval_on_selector('div', 'el => window.getComputedStyle(el).fontSize')
assert font_size == '16px'

# Assert list length
length = await page.eval_on_selector_all('li.selected', '(items) => items.length')
assert length == 3

# Assert local storage value
user_id = page.evaluate("() => window.localStorage.getItem('user_id')")
assert user_id

# Assert value for input element
page.wait_for_selector('#search')
value = page.eval_on_selector('#search', 'el => el.value')
assert value == 'query'

# Assert computed style
font_size = page.eval_on_selector('div', 'el => window.getComputedStyle(el).fontSize')
assert font_size == '16px'

# Assert list length
length = page.eval_on_selector_all('li.selected', '(items) => items.length')
assert length == 3

API reference

• [method: Page.evaluate]
• [method: Page.evalOnSelector]
• [method: Page.evalOnSelectorAll]
• [method: Frame.evaluate]
• [method: Frame.evalOnSelector]
• [method: Frame.evalOnSelectorAll]
• [method: ElementHandle.evalOnSelector]
• [method: ElementHandle.evalOnSelectorAll]
• [EvaluationArgument]