Add state/info when redirecting

noamr · web-flow · commit 6d94196d5950 · 2025-04-16T17:34:35.000+09:00
Closes #286.
diff --git a/README.md b/README.md
@@ -708,14 +708,15 @@ Because precommit handlers can be used to cancel the navigation before the URL u
 
 #### Redirects during deferred commit
 
-The `precommitHandler` callback accepts an argument, which is a `controller` that can perform certain actions on the precommitted navigation, in particular redirecting. This updates the eventual destination of the `"push"` or `"replace"` navigation. An example usage is as follows
+The `precommitHandler` callback accepts an argument, which is a `controller` that can perform certain actions on the precommitted navigation, in particular redirecting. This updates the eventual destination, and potentially the state/info, of the `"push"` or `"replace"` navigation.
+An example usage is as follows:
 
 ```js
 navigation.addEventListener("navigate", e => {
   e.intercept({
     async precommitHandler(controller) {
       if (await isLoginGuarded(e.destination)) {
-        controller.redirect("/login");
+        controller.redirect("/login", {state: "login-redirect", info: "some-info"});
       }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -708,14 +708,15 @@ Because precommit handlers can be used to cancel the navigation before the URL u`
`708`	`708`
`709`	`709`	`#### Redirects during deferred commit`
`710`	`710`
`711`		-The `precommitHandler` callback accepts an argument, which is a `controller` that can perform certain actions on the precommitted navigation, in particular redirecting. This updates the eventual destination of the `"push"` or `"replace"` navigation. An example usage is as follows
	`711`	+The `precommitHandler` callback accepts an argument, which is a `controller` that can perform certain actions on the precommitted navigation, in particular redirecting. This updates the eventual destination, and potentially the state/info, of the `"push"` or `"replace"` navigation.
	`712`	`+An example usage is as follows:`
`712`	`713`
`713`	`714`	```js
`714`	`715`	`navigation.addEventListener("navigate", e => {`
`715`	`716`	`e.intercept({`
`716`	`717`	`async precommitHandler(controller) {`
`717`	`718`	`if (await isLoginGuarded(e.destination)) {`
`718`		`- controller.redirect("/login");`
	`719`	`+ controller.redirect("/login", {state: "login-redirect", info: "some-info"});`
`719`	`720`	`}`
`720`	`721`	`}`
`721`	`722`