Skip to content

Commit 2c0933b

Browse files
chore: update ref to docs (🤖) (#881)
Co-authored-by: electron-website-docs-updater[bot] <166660481+electron-website-docs-updater[bot]@users.noreply.github.com>
1 parent 6edbb12 commit 2c0933b

7 files changed

Lines changed: 39 additions & 3 deletions

File tree

‎docs/latest/.sha‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
347fd37dfbf089f2d66aebd0811672d93f49bb6f
1+
6ee299c9eec451d1efcab4be09c3b3e4a028d2c9

‎docs/latest/api/clipboard.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ hide_title: false
1111
1212
Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process) (non-sandboxed only)
1313

14+
> [!IMPORTANT]
15+
> If you want to call this API from a renderer process with context isolation enabled,
16+
> place the API call in your preload script and
17+
> [expose](../tutorial/context-isolation.md#after-context-isolation-enabled) it using the
18+
> [`contextBridge`](context-bridge.md) API.
19+
1420
On Linux, there is also a `selection` clipboard. To manipulate it
1521
you need to pass `selection` to each method:
1622

‎docs/latest/api/crash-reporter.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ hide_title: false
1111
1212
Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
1313

14+
> [!IMPORTANT]
15+
> If you want to call this API from a renderer process with context isolation enabled,
16+
> place the API call in your preload script and
17+
> [expose](../tutorial/context-isolation.md#after-context-isolation-enabled) it using the
18+
> [`contextBridge`](context-bridge.md) API.
19+
1420
The following is an example of setting up Electron to automatically submit
1521
crash reports to a remote server:
1622

‎docs/latest/api/ipc-renderer.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ changes:
1818
1919
Process: [Renderer](../glossary.md#renderer-process)
2020
21+
> [!IMPORTANT]
22+
> If you want to call this API from a renderer process with context isolation enabled,
23+
> place the API call in your preload script and
24+
> [expose](../tutorial/context-isolation.md#after-context-isolation-enabled) it using the
25+
> [`contextBridge`](context-bridge.md) API.
26+
2127
The `ipcRenderer` module is an [EventEmitter][event-emitter]. It provides a few
2228
methods so you can send synchronous and asynchronous messages from the render
2329
process (web page) to the main process. You can also receive replies from the

‎docs/latest/api/native-image.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ hide_title: false
1111
1212
Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
1313

14+
> [!IMPORTANT]
15+
> If you want to call this API from a renderer process with context isolation enabled,
16+
> place the API call in your preload script and
17+
> [expose](../tutorial/context-isolation.md#after-context-isolation-enabled) it using the
18+
> [`contextBridge`](context-bridge.md) API.
19+
1420
The `nativeImage` module provides a unified interface for manipulating
1521
system images. These can be handy if you want to provide multiple scaled
1622
versions of the same icon or take advantage of macOS [template images][template-image].

‎docs/latest/api/web-frame.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ hide_title: false
1111
1212
Process: [Renderer](../glossary.md#renderer-process)
1313

14+
> [!IMPORTANT]
15+
> If you want to call this API from a renderer process with context isolation enabled,
16+
> place the API call in your preload script and
17+
> [expose](../tutorial/context-isolation.md#after-context-isolation-enabled) it using the
18+
> [`contextBridge`](context-bridge.md) API.
19+
1420
`webFrame` export of the Electron module is an instance of the `WebFrame`
1521
class representing the current frame. Sub-frames can be retrieved by
1622
certain properties and methods (e.g. `webFrame.firstChild`).
@@ -146,7 +152,7 @@ by its key, which is returned from `webFrame.insertCSS(css)`.
146152

147153
Inserts `text` to the focused element.
148154

149-
### `webFrame.executeJavaScript(code[, userGesture, callback])`
155+
### `webFrame.executeJavaScript(code[, userGesture][, callback])`
150156

151157
* `code` string
152158
* `userGesture` boolean (optional) - Default is `false`.
@@ -167,7 +173,7 @@ In the browser window some HTML APIs like `requestFullScreen` can only be
167173
invoked by a gesture from the user. Setting `userGesture` to `true` will remove
168174
this limitation.
169175

170-
### `webFrame.executeJavaScriptInIsolatedWorld(worldId, scripts[, userGesture, callback])`
176+
### `webFrame.executeJavaScriptInIsolatedWorld(worldId, scripts[, userGesture][, callback])`
171177

172178
* `worldId` Integer - The ID of the world to run the javascript
173179
in, `0` is the default main world (where content runs), `999` is the

‎docs/latest/api/web-utils.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ hide_title: false
1111
1212
Process: [Renderer](../glossary.md#renderer-process)
1313

14+
> [!IMPORTANT]
15+
> If you want to call this API from a renderer process with context isolation enabled,
16+
> place the API call in your preload script and
17+
> [expose](../tutorial/context-isolation.md#after-context-isolation-enabled) it using the
18+
> [`contextBridge`](context-bridge.md) API.
19+
1420
## Methods
1521

1622
The `webUtils` module has the following methods:

0 commit comments

Comments
 (0)