Skip to content

Commit bae158f

Browse files
committed
fix(remix): Remove mentions of deprecated ErrorBoundary wrapper (#15930)
Since we dropped support for Remix v1, we're not wrapping Remix `root`s with `ErrorBoundary` anymore. Fixes https://github.com/orgs/getsentry/projects/31/views/19?pane=issue&itemId=103941554&issue=getsentry%7Csentry-javascript%7C15883 Docs PR: getsentry/sentry-docs#13170
1 parent 180e9d8 commit bae158f

File tree

2 files changed

+5
-20
lines changed

2 files changed

+5
-20
lines changed

packages/remix/README.md

-17
Original file line numberDiff line numberDiff line change
@@ -90,23 +90,6 @@ function App() {
9090
export default withSentry(App);
9191
```
9292

93-
You can disable or configure `ErrorBoundary` using a second parameter to `withSentry`.
94-
95-
```ts
96-
97-
withSentry(App, {
98-
wrapWithErrorBoundary: false
99-
});
100-
101-
// or
102-
103-
withSentry(App, {
104-
errorBoundaryOptions: {
105-
fallback: <p>An error has occurred</p>
106-
}
107-
});
108-
```
109-
11093
To set context information or send manual events, use the exported functions of `@sentry/remix`.
11194

11295
```ts

packages/remix/src/client/performance.tsx

+5-3
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,14 @@ function startNavigationSpan(matches: RouteMatch<string>[]): void {
9696
}
9797

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

0 commit comments

Comments
 (0)