Skip to content
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.

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

Add documentation for React Router 6.4 support. #5822

Merged
merged 3 commits into from Nov 22, 2022

Conversation

onurtemizkan
Copy link
Collaborator

Documents: getsentry/sentry-javascript#6172

TODO: Update the version

@vercel
Copy link

vercel bot commented Nov 21, 2022

@onurtemizkan is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@onurtemizkan onurtemizkan requested review from AbhiPrasad and imatwawana and removed request for AbhiPrasad November 21, 2022 14:07
@@ -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

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

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

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.


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

[`createHashRouter`](https://reactrouter.com/en/main/routers/create-hash-router) is not yet supported by Sentry. On the other hand [`createMemoryRouter`](https://reactrouter.com/en/main/routers/create-memory-router) can be instrumented using `wrapCreateBrowserRouter` function.
Copy link
Member

Choose a reason for hiding this comment

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

we should create a GH issue about createHashRouter that we can link folks to here.

@imatwawana imatwawana requested review from lizokm and removed request for imatwawana November 21, 2022 14:30
@vercel
Copy link

vercel bot commented Nov 21, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Nov 21, 2022 at 4:41PM (UTC)

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Made a few small tweaks, but otherwise this looks good.

Co-authored-by: Liza Mock <lizka920@gmail.com>
Copy link
Member

@AbhiPrasad AbhiPrasad left a comment

Choose a reason for hiding this comment

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

@AbhiPrasad AbhiPrasad merged commit 4580b39 into getsentry:master Nov 22, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Dec 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants