electron-trackpad-utils v1.0.1

electron-trackpad-utils

Trigger trackpad haptic feedback and get trackpad scroll began, scroll ended, and force click events in Electron on macOS.

See demo code

Installing

npm install electron-trackpad-utils

API

onTrackpadScrollBegan(callback) (macOS only)

• callback Function

This fires when the user starts dragging touches on the trackpad.

onTrackpadScrollEnded(callback) (macOS only)

• callback Function

This is triggered when the touches end during scrolling. This may be different from when the scroll events sent to the browser end, in the case of inertial scrolling.

onForceClick(callback) (macOS only)

• callback Function

triggerFeedback() (macOS only)

Triggers haptic feedback on the MacBook's built-in trackpad or Magic Trackpad. For example, trigger feedback when snapping to alignment while dragging an object.

Usage

In main process:

const { BrowserWindow } = require("electron");
const trackpadUtils = require("electron-trackpad-utils");

trackpadUtils.onTrackpadScrollBegan(() => {
	console.log("onTrackpadScrollBegan");
});

trackpadUtils.onTrackpadScrollEnded(() => {
	console.log("onTrackpadScrollEnded");
});

trackpadUtils.onForceClick(() => {
	console.log("onForceClick");
});

function createWindow() {
	const mainWindow = new BrowserWindow({
		height: 500,
		width: 800,
	});
	mainWindow.webContents.loadFile("index.html");
	setInterval(() => {
		trackpadUtils.triggerFeedback();
	}, 3000);
}

app.whenReady().then(() => createWindow());

How to Run Demo

After cloning this repository, run:

npm install
npm rebuild
cd demo
npm install
npm start

License

MIT License