From bb153ee79e6bb4e54d4d075f64a448f498fbeff8 Mon Sep 17 00:00:00 2001 From: Vanessa Yuen Date: Fri, 25 Aug 2017 17:14:20 -0400 Subject: [PATCH] update browser-window.md Add a note about the subtle difference between `window.onbeforeunload = handler` and `window.addEventListener('beforeunload', handler)`. --- docs/api/browser-window.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 57d71da59cdb..a62fdd0f48fb 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -410,9 +410,10 @@ window.onbeforeunload = (e) => { // a non-void value will silently cancel the close. // It is recommended to use the dialog API to let the user confirm closing the // application. - e.returnValue = false +  e.returnValue = false // equivalent to `return false` but not recommended } ``` +_**Note**: There is a subtle difference between the behaviors of `window.onbeforeunload = handler` and `window.addEventListener('beforeunload', handler)`. It is recommended to always set the `event.returnValue` explicitly, instead of just returning a value, as the former works more consistently within Electron._ #### Event: 'closed'