Browse Source

docs: document when BrowserWindow and BrowserView can be used (#33696)

We already document such info for other APIs, like the 'screen' API in
https://github.com/electron/electron/blob/f711fe6b5701196e5d803c04aab44bc62b392f8e/docs/api/screen.md?plain=1#L7-L8.
So we should do the same thing for these ones too.

Signed-off-by: Darshan Sen <[email protected]>
Darshan Sen 3 years ago
parent
commit
6733279037
2 changed files with 6 additions and 0 deletions
  1. 3 0
      docs/api/browser-view.md
  2. 3 0
      docs/api/browser-window.md

+ 3 - 0
docs/api/browser-view.md

@@ -11,6 +11,9 @@ relative to its owning window. It is meant to be an alternative to the
 
 Process: [Main](../glossary.md#main-process)
 
+This module cannot be used until the `ready` event of the `app`
+module is emitted.
+
 ### Example
 
 ```javascript

+ 3 - 0
docs/api/browser-window.md

@@ -4,6 +4,9 @@
 
 Process: [Main](../glossary.md#main-process)
 
+This module cannot be used until the `ready` event of the `app`
+module is emitted.
+
 ```javascript
 // In the main process.
 const { BrowserWindow } = require('electron')