Skip to content

Add documentation for React Router 6.4 support. #5822

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 3 commits into from
Nov 22, 2022
Merged

Add documentation for React Router 6.4 support. #5822

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bd6ecd
Add documentation for React Router 6.4 support.
onurtemizkan Nov 21, 2022
4351168
Use `javascript` code block instead of `jsx`.
onurtemizkan Nov 21, 2022
93ce4fa
Apply suggestions from code review
onurtemizkan Nov 22, 2022
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
46 changes: 46 additions & 0 deletions src/platforms/javascript/guides/react/configuration/integrations/react-router.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,51 @@ Make sure `Sentry.reactRouterV6Instrumentation` is initialized by your `Sentry.i

</Alert>

### Usage with React Router 6.4 Data API
_(Available in version 7.21.0 and above)_
Copy link
Member

@AbhiPrasad AbhiPrasad Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move this above v6?

Copy link
Collaborator Author

@onurtemizkan onurtemizkan Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The initialization part above is common for all 6.x versions (reactRouterV6Instrumentation(...)). Will have to repeat that info if we do that?

Copy link
Member

@AbhiPrasad AbhiPrasad Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah fair, than we can keep it here.



If you choose to create your router instance with [`createBrowserRouter`](https://reactrouter.com/en/main/routers/create-browser-router) from the `react-router-dom` package, you can use `Sentry.wrapCreateBrowserRouter` to wrap it with the instrumentation:

```javascript
import { createBrowserRouter } from 'react-router-dom';
import * as Sentry from '@sentry/react';
import { BrowserTracing } from '@sentry/tracing';

Sentry.init({
dsn: '___PUBLIC_DSN___',
integrations: [
new BrowserTracing({
routingInstrumentation: Sentry.reactRouterV6Instrumentation(
React.useEffect,
useLocation,
useNavigationType,
createRoutesFromChildren,
matchRoutes,
),
}),
],
tracesSampleRate: 1.0,
});


const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouter(
createBrowserRouter
);

const router = sentryCreateBrowserRouter([
// ...
]);

```

<Alert level="warning" title="Note">

While [`createHashRouter`](https://reactrouter.com/en/main/routers/create-hash-router) isn't supported by Sentry yet, you can instrument [`createMemoryRouter`](https://reactrouter.com/en/main/routers/create-memory-router) using the `wrapCreateBrowserRouter` function.

</Alert>


### Usage With `<Routes />` Component

If you use the `<Routes />` component from `react-router-dom` to define your routes, wrap [`Routes`](https://reactrouter.com/docs/en/v6/api#routes-and-route) using `Sentry.withSentryReactRouterV6Routing`. This creates a higher order component, which will enable Sentry to reach your router context, as in the example below:
Expand Down Expand Up @@ -99,6 +144,7 @@ import {
} from "react-router-dom";
import { wrapUseRoutes } from "@sentry/react";
import { useEffect } from "react";
import { BrowserTracing } from "@sentry/tracing";

Sentry.init({
dsn: "___DSN___",
Expand Down