Skip to content

Commit

Permalink
docs: updated webview tag documentation to accurately reflect preload…
Browse files Browse the repository at this point in the history
… behavior with asar archives (#30849)

Co-authored-by: ike <isaactaylor124@gmail.com>
  • Loading branch information
trop[bot] and iketheguy committed Sep 6, 2021
1 parent 1bdd60e commit 81ee511
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/api/webview-tag.md
Expand Up @@ -142,12 +142,16 @@ browser plugins. Plugins are disabled by default.
### `preload`

```html
<!-- from a file -->
<webview src="https://www.github.com/" preload="./test.js"></webview>
<!-- or if you want to load from an asar archive -->
<webview src="https://www.github.com/" preload="./app.asar/test.js"></webview>
```

A `String` that specifies a script that will be loaded before other scripts run in the guest
page. The protocol of script's URL must be either `file:` or `asar:`, because it
will be loaded by `require` in guest page under the hood.
page. The protocol of script's URL must be `file:` (even when using `asar:` archives) because
it will be loaded by Node's `require` under the hood, which treats `asar:` archives as virtual
directories.

When the guest page doesn't have node integration this script will still have
access to all Node APIs, but global objects injected by Node will be deleted
Expand Down

0 comments on commit 81ee511

Please sign in to comment.