From 54b44584fa9a1f5a142e8eb6b446084e962cec75 Mon Sep 17 00:00:00 2001 From: Erick Zhao Date: Tue, 14 Sep 2021 17:41:37 -0700 Subject: [PATCH] chore: correct hierarchy of BrowserWindow headings (#30905) * chore: correct hierarchy of BrowserWindow headings * Update docs/api/browser-window.md Co-authored-by: Mark Lee * Update docs/api/browser-window.md Co-authored-by: Mark Lee * Update docs/api/browser-window.md Co-authored-by: Mark Lee Co-authored-by: Mark Lee --- docs/api/browser-window.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 10f4533fda..5713f49cc5 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -22,12 +22,13 @@ win.loadFile('index.html') To create a window without chrome, or a transparent window in arbitrary shape, you can use the [Frameless Window](frameless-window.md) API. -## Showing window gracefully +## Showing the window gracefully -When loading a page in the window directly, users may see the page load incrementally, which is not a good experience for a native app. To make the window display -without visual flash, there are two solutions for different situations. +When loading a page in the window directly, users may see the page load incrementally, +which is not a good experience for a native app. To make the window display +without a visual flash, there are two solutions for different situations. -## Using `ready-to-show` event +### Using the `ready-to-show` event While loading the page, the `ready-to-show` event will be emitted when the renderer process has rendered the page for the first time if the window has not been shown yet. Showing @@ -48,7 +49,7 @@ event. Please note that using this event implies that the renderer will be considered "visible" and paint even though `show` is false. This event will never fire if you use `paintWhenInitiallyHidden: false` -## Setting `backgroundColor` +### Setting the `backgroundColor` property For a complex app, the `ready-to-show` event could be emitted too late, making the app feel slow. In this case, it is recommended to show the window