Skip to content

Add documentation for React Router 6.4 support. - #5822

Merged
AbhiPrasad merged 3 commits into
getsentry:masterfrom
onurtemizkan:onur/react-router-data-api
Nov 22, 2022
Merged

Add documentation for React Router 6.4 support.#5822
AbhiPrasad merged 3 commits into
getsentry:masterfrom
onurtemizkan:onur/react-router-data-api

Conversation

@onurtemizkan

Copy link
Copy Markdown
Collaborator

Documents: getsentry/sentry-javascript#6172

TODO: Update the version

@vercel

vercel Bot commented Nov 21, 2022

Copy link
Copy Markdown

@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
</Alert>

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

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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
Copy Markdown
Contributor

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
Copy Markdown
Contributor

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

vercel Bot commented Nov 21, 2022

Copy link
Copy Markdown

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)

@lizokm lizokm left a comment

Copy link
Copy Markdown
Contributor

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.

Comment thread src/platforms/javascript/guides/react/configuration/integrations/react-router.mdx Outdated
Comment thread src/platforms/javascript/guides/react/configuration/integrations/react-router.mdx Outdated
Co-authored-by: Liza Mock <lizka920@gmail.com>

@AbhiPrasad AbhiPrasad left a comment

Copy link
Copy Markdown
Contributor

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.

3 participants