Browse Source

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

leethomas 9 years ago
parent
commit
9e2b76361f
2 changed files with 36 additions and 0 deletions
  1. 14 0
      docs/api/web-contents.md
  2. 22 0
      docs/api/web-view-tag.md

+ 14 - 0
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.

+ 22 - 0
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.