Skip to content

docs(react): Update warning on react router library docs #12189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 20, 2024
Merged

docs(react): Update warning on react router library docs #12189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/platforms/javascript/guides/react/features/react-router/v6.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ Update your `Sentry.browserTracingIntegration` to `Sentry.reactRouterV6BrowserTr

<Alert level="warning">

Make sure you call `Sentry.init`, **before** you wrap your `<Routes />` component or the `useRoutes` hook. Otherwise, the routing instrumentation may not work properly.
To ensure proper routing instrumentation, initialize Sentry by calling `Sentry.init` **before**:
- Wrapping your `<Routes />` component
- Using `useRoutes`
- Using `createBrowserRouterV6`

</Alert>

Expand Down Expand Up @@ -56,7 +59,7 @@ Sentry.init({
});

const sentryCreateBrowserRouter =
Sentry.wrapCreateBrowserRouter(createBrowserRouter);
Sentry.wrapCreateBrowserRouterV6(createBrowserRouter);

const router = sentryCreateBrowserRouter([
// your routes...
Expand Down
5 changes: 4 additions & 1 deletion docs/platforms/javascript/guides/react/features/react-router/v7.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ Update your `Sentry.browserTracingIntegration` to `Sentry.reactRouterV7BrowserTr

<Alert level="warning">

Make sure you call `Sentry.init`, **before** you wrap your `<Routes />` component or the `useRoutes` hook. Otherwise, the routing instrumentation may not work properly.
To ensure proper routing instrumentation, initialize Sentry by calling `Sentry.init` **before**:
- Wrapping your `<Routes />` component
- Using `useRoutes`
- Using `createBrowserRouterV7`

</Alert>

Expand Down
Loading