From 37e92b765044bc54902a17cd0d11e821cf17346c Mon Sep 17 00:00:00 2001 From: Shelley Vohr Date: Thu, 16 Apr 2020 09:16:11 -0700 Subject: [PATCH] docs: explain the swipe event on macOS (#23117) --- docs/api/browser-window.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index ce51da2daee2..f67603a63930 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -623,6 +623,12 @@ Returns: Emitted on 3-finger swipe. Possible directions are `up`, `right`, `down`, `left`. +The method underlying this event is built to handle older macOS-style trackpad swiping, +where the content on the screen doesn't move with the swipe. Most macOS trackpads are not +configured to allow this kind of swiping anymore, so in order for it to emit properly the +'Swipe between pages' preference in `System Preferences > Trackpad > More Gestures` must be +set to 'Swipe with two or three fingers'. + #### Event: 'rotate-gesture' _macOS_ Returns: