Editorial review: Add precommitHandler() and other info to Navigation API docs #41524
Conversation
chrisdavidmills
requested review from
sideshowbarker
and removed request for
a team
chrisdavidmills
changed the title
|
Preview URLs
(comment last updated: 2025-10-20 09:52:19) |
|
|
||
| ## Description | ||
|
|
||
| The `intercept()` method is used to implement custom SPA navigation behavior when a navigation occurs, for example when a link is clicked, a form is submitted, or a programmatic navigation is initiated (using {{domxref("History.pushState()")}}, {{domxref("Window.location")}}, etc.). |
There was a problem hiding this comment.
I think "SPA navigation behavior" is a bit of an awkward wording, but I'll leave that to the editorial review.
There was a problem hiding this comment.
I've changed it to "...implement same-document (SPA) navigation behavior..." for now, but we can iterate on it further if required.
| - `history` {{optional_inline}} | ||
| - : An enumerated value that specifies how this redirect should be added to the navigation history. It can take one of the following values: | ||
| - `auto` | ||
| - : The default value, which lets the browser decide how to handle it. Usually the value used is `push`, but it will become `replace` if the redirect points to the same URL as the pre-navigation URL. |
There was a problem hiding this comment.
It can also be whatever was passed to navigate(). The main point of auto is that the redirect call doesn't change history handling.
There was a problem hiding this comment.
OK, I think I know what you mean here. Is the following correct? (ignore the formatting)
auto- : The default value, which lets the browser decide how to handle it:
- If the original navigation occurred as a result of a {{domxref("Navigation.navigate()")}} call, the value will be whatever was specified in the
navigate()call'shistoryoption. - Otherwise, the value used is usually
push, but it will becomereplaceif the redirect points to the same URL as the pre-navigation URL.
- If the original navigation occurred as a result of a {{domxref("Navigation.navigate()")}} call, the value will be whatever was specified in the
- : The default value, which lets the browser decide how to handle it:
|
|
||
| - `state` {{optional_inline}} | ||
| - : Contains any state information you want to pass along with the navigation, for example, for logging or tracking purposes. The state for the navigation can subsequently be retrieved via {{domxref("NavigationHistoryEntry.getState()")}}. | ||
| - `history` {{optional_inline}} |
There was a problem hiding this comment.
Something about this: redirect can change the behavior between auto/push/replace, but it cannot turn a traverse navigation to a push/replace navigation or vice versa.
There was a problem hiding this comment.
Cool; I've added this info as a note at the bottom of the bit about replace():
Note
The redirect() method can can convert the history behavior between auto, push, and replace, but it cannot turn a traverse navigation into a push/replace navigation and vice versa.
Co-authored-by: Noam Rosenthal <[email protected]>
|
@noamr thanks for the reviews. This one looks about ready to go on to the editorial review stage now, but feel free to add more comments if you think anything else still needs attention. |
chrisdavidmills
changed the title
Yes, technical LGTM from me! |
2 participants
Description
Chromium 141 adds support for the
precommitHandleroption of theNavigateEvent.intercept()method. See https://chromestatus.com/feature/5134734612496384.This PR adds documentation for it.
It also overhauls the
intercept()method page in general, adding a bunch of details in a large "Description" section that was missing before. I think more work needs to be done here, but it is out of the scope of this PR for me to try to fix everything. For now, I've added a bit more information about how theintercept()features work so that the page is a bit more informative.Motivation
Additional details
Related issues and pull requests