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

📝 add 'did-navigate-in-page', 'did-navigate-to-different-page', 'will-navigate' to docs

Browse source
This commit is contained in:
leethomas 2016-01-01 16:05:27 -08:00
parent 911e60b507
commit 9e2b76361f
2 changed files with 36 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -135,8 +135,22 @@ Emitted when a user or the page wants to start navigation. It can happen when th
This event will not emit when the navigation is started programmatically with This event will not emit when the navigation is started programmatically with
APIs like `webContents.loadURL` and `webContents.back`. APIs like `webContents.loadURL` and `webContents.back`.
It is also not emitted during in-page navigation, such as clicking anchor links
or updating the `window.location.hash`. Use `did-navigate-in-page` for this purpose.
Calling `event.preventDefault()` will prevent the navigation. Calling `event.preventDefault()` will prevent the navigation.
### Event: 'did-navigate-to-different-page'
Emitted when the new page that was navigated to is different from the previous
page.
### Event: 'did-navigate-in-page'
Emitted when the page url changes but does not cause navigation outside of the page.
Examples of this occurring are when anchor links are clicked or when the
DOM `hashchange` event is triggered.
### Event: 'crashed' ### Event: 'crashed'
Emitted when the renderer process has crashed. Emitted when the renderer process has crashed.

22
docs/api/web-view-tag.md
View file

@ -572,6 +572,28 @@ webview.addEventListener('new-window', function(e) {
}); });
``` ```
### Event: 'will-navigate'
Returns:
* `url` String
Emitted when a user or the page wants to start navigation. It can happen when the
`window.location` object is changed or a user clicks a link in the page. It not
emitted during in-page navigation such as clicking anchor links or updating the
`window.location.hash`. Use `did-navigate-in-page` for this purpose.
### Event: 'did-navigate-to-different-page'
Emitted when the new page that was navigated to is different from the previous
page.
### Event: 'did-navigate-in-page'
Emitted when the page url changes but does not cause navigation outside of the page.
Examples of this occurring are when anchor links are clicked or when the
DOM `hashchange` event is triggered.
### Event: 'close' ### Event: 'close'
Fired when the guest page attempts to close itself. Fired when the guest page attempts to close itself.