Allow setting history state in redirect

[stuartkeith]

In Remix, if you have an action that redirects to another page, and you want to pass some information to the target page's loader, you can set properties on the response. For example, you can set a cookie via redirect second argument, and read that in the loader for the destination page (see https://remix.run/docs/en/1.19.3/utils/sessions#sessionflashkey-value):

return redirect("/dashboard", {
  headers: {
    "Set-Cookie": await commitSession(session),
  },
});

React Router supports this second argument, but setting cookies won't work because there is no actual request being made.

I think the equivalent of this in React Router would be history.state (since redirect ultimately uses pushState under the hood).

return redirect("/dashboard", {
  state: {
    "sessionData": await commitSession(session),
  },
});

Other parts of React Router support this - e.g. the Link component (https://reactrouter.com/en/v6/components/link#state), and useNavigate (https://reactrouter.com/en/v6/hooks/use-navigate#optionsstate). So it seems useful for an action to be able to set this state for the same reasons it's useful a Link or navigate() call can.