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

docs: add missing isSameDocument property to will-frame-navigate event details (#37940)

Browse source 
Co-authored-by: Milan Burda <miburda@microsoft.com>
This commit is contained in:
Milan Burda 2023-06-13 21:15:20 +02:00 • committed by GitHub
parent 18d484f39c
commit 1621fcf5d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -239,9 +239,8 @@ Returns:
* `details` Event<> * `details` Event<>
* `url` string - The URL the frame is navigating to. * `url` string - The URL the frame is navigating to.
* `isSameDocument` boolean - Whether the navigation happened without changing * `isSameDocument` boolean - This event does not fire for same document navigations using window.history api and reference fragment navigations.
document. Examples of same document navigations are reference fragment This property is always set to `false` for this event.
navigations, pushState/replaceState, and same page history navigation.
* `isMainFrame` boolean - True if the navigation is taking place in a main frame. * `isMainFrame` boolean - True if the navigation is taking place in a main frame.
* `frame` WebFrameMain - The frame to be navigated. * `frame` WebFrameMain - The frame to be navigated.
* `initiator` WebFrameMain (optional) - The frame which initiated the * `initiator` WebFrameMain (optional) - The frame which initiated the
@ -273,6 +272,8 @@ Returns:
* `details` Event<> * `details` Event<>
* `url` string - The URL the frame is navigating to. * `url` string - The URL the frame is navigating to.
* `isSameDocument` boolean - This event does not fire for same document navigations using window.history api and reference fragment navigations.
This property is always set to `false` for this event.
* `isMainFrame` boolean - True if the navigation is taking place in a main frame. * `isMainFrame` boolean - True if the navigation is taking place in a main frame.
* `frame` WebFrameMain - The frame to be navigated. * `frame` WebFrameMain - The frame to be navigated.
* `initiator` WebFrameMain (optional) - The frame which initiated the * `initiator` WebFrameMain (optional) - The frame which initiated the