HashRouter NoSlash tests and minor fixes

remix-run · Mar 14, 2024 · 83efd3b · 83efd3b
1 parent 6527b22
commit 83efd3b
Show file tree

Hide file tree

Showing 13 changed files with 445 additions and 236 deletions.
diff --git a/contributors.yml b/contributors.yml
@@ -253,3 +253,4 @@
 - yracnet
 - yuleicul
 - zheng-chuang
+- Whaileee
diff --git a/docs/router-components/hash-router.md b/docs/router-components/hash-router.md
@@ -14,6 +14,7 @@ declare function HashRouter(
 
 interface HashRouterProps {
   basename?: string;
+  hashType?: HashType
   children?: React.ReactNode;
   future?: FutureConfig;
   window?: Window;
@@ -55,6 +56,22 @@ function App() {
 }
 ```
 
+## `hashType`
+
+Decide wether to put a slash after the '#' in the URL (default: 'slash')
+
+```jsx
+function App() {
+  return (
+    <HashRouter hashType='noslash'>
+      <Routes>
+        <Route path="/bookmark" /> {/* 👈 Renders at /#bookmark/ */}
+      </Routes>
+    </HashRouter>
+  );
+}
+```
+
 ## `future`
 
 An optional set of [Future Flags][api-development-strategy] to enable. We recommend opting into newly released future flags sooner rather than later to ease your eventual migration to v7.