Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 0 additions & 17 deletions packages/remix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,23 +90,6 @@ function App() {
export default withSentry(App);
```

You can disable or configure `ErrorBoundary` using a second parameter to `withSentry`.

```ts

withSentry(App, {
wrapWithErrorBoundary: false
});

// or

withSentry(App, {
errorBoundaryOptions: {
fallback: <p>An error has occurred</p>
}
});
```

To set context information or send manual events, use the exported functions of `@sentry/remix`.

```ts
Expand Down
8 changes: 5 additions & 3 deletions packages/remix/src/client/performance.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,14 @@ function startNavigationSpan(matches: RouteMatch<string>[]): void {
}

/**
* Wraps a remix `root` (see: https://remix.run/docs/en/v1/guides/migrating-react-router-app#creating-the-root-route)
* Wraps a remix `root` (see: https://remix.run/docs/en/main/start/quickstart#the-root-route)
* To enable pageload/navigation tracing on every route.
* Also wraps the application with `ErrorBoundary`.
*
* @param OrigApp The Remix root to wrap
* @param options The options for ErrorBoundary wrapper.
* @param useEffect The `useEffect` hook from `react`
* @param useLocation The `useLocation` hook from `@remix-run/react`
* @param useMatches The `useMatches` hook from `@remix-run/react`
* @param instrumentNavigation Whether to instrument navigation spans. Defaults to `true`.
*/
export function withSentry<P extends Record<string, unknown>, R extends React.ComponentType<P>>(
OrigApp: R,
Expand Down
Loading