Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 2.61 KB

README.md

File metadata and controls

70 lines (48 loc) · 2.61 KB
Raw

hide-cra-error-overlay

Hide the Create React App error overlay behind a "Show Errors" button.

Installation

  npm install --save-dev hide-cra-error-overlay

Usage

In src/index.js, add the following:

if (process.env.NODE_ENV !== "production") {
  import("hide-cra-error-overlay").then(({ initHideOverlay }) =>
    initHideOverlay()
  );
}

That's it! the overlay will be replaced with the "Show Errors" button from now on.

Screenshots

Before (overlay):

After (button):

Why would someone use this?

During development, Create React App displays a full-screen error overlay for webpack compilation errors. The config for this is only accessible by ejecting- but particularly with Typescript errors, sometimes you may just want to temporarily ignore these to be able to test your app. When imported, this module hides the error overlay whenever it is triggered. It also adds a small "Show Errors" button to the lower right of the screen- click this to toggle the original error overlay on/off at any time.

In Production

Assuming that you follow the recommended usage above, there is no impact on production bundle size from using this. CRA's webpack config will strip out the contents of the NODE_ENV !== "production" conditional for the production build, and a dynamic import is used to prevent inclusion in the bundle unless that condition is met.

Config

To adjust the behavior, you can optionally pass a configuration object to initHideOverlay with any of the options in the example below. Values shown below are the defaults.

if (process.env.NODE_ENV !== "production") {
  import("hide-cra-error-overlay").then(({ initHideOverlay }) =>
    initHideOverlay({
      //HTML id(s) of the 'overlay' element to hide when it appears
      //(assumed to be a direct child of document.body).
      //can be a single string id, or an array of multiple ids to check for.
      overlayId: [
        "webpack-dev-server-client-overlay",
        "webpack-dev-server-client-overlay-div",
      ],

      //whether or not to add the "Show Errors" button
      withRestoreButton: true,

      //disable hiding, restore original CRA behavior
      disable: false,
    })
  );
}

initHideOverlay can be invoked multiple times for different config at different points in execution (e.g., when a certain component is mounted).