Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/src/api/class-locatorassertions.md
Original file line number Diff line number Diff line change
Expand Up @@ -890,11 +890,16 @@ Whether to use `element.innerText` instead of `element.textContent` when retriev
* langs:
- alias-java: hasAttribute

Ensures the [Locator] points to an element with given attribute.
Ensures the [Locator] points to an element with given attribute. If the method
is used without `'value'` argument, then the method will assert attribute existance.

```js
const locator = page.locator('input');
// Assert attribute with given value.
await expect(locator).toHaveAttribute('type', 'text');
// Assert attribute existance.
await expect(locator).toHaveAttribute('disabled');
await expect(locator).not.toHaveAttribute('open');
```

```java
Expand Down Expand Up @@ -928,9 +933,9 @@ Attribute name.

### param: LocatorAssertions.toHaveAttribute.value
* since: v1.18
- `value` <[string]|[RegExp]>
- `value` ?<[string]|[RegExp]>

Expected attribute value.
Optional expected attribute value. If missing, method will assert attribute presence.
Comment thread
aslushnikov marked this conversation as resolved.

### option: LocatorAssertions.toHaveAttribute.timeout = %%-js-assertions-timeout-%%
* since: v1.18
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1024,7 +1024,9 @@ export class InjectedScript {
{
// Element state / boolean values.
let elementState: boolean | 'error:notconnected' | 'error:notcheckbox' | undefined;
if (expression === 'to.be.checked') {
if (expression === 'to.have.attribute') {
elementState = element.hasAttribute(options.expressionArg);
} else if (expression === 'to.be.checked') {
elementState = progress.injectedScript.elementState(element, 'checked');
} else if (expression === 'to.be.unchecked') {
elementState = progress.injectedScript.elementState(element, 'unchecked');
Expand Down Expand Up @@ -1082,7 +1084,7 @@ export class InjectedScript {
{
// Single text value.
let received: string | undefined;
if (expression === 'to.have.attribute') {
if (expression === 'to.have.attribute.value') {
received = element.getAttribute(options.expressionArg) || '';
} else if (expression === 'to.have.class') {
received = element.classList.toString();
Expand Down
9 changes: 7 additions & 2 deletions packages/playwright-test/src/matchers/matchers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,17 @@ export function toHaveAttribute(
this: ReturnType<Expect['getState']>,
locator: LocatorEx,
name: string,
expected: string | RegExp,
expected: string | RegExp | undefined,
options?: { timeout?: number },
) {
if (expected === undefined) {
return toBeTruthy.call(this, 'toHaveAttribute', locator, 'Locator', async (isNot, timeout, customStackTrace) => {
return await locator._expect(customStackTrace, 'to.have.attribute', { expressionArg: name, isNot, timeout });
}, options);
}
return toMatchText.call(this, 'toHaveAttribute', locator, 'Locator', async (isNot, timeout, customStackTrace) => {
const expectedText = toExpectedTextValues([expected]);
return await locator._expect(customStackTrace, 'to.have.attribute', { expressionArg: name, expectedText, isNot, timeout });
return await locator._expect(customStackTrace, 'to.have.attribute.value', { expressionArg: name, expectedText, isNot, timeout });
}, expected, options);
}

Expand Down
11 changes: 8 additions & 3 deletions packages/playwright-test/types/test.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3423,18 +3423,23 @@ interface LocatorAssertions {
}): Promise<void>;

/**
* Ensures the [Locator] points to an element with given attribute.
* Ensures the [Locator] points to an element with given attribute. If the method is used without `'value'` argument, then
* the method will assert attribute existance.
*
* ```js
* const locator = page.locator('input');
* // Assert attribute with given value.
* await expect(locator).toHaveAttribute('type', 'text');
* // Assert attribute existance.
* await expect(locator).toHaveAttribute('disabled');
* await expect(locator).not.toHaveAttribute('open');
* ```
*
* @param name Attribute name.
* @param value Expected attribute value.
* @param value Optional expected attribute value. If missing, method will assert attribute presence.
* @param options
*/
toHaveAttribute(name: string, value: string|RegExp, options?: {
toHaveAttribute(name: string, value?: string|RegExp, options?: {
/**
* Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`.
*/
Expand Down
5 changes: 4 additions & 1 deletion tests/page/expect-misc.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -228,8 +228,11 @@ test.describe('toHaveURL', () => {

test.describe('toHaveAttribute', () => {
test('pass', async ({ page }) => {
await page.setContent('<div id=node>Text content</div>');
await page.setContent('<div checked id=node>Text content</div>');
const locator = page.locator('#node');
await expect(locator).toHaveAttribute('id');
await expect(locator).toHaveAttribute('checked');
await expect(locator).not.toHaveAttribute('open');
await expect(locator).toHaveAttribute('id', 'node');
});
});
Expand Down