-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(solid): adds TanStack Router Solid docs page #15054
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
Merged
andreiborza
merged 6 commits into
getsentry:master
from
thedanchez:tanstack-router-solid
Oct 15, 2025
Merged
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
71bb277
docs(solid): adds TanStack Router Solid docs page
thedanchez dfe5b79
Update docs/platforms/javascript/guides/solid/features/tanstack-route…
andreiborza b0fac31
Update docs/platforms/javascript/guides/solid/features/tanstack-route…
andreiborza a347aa7
Update docs/platforms/javascript/guides/solid/features/tanstack-route…
andreiborza 346fdfe
Update docs/platforms/javascript/guides/solid/features/tanstack-route…
andreiborza d97224e
Update docs/platforms/javascript/guides/solid/features/tanstack-route…
andreiborza File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
48 changes: 48 additions & 0 deletions
48
docs/platforms/javascript/guides/solid/features/tanstack-router.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| title: TanStack Router | ||
| description: "Learn about Sentry's TanStack Router integration." | ||
| --- | ||
|
|
||
| The TanStack Router integration is included in the `@sentry/solid` package and is compatible with version `1.132.27` of `@tanstack/solid-router` and above. | ||
|
|
||
| <Alert title="Note"> | ||
|
|
||
| The TanStack Router integration is designed to work with Sentry Tracing. Please see <PlatformLink to="/tracing/#enable-tracing">Getting Started with Solid Performance</PlatformLink> for more details on how to set up and install the SDK. | ||
|
|
||
| </Alert> | ||
|
|
||
| The TanStack Router instrumentation uses your TanStack Router routes to create `pageload` and `navigation` transactions to ensure you collect meaningful performance data about the health of your page loads and associated requests. | ||
|
|
||
| ## Usage | ||
|
|
||
| To use the TanStack Router integration, pass the `Sentry.tanstackRouterBrowserTracingIntegration` inside your `integrations` option: | ||
|
|
||
| ```javascript | ||
| import * as Sentry from "@sentry/solid"; | ||
| import { createRouter } from "@tanstack/solid-router"; | ||
|
|
||
| const router = createRouter({ | ||
| // Your router options... | ||
| }); | ||
|
|
||
andreiborza marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| declare module '@tanstack/solid-router' { | ||
| interface Register { | ||
| router: typeof router; | ||
| } | ||
| } | ||
|
|
||
| Sentry.init({ | ||
| dsn: "___PUBLIC_DSN___", | ||
| integrations: [Sentry.tanstackRouterBrowserTracingIntegration(router)], | ||
andreiborza marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| // Setting a sample rate is required for sending performance data. | ||
| // We recommend adjusting this value in production, or using tracesSampler | ||
| // for finer control. | ||
| tracesSampleRate: 1.0, | ||
| }); | ||
| ``` | ||
|
|
||
| ## Next Steps: | ||
|
|
||
| - [Return to **Getting Started**](../../) | ||
| - [Return to the main integrations page](../) | ||
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.
Uh oh!
There was an error while loading. Please reload this page.