ErrorBoundary component in Remix

Introduction

An ErrorBoundary component helps catch errors in parts of your app so the whole app doesn't crash. It shows a friendly message instead.

When you want to show a custom error message if a part of your app fails.

To prevent the entire app from breaking due to one component's error.

When you want to log errors and still keep the app running smoothly.

To improve user experience by handling unexpected problems gracefully.

Syntax

Remix

export function ErrorBoundary({ error }) {
  return (
    <div role="alert">
      <h1>Something went wrong</h1>
      <p>{error.message}</p>
    </div>
  );
}

The ErrorBoundary component receives an error prop automatically from Remix.

Use role="alert" for accessibility to notify screen readers about the error.

Examples

A simple error message display.

Remix

export function ErrorBoundary({ error }) {
  return <p>Error: {error.message}</p>;
}

Shows a styled error message with a heading and the error details.

Remix

export function ErrorBoundary({ error }) {
  return (
    <div role="alert" style={{ color: 'red' }}>
      <h2>Oops! An error happened.</h2>
      <pre>{error.message}</pre>
    </div>
  );
}

Sample Program

This example shows a component that throws an error in its loader. The ErrorBoundary catches it and displays a friendly message with the error text.

Remix

import { useLoaderData } from "@remix-run/react";

export function loader() {
  throw new Error("Data failed to load");
}

export default function MyComponent() {
  const data = useLoaderData();
  return <div>Data: {data}</div>;
}

export function ErrorBoundary({ error }) {
  return (
    <div role="alert" style={{ padding: '1rem', backgroundColor: '#fee', color: '#900' }}>
      <h1>Oops! Something went wrong.</h1>
      <p>{error.message}</p>
    </div>
  );
}

Important Notes

ErrorBoundary only catches errors in the component tree below it, not errors in event handlers.

Always provide a clear and helpful message to users when an error happens.

Summary

ErrorBoundary components catch errors to prevent app crashes.

They receive an error prop with error details.

Use them to show friendly messages and improve user experience.

Practice

1. What is the main purpose of an ErrorBoundary component in Remix?

easy

A. To fetch data from APIs before rendering components

B. To catch JavaScript errors in child components and display a fallback UI

C. To style components with CSS-in-JS

D. To manage user authentication state

Solution

1. Step 1: Understand ErrorBoundary role

   ErrorBoundary components catch errors thrown in their child components during rendering or lifecycle.

2. Step 2: Identify main purpose

   They prevent the entire app from crashing by showing a fallback UI instead of the broken component.

3. Final Answer:

   To catch JavaScript errors in child components and display a fallback UI -> Option B

4. Quick Check:

   ErrorBoundary catches errors = A [OK]

Hint: ErrorBoundary handles errors, not data or styles [OK]

Common Mistakes:

• Confusing ErrorBoundary with data fetching
• Thinking it manages styles or authentication
• Assuming it fixes errors automatically

2. Which of the following is the correct way to define an ErrorBoundary component in Remix?

easy

A. export function ErrorBoundary({ error }) { return {error.message}; }

B. export function ErrorBoundary() { return No error; }

C. export function ErrorBoundary({ data }) { return {data}; }

D. export function ErrorBoundary({ props }) { return {props.error}; }

Solution

1. Step 1: Check parameter usage

   ErrorBoundary receives an error prop with error details, so the parameter must be { error }.

2. Step 2: Verify returned JSX

   The component should display error.message to show the error text.

3. Final Answer:

   export function ErrorBoundary({ error }) { return <div>{error.message}</div>; } -> Option A

4. Quick Check:

   Use { error } prop and show error.message [OK]

Hint: ErrorBoundary gets error prop, not data or props object [OK]

Common Mistakes:

• Using wrong parameter name like data or props
• Not accessing error.message correctly
• Returning static text instead of error info

3. Given this ErrorBoundary component, what will be rendered if an error with message "Failed to load" occurs?

export function ErrorBoundary({ error }) {
  return (
    <div role="alert">
      <h2>Oops!</h2>
      <p>{error.message}</p>
    </div>
  );
}

medium

A. Oops!No error

B. ErrorUnknown error

C. Oops!Failed to load

D. Nothing renders because error is not handled

Solution

1. Step 1: Identify error message usage

   The component renders {error.message} inside a paragraph, so the actual error message will appear.

2. Step 2: Check rendered structure

   The output includes a div with role alert, an h2 with "Oops!", and a paragraph with the error message.

3. Final Answer:

   <div role="alert"><h2>Oops!</h2><p>Failed to load</p></div> -> Option C

4. Quick Check:

   Error message shown inside alert div = A [OK]

Hint: ErrorBoundary shows error.message inside fallback UI [OK]

Common Mistakes:

• Ignoring error.message and showing static text
• Missing role="alert" for accessibility
• Assuming no output if error occurs

4. What is wrong with this ErrorBoundary component code?

export function ErrorBoundary(error) {
  return <div>Error: {error.message}</div>;
}

medium

A. The error parameter should be destructured as { error }, but here it is a plain parameter

B. The error parameter should be destructured as { error }

C. The error parameter should be destructured as { error } but it is not

D. The component must return null on error

Solution

1. Step 1: Check parameter syntax

   ErrorBoundary receives props as an object, so the parameter should be destructured like { error }, not a plain variable.

2. Step 2: Identify correct destructuring

   Using error directly means it is the whole props object, so error.message will be undefined or cause error.

3. Final Answer:

   The error parameter should be destructured as { error }, but here it is a plain parameter -> Option A

4. Quick Check:

   Destructure props as { error } in ErrorBoundary [OK]

Hint: Destructure error prop: use ({ error }) not (error) [OK]

Common Mistakes:

• Using plain parameter instead of destructuring
• Returning null instead of fallback UI
• Confusing error prop with other props

5. You want to create an ErrorBoundary that shows a custom message for network errors and a generic message for others. Which code correctly implements this behavior?

export function ErrorBoundary({ error }) {
  if (error.message.includes('Network')) {
    return <div>Network error occurred. Please try again.</div>;
  }
  return <div>Something went wrong.</div>;
}

hard

A. The error prop should be named props, not error

B. This code will crash if error.message is undefined

C. The if condition should check error.type, not error.message

D. This code correctly shows a custom message for network errors and generic for others

Solution

1. Step 1: Analyze error message check

   The code checks if error.message contains 'Network' to show a specific message.

2. Step 2: Verify fallback message

   If the error is not a network error, it shows a generic fallback message, which is correct behavior.

3. Final Answer:

   This code correctly shows a custom message for network errors and generic for others -> Option D

4. Quick Check:

   Conditional error messages based on error.message = C [OK]

Hint: Check error.message content to customize fallback UI [OK]

Common Mistakes:

• Assuming error.message can be undefined without check
• Using wrong prop name instead of error
• Checking wrong error property like error.type