feat: add back and forward mouse buttons (#8284)

This commit is contained in:
jrandolf 2022-04-27 23:00:07 +02:00 committed by GitHub
parent b0e9e6f39c
commit 7a51bff47f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 55 additions and 12 deletions

View File

@ -1466,7 +1466,7 @@ Get the browser context that the page belongs to.
- `selector` <[string]> A [selector] to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked. - `selector` <[string]> A [selector] to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked.
- `options` <[Object]> - `options` <[Object]>
- `button` <"left"|"right"|"middle"> Defaults to `left`. - `button` <"left"|"right"|"middle"|"back"|"forward"> Defaults to `left`.
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail]. - `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0. - `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully clicked. The Promise will be rejected if there is no element matching `selector`. - returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully clicked. The Promise will be rejected if there is no element matching `selector`.
@ -3508,7 +3508,7 @@ await browser
- `x` <[number]> - `x` <[number]>
- `y` <[number]> - `y` <[number]>
- `options` <[Object]> - `options` <[Object]>
- `button` <"left"|"right"|"middle"> Defaults to `left`. - `button` <"left"|"right"|"middle"|"back"|"forward"> Defaults to `left`.
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail]. - `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0. - `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- returns: <[Promise]> - returns: <[Promise]>
@ -3518,7 +3518,7 @@ Shortcut for [`mouse.move`](#mousemovex-y-options), [`mouse.down`](#mousedownopt
#### mouse.down([options]) #### mouse.down([options])
- `options` <[Object]> - `options` <[Object]>
- `button` <"left"|"right"|"middle"> Defaults to `left`. - `button` <"left"|"right"|"middle"|"back"|"forward"> Defaults to `left`.
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail]. - `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
- returns: <[Promise]> - returns: <[Promise]>
@ -3593,7 +3593,7 @@ Dispatches a `mousemove` event.
#### mouse.up([options]) #### mouse.up([options])
- `options` <[Object]> - `options` <[Object]>
- `button` <"left"|"right"|"middle"> Defaults to `left`. - `button` <"left"|"right"|"middle"|"back"|"forward"> Defaults to `left`.
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail]. - `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
- returns: <[Promise]> - returns: <[Promise]>
@ -3891,7 +3891,7 @@ Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<s
- `selector` <[string]> A [selector] to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked. - `selector` <[string]> A [selector] to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked.
- `options` <[Object]> - `options` <[Object]>
- `button` <"left"|"right"|"middle"> Defaults to `left`. - `button` <"left"|"right"|"middle"|"back"|"forward"> Defaults to `left`.
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail]. - `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0. - `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully clicked. The Promise will be rejected if there is no element matching `selector`. - returns: <[Promise]> Promise which resolves when the element matching `selector` is successfully clicked. The Promise will be rejected if there is no element matching `selector`.
@ -4654,7 +4654,7 @@ This method returns boxes of the element, or `null` if the element is not visibl
#### elementHandle.click([options]) #### elementHandle.click([options])
- `options` <[Object]> - `options` <[Object]>
- `button` <"left"|"right"|"middle"> Defaults to `left`. - `button` <"left"|"right"|"middle"|"back"|"forward"> Defaults to `left`.
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail]. - `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0. - `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- `offset` <[Object]> Offset in pixels relative to the top-left corner of the border box of the element. - `offset` <[Object]> Offset in pixels relative to the top-left corner of the border box of the element.

View File

@ -280,7 +280,7 @@ export class Keyboard {
/** /**
* @public * @public
*/ */
export type MouseButton = 'left' | 'right' | 'middle'; export type MouseButton = 'left' | 'right' | 'middle' | 'back' | 'forward';
/** /**
* @public * @public

View File

@ -32,6 +32,8 @@ import {
UnwrapPromiseLike, UnwrapPromiseLike,
} from './EvalTypes.js'; } from './EvalTypes.js';
import { isNode } from '../environment.js'; import { isNode } from '../environment.js';
import { MouseButton } from './Input.js';
/** /**
* @public * @public
*/ */
@ -1177,7 +1179,7 @@ export interface ClickOptions {
/** /**
* @defaultValue 'left' * @defaultValue 'left'
*/ */
button?: 'left' | 'right' | 'middle'; button?: MouseButton;
/** /**
* @defaultValue 1 * @defaultValue 1
*/ */

View File

@ -12,12 +12,26 @@
button.id = 'button-' + i; button.id = 'button-' + i;
button.onclick = () => button.textContent = 'clicked'; button.onclick = () => button.textContent = 'clicked';
button.oncontextmenu = event => { button.oncontextmenu = event => {
if (![2].includes(event.button)) {
return;
}
event.preventDefault(); event.preventDefault();
button.textContent = 'context menu'; button.textContent = 'context menu';
} }
button.onmouseup = event => {
if (![1,3,4].includes(event.button)) {
return;
}
event.preventDefault();
button.textContent = {
3: 'back click',
4: 'forward click',
1: 'aux click',
}[event.button];
}
document.body.appendChild(button); document.body.appendChild(button);
document.body.appendChild(document.createElement('br')); document.body.appendChild(document.createElement('br'));
} }
</script> </script>
</body> </body>
</html> </html>

View File

@ -283,6 +283,33 @@ describe('Page.click', function () {
await page.evaluate(() => document.querySelector('#button-8').textContent) await page.evaluate(() => document.querySelector('#button-8').textContent)
).toBe('context menu'); ).toBe('context menu');
}); });
it('should fire aux event on middle click', async () => {
const { page, server } = getTestState();
await page.goto(server.PREFIX + '/input/scrollable.html');
await page.click('#button-8', { button: 'middle' });
expect(
await page.evaluate(() => document.querySelector('#button-8').textContent)
).toBe('aux click');
});
it('should fire back click', async () => {
const { page, server } = getTestState();
await page.goto(server.PREFIX + '/input/scrollable.html');
await page.click('#button-8', { button: 'back' });
expect(
await page.evaluate(() => document.querySelector('#button-8').textContent)
).toBe('back click');
});
it('should fire forward click', async () => {
const { page, server } = getTestState();
await page.goto(server.PREFIX + '/input/scrollable.html');
await page.click('#button-8', { button: 'forward' });
expect(
await page.evaluate(() => document.querySelector('#button-8').textContent)
).toBe('forward click');
});
// @see https://github.com/puppeteer/puppeteer/issues/206 // @see https://github.com/puppeteer/puppeteer/issues/206
it('should click links which cause navigation', async () => { it('should click links which cause navigation', async () => {
const { page, server } = getTestState(); const { page, server } = getTestState();

View File

@ -926,21 +926,21 @@ function compareDocumentations(actual, expected) {
[ [
'Method Mouse.click() options.button', 'Method Mouse.click() options.button',
{ {
actualName: '"left"|"right"|"middle"', actualName: '"left"|"right"|"middle"|"back"|"forward"',
expectedName: 'MouseButton', expectedName: 'MouseButton',
}, },
], ],
[ [
'Method Frame.click() options.button', 'Method Frame.click() options.button',
{ {
actualName: '"left"|"right"|"middle"', actualName: '"left"|"right"|"middle"|"back"|"forward"',
expectedName: 'MouseButton', expectedName: 'MouseButton',
}, },
], ],
[ [
'Method Page.click() options.button', 'Method Page.click() options.button',
{ {
actualName: '"left"|"right"|"middle"', actualName: '"left"|"right"|"middle"|"back"|"forward"',
expectedName: 'MouseButton', expectedName: 'MouseButton',
}, },
], ],