From 9e2b76361f0044a129c10c5a91017581742338e2 Mon Sep 17 00:00:00 2001 From: leethomas Date: Fri, 1 Jan 2016 16:05:27 -0800 Subject: [PATCH] :memo: add 'did-navigate-in-page', 'did-navigate-to-different-page', 'will-navigate' to docs --- docs/api/web-contents.md | 14 ++++++++++++++ docs/api/web-view-tag.md | 22 ++++++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 2057b515c02..5b53cd14f0d 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -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 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. +### 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' Emitted when the renderer process has crashed. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 0c79083c112..8575964aab6 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -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' Fired when the guest page attempts to close itself.