Browse Source

Update browser-window.md

Notes that maximize will also show the window and that ready-to-show won't fire if the window is already being displayed. (See issue #8861)
TanninOne 8 years ago
parent
commit
410e80682a
1 changed files with 5 additions and 4 deletions
  1. 5 4
      docs/api/browser-window.md

+ 5 - 4
docs/api/browser-window.md

@@ -36,8 +36,8 @@ without visual flash, there are two solutions for different situations.
 ### Using `ready-to-show` event
 
 While loading the page, the `ready-to-show` event will be emitted when renderer
-process has done drawing for the first time, showing window after this event
-will have no visual flash:
+process has done drawing for the first time if the window is not shown yet. Showing
+the window after this event will have no visual flash:
 
 ```javascript
 const {BrowserWindow} = require('electron')
@@ -390,7 +390,7 @@ Emitted when the window is hidden.
 
 #### Event: 'ready-to-show'
 
-Emitted when the web page has been rendered and window can be displayed without
+Emitted when the web page has been rendered (while not being shown) and window can be displayed without
 a visual flash.
 
 #### Event: 'maximize'
@@ -632,7 +632,8 @@ Returns `Boolean` - Whether current window is a modal window.
 
 #### `win.maximize()`
 
-Maximizes the window.
+Maximizes the window. This will also show (but not focus) the window if it
+isn't being displayed already.
 
 #### `win.unmaximize()`