useMatch doesn't update `match.search` #258
Send to my agentDescribe the bug#
Whenever the search params in the URL change, the const match = useMatch() hook re-renders but does not update the match.search.
Not sure if this behaviour is intentional, but feels wrong mainly because the useMatch hook causes a re-render but provides stale search params.
Your Example Website or App#
https://stackblitz.com/edit/react-location-usematch-vs-usesearch?file=UsingMatch.tsx
Steps to Reproduce the Bug or Issue#
const match = useMatch()- ✅
expect(match.search).toEqual({ counter: 0 }) navigate({ search: ++counter })useMatchcauses a re-render- ❌
expect(match.search).toEqual({ counter: 1 }), actual{ counter: 0 }
Expected behavior#
Whenever the search params in the URL change, the const match = useMatch() hook re-renders and provides the up-to-date match.search.
Screenshots or Videos#
No response
Platform#
- OS: macOS
- Browser: Chrome
- Version: 100.0.4896.60
Additional context#
No response
useSearchdoes give the expected result by the way.Thank you so much. I was about to switch back to react-router. The documentation is hard to follow
@xstmjh In that case, check this out: https://github.com/TanStack/react-location/issues/255#issuecomment-1117936631
We're also running into this issue when trying to migrate from React Router to React Location. Ideally, I don't want to have to use
useSearchin addition touseMatchif a route contains both route and search parameters; I'd like to be able to access them both from one hook.I have noticed that the documentation doesn't explicitly mention using
useMatchto access search parameters. However, I use TypeScript as a form of documentation anduseMatchlooks like it's supposed to return search parameters (which to be exhaustive, it does, but it doesn't appear to update them).@tannerlinsley if
useMatchis designed/intended to return up-to-date search parameters, should this be fixed? If not, should theuseMatchreturn type be updated to remove search parameters? Alternatively, are we using the APIs incorrectly and are the search parameters purposefully exposed fromuseMatchfor a reason that we're not aware of?Thanks for the great open-source libraries 🙂
TanStack Router is doing search params in a unified way now with
const { search } = router.useMatch()tannerlinsley closed this
Sign in to join this conversation.
useSearchdoes give the expected result by the way.