Document lazyRouteManifest option for React Router v6 and v7#16397
Open
onurtemizkan wants to merge 2 commits intomasterfrom
Open
Document lazyRouteManifest option for React Router v6 and v7#16397onurtemizkan wants to merge 2 commits intomasterfrom
lazyRouteManifest option for React Router v6 and v7#16397onurtemizkan wants to merge 2 commits intomasterfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Collaborator
inventarSarah
left a comment
inventarSarah
left a comment
There was a problem hiding this comment.
Overall, looks good to me 🌟
Added a few suggestions
| To ensure accurate transaction names, you can provide a static list of route patterns via the `lazyRouteManifest` option. When provided, Sentry uses this manifest as the primary source for determining transaction names without needing to wait for route modules to load. | ||
|
|
||
| <Alert level="warning" title="Important"> | ||
| `lazyRouteManifest` requires `enableAsyncRouteHandlers: true` to be set on the integration. |
Collaborator
There was a problem hiding this comment.
I don't think this alert is needed because we clearly state the dependency below + it's in the code example
| }); | ||
| ``` | ||
|
|
||
| Add the `enableAsyncRouteHandlers` and `lazyRouteManifest` options to your `reactRouterV6BrowserTracingIntegration` configuration. Keep the `lazyRouteManifest` array in sync with your route definitions. Any route that doesn't match a pattern in the manifest will fall back to the default behavior, which may result in incomplete transaction names until the route is visited. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Add the `enableAsyncRouteHandlers` and `lazyRouteManifest` options to your `reactRouterV6BrowserTracingIntegration` configuration. Keep the `lazyRouteManifest` array in sync with your route definitions. Any route that doesn't match a pattern in the manifest will fall back to the default behavior, which may result in incomplete transaction names until the route is visited. | |
| Make sure to keep the `lazyRouteManifest` array in sync with your route definitions: if you add, remove, or change routes in your app, update this list accordingly. Any route that doesn't match a pattern in the manifest will fall back to the default behavior, which may result in incomplete transaction names until the route is visited. |
Let's move the first sentence above the code snippet.
I also wanted to clarify what we mean by "in sync" but maybe that's not necessary -- just a suggestion :)
| }); | ||
| ``` | ||
|
|
||
| Add the `enableAsyncRouteHandlers` and `lazyRouteManifest` options to your `reactRouterV6BrowserTracingIntegration` configuration. Keep the `lazyRouteManifest` array in sync with your route definitions. Any route that doesn't match a pattern in the manifest will fall back to the default behavior, which may result in incomplete transaction names until the route is visited. |
Collaborator
There was a problem hiding this comment.
q: in the SDK PR you wrote:
This manifest is primarily for lazy routes, but the users can also add their non-lazy routes here for convenience or consistency.
Do you think this is clear to our users, or should we also add this to the docs (maybe in a note alert)?
|
|
||
| Now, Sentry should generate `pageload`/`navigation` transactions with parameterized transaction names (for example, `/teams/:teamid/user/:userid`), where applicable. This is only needed at the top level of your app, unlike React Router v4/v5, which required wrapping every `<Route />` you wanted parametrized. | ||
|
|
||
| ## Static Route Manifest |
Collaborator
There was a problem hiding this comment.
Could it make sense to create an include for this?
| `lazyRouteManifest` requires `enableAsyncRouteHandlers: true` to be set on the integration. | ||
|
|
||
| </Alert> | ||
|
|
Collaborator
There was a problem hiding this comment.
Let's add the explanation here:
Suggested change
| To use `lazyRouteManifest`, you need to set `enableAsyncRouteHandlers: true` in your `reactRouterV6BrowserTracingIntegration` configuration: |
chargome
approved these changes
Feb 17, 2026
|
|
||
| ## Static Route Manifest | ||
|
|
||
| _Available in `@sentry/react` version `10.39.0` and above._ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents: getsentry/sentry-javascript#19086