fix #408 - accessing route information

ryansolid · ryansolid · commit 1068f1bed4d4 · 2024-05-01T10:41:04.000-07:00
diff --git a/.changeset/strong-ducks-fold.md b/.changeset/strong-ducks-fold.md
@@ -0,0 +1,5 @@
+---
+"@solidjs/router": patch
+---
+
+fix #408 - accessing route information
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ It supports all of Solid's SSR methods and has Solid's transitions baked in, so
   - [useSearchParams](#usesearchparams)
   - [useIsRouting](#useisrouting)
   - [useMatch](#usematch)
+  - [useCurrentMatches](#useCurrentMatches)
   - [useBeforeLeave](#usebeforeleave)
 - [SPAs in Deployed Environments](#spas-in-deployed-environments)
 
@@ -860,6 +861,16 @@ const match = useMatch(() => props.href);
 return <div classList={{ active: Boolean(match()) }} />;
 ```
 
+### useCurrentMatches
+
+`useCurrentMatches` returns all the matches for the current matched route. Useful for getting all the route information.
+
+For example if you stored breadcrumbs on your route definition you could retrieve them like so:
+```js
+const matches = useCurrentMatches();
+const breadcrumbs = createMemo(() => matches.map(m => m.route.info.breadcrumb))
+```
+
 ### useBeforeLeave
 
 `useBeforeLeave` takes a function that will be called prior to leaving a route. The function will be called with:
diff --git a/src/index.tsx b/src/index.tsx
@@ -6,6 +6,7 @@ export {
   useIsRouting,
   useLocation,
   useMatch,
+  useCurrentMatches,
   useNavigate,
   useParams,
   useResolvedPath,
diff --git a/src/routing.ts b/src/routing.ts
@@ -91,6 +91,8 @@ export const useMatch = <S extends string>(path: () => S, matchFilters?: MatchFi
   });
 };
 
+export const useCurrentMatches = () => useRouter().matches();
+
 export const useParams = <T extends Params>() => useRouter().params as T;
 
 export const useSearchParams = <T extends Params>(): [

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@solidjs/router": patch
 +---
++
 +fix #408 - accessing route information