Browse Source

Merge pull request #10356 from electron/update-browser-window-docs

update browser-window.md
Zeke Sikelianos 7 years ago
parent
commit
87d4666648
1 changed files with 2 additions and 1 deletions
  1. 2 1
      docs/api/browser-window.md

+ 2 - 1
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'