');
using element = (await page.waitForSelector('div'))!;
await expect(element.isVisible()).resolves.toBeFalsy();
await expect(element.isHidden()).resolves.toBeTruthy();
await element.evaluate(e => {
e.style.removeProperty('display');
});
await expect(element.isVisible()).resolves.toBeTruthy();
await expect(element.isHidden()).resolves.toBeFalsy();
});
});
describe('ElementHandle.click', function () {
it('should work', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/button.html');
using button = (await page.$('button'))!;
await button.click();
expect(
await page.evaluate(() => {
return (globalThis as any).result;
})
).toBe('Clicked');
});
it('should return Point data', async () => {
const {page} = await getTestState();
const clicks: Array<[x: number, y: number]> = [];
await page.exposeFunction('reportClick', (x: number, y: number): void => {
clicks.push([x, y]);
});
await page.evaluate(() => {
document.body.style.padding = '0';
document.body.style.margin = '0';
document.body.innerHTML = `
`;
document.body.addEventListener('click', e => {
(window as any).reportClick(e.clientX, e.clientY);
});
});
using divHandle = (await page.$('div'))!;
await divHandle.click();
await divHandle.click({
offset: {
x: 10,
y: 15,
},
});
await shortWaitForArrayToHaveAtLeastNElements(clicks, 2);
expect(clicks).toEqual([
[45 + 60, 45 + 30], // margin + middle point offset
[30 + 10, 30 + 15], // margin + offset
]);
});
it('should work for Shadow DOM v1', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/shadow.html');
using buttonHandle = await page.evaluateHandle(() => {
// @ts-expect-error button is expected to be in the page's scope.
return button as HTMLButtonElement;
});
await buttonHandle.click();
expect(
await page.evaluate(() => {
// @ts-expect-error clicked is expected to be in the page's scope.
return clicked;
})
).toBe(true);
});
it('should not work for TextNodes', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/button.html');
using buttonTextNode = await page.evaluateHandle(() => {
return document.querySelector('button')!.firstChild as HTMLElement;
});
let error!: Error;
await buttonTextNode.click().catch(error_ => {
return (error = error_);
});
expect(error.message).atLeastOneToContain([
'Node is not of type HTMLElement',
'no such node',
]);
});
it('should throw for detached nodes', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/button.html');
using button = (await page.$('button'))!;
await page.evaluate((button: HTMLElement) => {
return button.remove();
}, button);
let error!: Error;
await button.click().catch(error_ => {
return (error = error_);
});
expect(error.message).atLeastOneToContain([
'Node is detached from document',
'no such node',
]);
});
it('should throw for hidden nodes', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/button.html');
using button = (await page.$('button'))!;
await page.evaluate((button: HTMLElement) => {
return (button.style.display = 'none');
}, button);
const error = await button.click().catch(error_ => {
return error_;
});
expect(error.message).atLeastOneToContain([
'Node is either not clickable or not an Element',
'no such element',
]);
});
it('should throw for recursively hidden nodes', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/button.html');
using button = (await page.$('button'))!;
await page.evaluate((button: HTMLElement) => {
return (button.parentElement!.style.display = 'none');
}, button);
const error = await button.click().catch(error_ => {
return error_;
});
expect(error.message).atLeastOneToContain([
'Node is either not clickable or not an Element',
'no such element',
]);
});
it('should throw for elements', async () => {
const {page} = await getTestState();
await page.setContent('hello goodbye');
using br = (await page.$('br'))!;
const error = await br.click().catch(error_ => {
return error_;
});
expect(error.message).atLeastOneToContain([
'Node is either not clickable or not an Element',
'no such node',
]);
});
});
describe('ElementHandle.clickablePoint', function () {
it('should work', async () => {
const {page} = await getTestState();
await page.evaluate(() => {
document.body.style.padding = '0';
document.body.style.margin = '0';
document.body.innerHTML = `
`;
});
await page.evaluate(async () => {
return await new Promise(resolve => {
return window.requestAnimationFrame(resolve);
});
});
using divHandle = (await page.$('div'))!;
expect(await divHandle.clickablePoint()).toEqual({
x: 45 + 60, // margin + middle point offset
y: 45 + 30, // margin + middle point offset
});
expect(
await divHandle.clickablePoint({
x: 10,
y: 15,
})
).toEqual({
x: 30 + 10, // margin + offset
y: 30 + 15, // margin + offset
});
});
it('should not work if the click box is not visible', async () => {
const {page} = await getTestState();
await page.setContent(
''
);
using handle = await page.locator('button').waitHandle();
await expect(handle.clickablePoint()).rejects.toBeInstanceOf(Error);
await page.setContent(
''
);
using handle2 = await page.locator('button').waitHandle();
await expect(handle2.clickablePoint()).rejects.toBeInstanceOf(Error);
await page.setContent(
''
);
using handle3 = await page.locator('button').waitHandle();
await expect(handle3.clickablePoint()).rejects.toBeInstanceOf(Error);
await page.setContent(
''
);
using handle4 = await page.locator('button').waitHandle();
await expect(handle4.clickablePoint()).rejects.toBeInstanceOf(Error);
});
it('should not work if the click box is not visible due to the iframe', async () => {
const {page} = await getTestState();
await page.setContent(
``
);
const frame = await page.waitForFrame(async frame => {
using element = await frame.frameElement();
if (!element) {
return false;
}
const name = await element.evaluate(frame => {
return frame.name;
});
return name === 'frame';
});
using handle = await frame.locator('button').waitHandle();
await expect(handle.clickablePoint()).rejects.toBeInstanceOf(Error);
await page.setContent(
``
);
const frame2 = await page.waitForFrame(async frame => {
using element = await frame.frameElement();
if (!element) {
return false;
}
const name = await element.evaluate(frame => {
return frame.name;
});
return name === 'frame2';
});
using handle2 = await frame2.locator('button').waitHandle();
await expect(handle2.clickablePoint()).rejects.toBeInstanceOf(Error);
});
it('should work for iframes', async () => {
const {page} = await getTestState();
await page.evaluate(() => {
document.body.style.padding = '10px';
document.body.style.margin = '10px';
document.body.innerHTML = `
`;
});
await page.evaluate(async () => {
return await new Promise(resolve => {
return window.requestAnimationFrame(resolve);
});
});
const frame = page.frames()[1]!;
using divHandle = (await frame.$('div'))!;
expect(await divHandle.clickablePoint()).toEqual({
x: 20 + 45 + 60, // iframe pos + margin + middle point offset
y: 20 + 45 + 30, // iframe pos + margin + middle point offset
});
expect(
await divHandle.clickablePoint({
x: 10,
y: 15,
})
).toEqual({
x: 20 + 30 + 10, // iframe pos + margin + offset
y: 20 + 30 + 15, // iframe pos + margin + offset
});
});
});
describe('Element.waitForSelector', () => {
it('should wait correctly with waitForSelector on an element', async () => {
const {page} = await getTestState();
const waitFor = page.waitForSelector('.foo').catch(err => {
return err;
}) as Promise>;
// Set the page content after the waitFor has been started.
await page.setContent(
'
bar2
Foo1
'
);
using element = (await waitFor)!;
if (element instanceof Error) {
throw element;
}
expect(element).toBeDefined();
const innerWaitFor = element.waitForSelector('.bar').catch(err => {
return err;
}) as Promise>;
await element.evaluate(el => {
el.innerHTML = '
bar1
';
});
using element2 = (await innerWaitFor)!;
if (element2 instanceof Error) {
throw element2;
}
expect(element2).toBeDefined();
expect(
await element2.evaluate(el => {
return (el as HTMLElement).innerText;
})
).toStrictEqual('bar1');
});
it('should wait correctly with waitForSelector and xpath on an element', async () => {
const {page} = await getTestState();
// Set the page content after the waitFor has been started.
await page.setContent(
`
el1
el2
el3
`
);
using elById = (await page.waitForSelector(
'#el1'
)) as ElementHandle;
using elByXpath = (await elById.waitForSelector(
'xpath/.//div'
)) as ElementHandle;
expect(
await elByXpath.evaluate(el => {
return el.id;
})
).toStrictEqual('el2');
});
});
describe('ElementHandle.hover', function () {
it('should work', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/scrollable.html');
using button = (await page.$('#button-6'))!;
await button.hover();
expect(
await page.evaluate(() => {
return document.querySelector('button:hover')!.id;
})
).toBe('button-6');
});
});
describe('ElementHandle.isIntersectingViewport', function () {
it('should work', async () => {
const {page, server} = await getTestState();
async function getVisibilityForButton(selector: string) {
using button = (await page.$(selector))!;
return await button.isIntersectingViewport();
}
await page.goto(server.PREFIX + '/offscreenbuttons.html');
const buttonsPromises = [];
// Firefox seems slow when using `isIntersectingViewport`
// so we do all the tasks asynchronously
for (let i = 0; i < 11; ++i) {
buttonsPromises.push(getVisibilityForButton('#btn' + i));
}
const buttonVisibility = await Promise.all(buttonsPromises);
for (let i = 0; i < 11; ++i) {
// All but last button are visible.
const visible = i < 10;
expect(buttonVisibility[i]).toBe(visible);
}
});
it('should work with threshold', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/offscreenbuttons.html');
// a button almost cannot be seen
// sometimes we expect to return false by isIntersectingViewport1
using button = (await page.$('#btn11'))!;
expect(
await button.isIntersectingViewport({
threshold: 0.001,
})
).toBe(false);
});
it('should work with threshold of 1', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/offscreenbuttons.html');
// a button almost cannot be seen
// sometimes we expect to return false by isIntersectingViewport1
using button = (await page.$('#btn0'))!;
expect(
await button.isIntersectingViewport({
threshold: 1,
})
).toBe(true);
});
it('should work with svg elements', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/inline-svg.html');
const [visibleCircle, visibleSvg] = await Promise.all([
page.$('circle'),
page.$('svg'),
]);
// Firefox seems slow when using `isIntersectingViewport`
// so we do all the tasks asynchronously
const [
circleThresholdOne,
circleThresholdZero,
svgThresholdOne,
svgThresholdZero,
] = await Promise.all([
visibleCircle!.isIntersectingViewport({
threshold: 1,
}),
visibleCircle!.isIntersectingViewport({
threshold: 0,
}),
visibleSvg!.isIntersectingViewport({
threshold: 1,
}),
visibleSvg!.isIntersectingViewport({
threshold: 0,
}),
]);
expect(circleThresholdOne).toBe(true);
expect(circleThresholdZero).toBe(true);
expect(svgThresholdOne).toBe(true);
expect(svgThresholdZero).toBe(true);
const [invisibleCircle, invisibleSvg] = await Promise.all([
page.$('div circle'),
page.$('div svg'),
]);
// Firefox seems slow when using `isIntersectingViewport`
// so we do all the tasks asynchronously
const [
invisibleCircleThresholdOne,
invisibleCircleThresholdZero,
invisibleSvgThresholdOne,
invisibleSvgThresholdZero,
] = await Promise.all([
invisibleCircle!.isIntersectingViewport({
threshold: 1,
}),
invisibleCircle!.isIntersectingViewport({
threshold: 0,
}),
invisibleSvg!.isIntersectingViewport({
threshold: 1,
}),
invisibleSvg!.isIntersectingViewport({
threshold: 0,
}),
]);
expect(invisibleCircleThresholdOne).toBe(false);
expect(invisibleCircleThresholdZero).toBe(false);
expect(invisibleSvgThresholdOne).toBe(false);
expect(invisibleSvgThresholdZero).toBe(false);
});
});
describe('Custom queries', function () {
afterEach(() => {
Puppeteer.clearCustomQueryHandlers();
});
it('should register and unregister', async () => {
const {page} = await getTestState();
await page.setContent('');
// Register.
Puppeteer.registerCustomQueryHandler('getById', {
queryOne: (_element, selector) => {
return document.querySelector(`[id="${selector}"]`);
},
});
using element = (await page.$(
'getById/foo'
)) as ElementHandle;
expect(
await page.evaluate(element => {
return element.id;
}, element)
).toBe('foo');
const handlerNamesAfterRegistering = Puppeteer.customQueryHandlerNames();
expect(handlerNamesAfterRegistering.includes('getById')).toBeTruthy();
// Unregister.
Puppeteer.unregisterCustomQueryHandler('getById');
try {
await page.$('getById/foo');
throw new Error('Custom query handler name not set - throw expected');
} catch (error) {
expect(error).not.toStrictEqual(
new Error('Custom query handler name not set - throw expected')
);
}
const handlerNamesAfterUnregistering =
Puppeteer.customQueryHandlerNames();
expect(handlerNamesAfterUnregistering.includes('getById')).toBeFalsy();
});
it('should throw with invalid query names', async () => {
try {
Puppeteer.registerCustomQueryHandler('1/2/3', {
queryOne: () => {
return document.querySelector('foo');
},
});
throw new Error(
'Custom query handler name was invalid - throw expected'
);
} catch (error) {
expect(error).toStrictEqual(
new Error('Custom query handler names may only contain [a-zA-Z]')
);
}
});
it('should work for multiple elements', async () => {
const {page} = await getTestState();
await page.setContent(
'