Skip to content
Source
Sign inSign up
TanStack/router

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

Send to my agent
ClosedSemigradsky(GitHub profile, opens in a new tab) opened this issue 3 comments

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

  • OS: [e.g. macOS, Windows, Linux]
  • Browser: [e.g. Chrome, Safari, Firefox]
  • Version: [e.g. 91.1]

Additional context

No response

  1. 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.

  2. schiller-manuel(GitHub profile, opens in a new tab) added labelsdocumentation

  3. Hi @schiller-manuel I was planning to grab this issue to update the docs, but global is deprecated. What should we do then?

    Something like this? If so, I can create a MR for this.

    Image
  4. The supported replacement for deprecated global: true is throw notFound({ routeId: rootRouteId }), which targets the root notFoundComponent @Christopher96u.

    This is now documented in the not-found guide and API reference. If you are seeing different behaviour on a current version, please open a new issue with a minimal reproduction!

Sign in to join this conversation.