github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-04-10 03:01:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

feat: allow intercepting mouse events (#47280)

Browse Source 
* feat: allow intercepting mouse events

* test: add specs

* Update spec/api-web-contents-spec.ts

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>

---------

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
This commit is contained in:
Shelley Vohr
2025-06-04 14:10:33 +02:00
committed by GitHub
parent c22f94037a
commit fbb3fa7503
7 changed files with 192 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
spec/api-web-contents-spec.ts
View File

@@ -1071,6 +1071,76 @@ describe('webContents module', () => {
});
});
describe('before-mouse-event event', () => {
afterEach(closeAllWindows);
it('can prevent document mouse events', async () => {
const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
await w.loadFile(path.join(fixturesPath, 'pages', 'mouse-events.html'));
const mouseDown = new Promise(resolve => {
ipcMain.once('mousedown', (event, button) => resolve(button));
});
w.webContents.once('before-mouse-event', (event, input) => {
if (input.button === 'left') event.preventDefault();
});
w.webContents.sendInputEvent({ type: 'mouseDown', button: 'left', x: 100, y: 100 });
w.webContents.sendInputEvent({ type: 'mouseDown', button: 'right', x: 100, y: 100 });
expect(await mouseDown).to.equal(2); // Right button is 2
});
it('has the correct properties', async () => {
const w = new BrowserWindow({ show: false });
await w.loadFile(path.join(fixturesPath, 'pages', 'base-page.html'));
const testBeforeMouse = async (opts: Electron.MouseInputEvent) => {
const p = once(w.webContents, 'before-mouse-event');
w.webContents.sendInputEvent({
type: opts.type,
button: opts.button,
x: opts.x,
y: opts.y,
globalX: opts.globalX,
globalY: opts.globalY,
clickCount: opts.clickCount
});
const [, input] = await p;
expect(input.type).to.equal(opts.type);
expect(input.button).to.equal(opts.button);
expect(input.x).to.equal(opts.x);
expect(input.y).to.equal(opts.y);
expect(input.globalX).to.equal(opts.globalX);
expect(input.globalY).to.equal(opts.globalY);
expect(input.clickCount).to.equal(opts.clickCount);
};
await testBeforeMouse({
type: 'mouseDown',
button: 'left',
x: 100,
y: 100,
globalX: 200,
globalY: 200,
clickCount: 1
});
await testBeforeMouse({
type: 'mouseUp',
button: 'right',
x: 150,
y: 150,
globalX: 250,
globalY: 250,
clickCount: 2
});
await testBeforeMouse({
type: 'mouseMove',
button: 'middle',
x: 200,
y: 200,
globalX: 300,
globalY: 300,
clickCount: 0
});
});
});
describe('before-input-event event', () => {
afterEach(closeAllWindows);
it('can prevent document keyboard events', async () => {

20
spec/fixtures/pages/mouse-events.html vendored Normal file
View File

@@ -0,0 +1,20 @@
<html>
<body>
<input type="text" id="input" autofocus />
<script type="text/javascript" charset="utf-8">
const { ipcRenderer } = require('electron')
document.onmousedown = function (e) {
ipcRenderer.send('mousedown', e.button, e.x, e.screenX, e.y, e.screenY)
}
document.onmouseup = function (e) {
ipcRenderer.send('mouseup', e.button, e.x, e.screenX, e.y, e.screenY)
}
document.onmousemove = function (e) {
ipcRenderer.send('mousemove', e.button, e.x, e.screenX, e.y, e.screenY)
}
</script>
</body>
</html>