TanStack / router

🤖 Fully typesafe Router for React (and friends) w/ built-in caching, 1st class search-param APIs, client-side cache integration and isomorphic rendering.
https://tanstack.com/router
MIT License
8.22k stars 649 forks source link

`notFoundMode: 'root'` ignored when throw `notFound` #2416

Open Semigradsky opened 1 month ago

Semigradsky commented 1 month ago

Which project does this relate to?

Router

Describe the bug

In doc I see (https://tanstack.com/router/latest/docs/framework/react/guide/not-found-errors#notfoundmode-root) the example:

If provided the path of `/posts/1/edit`, the following component structure will be rendered:

- <Root>
- - <Root.notFoundComponent>

The notFoundComponent of the __root__ route will be rendered because the `notFoundMode` is set to `root`.

But I see another behaviour if I generate notFound error myself.

Your Example Website or App

https://stackblitz.com/edit/github-ovpjyk-3gh8gb?file=src%2Fmain.tsx

Steps to Reproduce the Bug or Issue

Try to open "Not found" or "Sub Not found" - they will be work as expected.

Try to open "Generate Not found" page - it works in another way

Expected behavior

I expect that it will be works the same as described in documentation.

Screenshots or Videos

No response

Platform

Additional context

No response

Semigradsky commented 1 month ago

Ok, I found in examples that notFound has not described option - global - https://tanstack.com/router/latest/docs/framework/react/api/router/notFoundFunction#examples

Throwing not found error like throw notFound({ global: true }) fixing my issue.

Please describe it better in documentation.