Skip to content

Commit

Permalink
docs: document when BrowserWindow and BrowserView can be used (#33696)
Browse files Browse the repository at this point in the history
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 <raisinten@gmail.com>
  • Loading branch information
RaisinTen committed Apr 18, 2022
1 parent 2d0ad04 commit 6733279
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/api/browser-view.md
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/api/browser-window.md
Expand Up @@ -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')
Expand Down

0 comments on commit 6733279

Please sign in to comment.