Route matching follows a consistent and predictable pattern. This guide will explain how route trees are matched.
When TanStack Router processes your route tree, all of your routes are automatically sorted to match the most specific routes first. This means that regardless of the order your route tree is defined, routes will always be sorted in this order:
Consider the following pseudo route tree:
Root
- blog
- $postId
- /
- new
- /
- *
- about
- about/us
Root
- blog
- $postId
- /
- new
- /
- *
- about
- about/us
After sorting, this route tree will become:
Root
- /
- about/us
- about
- blog
- /
- new
- $postId
- *
Root
- /
- about/us
- about
- blog
- /
- new
- $postId
- *
This final order represents the order in which routes will be matched based on specificity.
Using that route tree, let's follow the matching process for a few different URLs:
Root
❌ /
❌ about/us
❌ about
⏩ blog
✅ /
- new
- $postId
- *
Root
❌ /
❌ about/us
❌ about
⏩ blog
✅ /
- new
- $postId
- *
Root
❌ /
❌ about/us
❌ about
⏩ blog
❌ /
❌ new
✅ $postId
- *
Root
❌ /
❌ about/us
❌ about
⏩ blog
❌ /
❌ new
✅ $postId
- *
Root
✅ /
- about/us
- about
- blog
- /
- new
- $postId
- *
Root
✅ /
- about/us
- about
- blog
- /
- new
- $postId
- *
Root
❌ /
❌ about/us
❌ about
❌ blog
- /
- new
- $postId
✅ *
Root
❌ /
❌ about/us
❌ about
❌ blog
- /
- new
- $postId
✅ *
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.