Restore [v5] HashRouter 'hashType' prop

[thejohnhoffer]

Resolves #7703

Context

The v5 API page documenting HashRouter allows hashes to begin as # rather than #/. The v6 HashRouter no longer supports this because history@5 lost that property of history@4. Ten days ago, a contributor closed #7703. The contributor suggested the issue should be brought to the attention of with remix-run/history/, but noted "it was specifically removed in v5" of history while warning "it's not likely to return."

This is a request to replicate that feature of HashRouter that we lost in history@5 and react-router@6.

Solution

Only when <Router basename="">, this PR now supports To objects without a leading slash. Since the v5 docs claim that a "properly formatted basename should have a leading slash," this PR has no change to documented usage.

To support <HashState hashType="noslash">, that syntax is mapped to <Router basename="">.

So, the concept of a hashType is limited to the HashState constructor.

[remix-cla-bot]

Hi @thejohnhoffer,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

[timdorr]

This isn't necessary. Just provide a basename="" prop to HashRouter and you have the same thing.

There were other modes of HashRouter/History that aren't covered by this PR, so it's not actually bringing back a compatible API. It's only solving for a specific case.

[jtojnar]

Using basename="" will not work because normalizePathname will replace it with /:

react-router/packages/react-router/index.tsx

Line 270 in c68df0c

let basename = normalizePathname(basenameProp);

react-router/packages/react-router/index.tsx

Lines 1303 to 1304 in c68df0c

	const normalizePathname = (pathname: string): string =>
	pathname.replace(/\/+$/, "").replace(/^\/*/, "/");

[thejohnhoffer]

Using basename="" will not work because normalizePathname will replace it with /:
Exactly, @jtojnar!

Yes, I've noticed that as well. I've described this in issue #8459 and resolved it in PR #8460.

[thejohnhoffer]

Issues #7703 and #8459 could now be addressed with PR #8463 and remix-run/history PR #911. My previous PR #8460 was closed, but I'm hopeful the new PRs will also be considered.

[thejohnhoffer]

@jtojnar Thanks to react-router-dom@6.1.1, here's a quick workaround! It's possible the maintainers will feel history is a more appropriate place for this added feature. Even so, I know issue #912 is understandably not a high priority. Until then, a fork or wrapper can solve the issue.