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

improve doc for loadURL

Browse source
This commit is contained in:
Zeke Sikelianos 2016-08-18 22:20:55 -07:00
parent 488fe53276
commit d9901e62b6
2 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/api/browser-window.md
View file

@ -14,7 +14,11 @@ win.on('closed', () => {
win = null win = null
}) })
// Load a remote URL
win.loadURL('https://github.com') win.loadURL('https://github.com')
// Or load a local HTML file
win.loadURL(`file://${__dirname}/app/index.html`)
``` ```
## Frameless window ## Frameless window
@ -946,6 +950,9 @@ Same as `webContents.capturePage([rect, ]callback)`.
Same as `webContents.loadURL(url[, options])`. Same as `webContents.loadURL(url[, options])`.
The `url` can be a remote address (e.g. `http://`) or a path to a local
HTML file using the `file://` protocol.
#### `win.reload()` #### `win.reload()`
Same as `webContents.reload`. Same as `webContents.reload`.

2
docs/api/web-contents.md
View file

@ -493,7 +493,7 @@ win.loadURL('http://github.com')
* `userAgent` String - A user agent originating the request. * `userAgent` String - A user agent originating the request.
* `extraHeaders` String - Extra headers separated by "\n" * `extraHeaders` String - Extra headers separated by "\n"
Loads the `url` in the window, the `url` must contain the protocol prefix, Loads the `url` in the window. The `url` must contain the protocol prefix,
e.g. the `http://` or `file://`. If the load should bypass http cache then e.g. the `http://` or `file://`. If the load should bypass http cache then
use the `pragma` header to achieve it. use the `pragma` header to achieve it.