feat: make remote.getGuestWebContents() public

electron · Oct 24, 2019 · 811cc0e · 811cc0e
1 parent e196a39
commit 811cc0e
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 7 deletions.
diff --git a/docs/api/app.md b/docs/api/app.md
@@ -493,7 +493,7 @@ Returns:
 * `webContents` [WebContents](web-contents.md)
 * `guestWebContents` [WebContents](web-contents.md)
 
-Emitted when `<webview>.getWebContents()` is called in the renderer process of `webContents`.
+Emitted when `remote.getGuestWebContents()` is called in the renderer process of `webContents`.
 Calling `event.preventDefault()` will prevent the object from being returned.
 Custom value can be returned by setting `event.returnValue`.
 

diff --git a/docs/api/remote.md b/docs/api/remote.md
@@ -188,7 +188,13 @@ consequences.
 
 ### `remote.getCurrentWebContents()`
 
-Returns [`WebContents`](web-contents.md) - The web contents of this web page.
+Returns [`WebContents`](web-contents.md) - The WebContents of this web page.
+
+### `remote.getGuestWebContents(webContentsId)`
+
+* `webContentsId` Number
+
+Returns [`WebContents`](web-contents.md) - The WebContents of a `<webview>` with `webContentsId`.
 
 ### `remote.getGlobal(name)`
 

diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md
@@ -806,7 +806,7 @@ Returns:
 * `event` IpcMainEvent
 * `guestWebContents` [WebContents](web-contents.md)
 
-Emitted when `<webview>.getWebContents()` is called in the renderer process.
+Emitted when `remote.getGuestWebContents()` is called in the renderer process.
 Calling `event.preventDefault()` will prevent the object from being returned.
 Custom value can be returned by setting `event.returnValue`.
 
@@ -1390,11 +1390,13 @@ An example of showing devtools in a `<webview>` tag:
   <webview id="browser" src="https://github.com"></webview>
   <webview id="devtools"></webview>
   <script>
+    const { remote } = require('electron')
     const browserView = document.getElementById('browser')
     const devtoolsView = document.getElementById('devtools')
     browserView.addEventListener('dom-ready', () => {
-      const browser = browserView.getWebContents()
-      browser.setDevToolsWebContents(devtoolsView.getWebContents())
+      const browser = remote.getGuestWebContents(browserView.getWebContentsId())
+      const devtools = remote.getGuestWebContents(devtoolsView.getWebContentsId())
+      browser.setDevToolsWebContents(devtools)
       browser.openDevTools()
     })
   </script>

diff --git a/docs/api/webview-tag.md b/docs/api/webview-tag.md
@@ -648,9 +648,9 @@ Sets the maximum and minimum layout-based (i.e. non-visual) zoom level.
 
 Shows pop-up dictionary that searches the selected word on the page.
 
-### `<webview>.getWebContents()`
+### `<webview>.getWebContents()` _(Deprecated)_
 
-Returns [`WebContents`](web-contents.md) - The web contents associated with
+Returns [`WebContents`](web-contents.md) - The WebContents associated with
 this `webview`.
 
 It depends on the [`remote`](remote.md) module,