mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: updated webview tag documentation to accurately reflect preload behavior with asar archives (#30768)

Browse source
This commit is contained in:
Isaac Taylor 2021-09-06 02:00:17 -06:00 • committed by GitHub
parent 7379e5eb36
commit 4a2f41ee58
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/api/webview-tag.md
View file

@ -143,12 +143,16 @@ browser plugins. Plugins are disabled by default.
### `preload` ### `preload`
```html ```html
<!-- from a file -->
<webview src="https://www.github.com/" preload="./test.js"></webview> <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 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 page. The protocol of script's URL must be `file:` (even when using `asar:` archives) because
will be loaded by `require` in guest page under the hood. 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 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 access to all Node APIs, but global objects injected by Node will be deleted