npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rinshad-react-guard

v1.0.10

Published

A robust React error boundary solution developed by [rinshad.com](https://rinshad.com) to elegantly handle runtime errors in React applications. Instead of showing the dreaded white screen of death, this library captures errors and displays a user-friendl

Downloads

374

Readme

rinshad-react-guard

A robust React error boundary solution developed by rinshad.com to elegantly handle runtime errors in React applications. Instead of showing the dreaded white screen of death, this library captures errors and displays a user-friendly error page while storing error details in session storage.

Features

  • 🛡️ Prevents white screen crashes in React applications
  • 🎯 Custom error page with clean UI
  • 💾 Stores error messages in session storage
  • 🔍 Configurable error filtering
  • ⚡ Compatible with Vite and React (jsx/tsx)
  • 🔄 Handles both sync and async errors
  • 🎨 Customizable styling

Installation

npm install rinshad-react-guard

or

yarn add rinshad-react-guard

Demo

Error Boundary Demo

Try it live: Demo Project

Usage

Basic Setup

Wrap your app's root component with the ErrorBoundary component:

import ErrorBoundary from 'rinshad-react-guard';

function App() {
  return (
    <ErrorBoundary>
      <YourApp />
    </ErrorBoundary>
  );
}

Advanced Usage with Excluded Keywords

You can exclude certain errors from being caught by providing keywords:

import ErrorBoundary from 'rinshad-react-guard';

function App() {
  const excludedKeywords = ['ChunkLoadError', 'NetworkError'];
  
  return (
    <ErrorBoundary excludedKeywords={excludedKeywords}>
      <YourApp />
    </ErrorBoundary>
  );
}

Accessing Error Messages

Error messages are automatically stored in session storage with the key rinshadReactGuardAlert. You can access them programmatically:

const errorMessage = sessionStorage.getItem('rinshadReactGuardAlert');

API Reference

ErrorBoundary Props

| Prop | Type | Default | Description | |------|------|---------|-------------| | children | ReactNode | required | The components to be wrapped by the error boundary | | excludedKeywords | string[] | [] | Array of keywords to exclude from error catching |

How It Works

  1. The ErrorBoundary component wraps your application and listens for any JavaScript errors
  2. When an error occurs:
    • The error message is captured and stored in session storage
    • The user is shown a friendly error page instead of a white screen
    • The error details are logged to the console for debugging
  3. Users can return to the home page using the provided button
  4. Browser back button navigation is handled to prevent users from seeing the error state again

Best Practices

  1. Place the ErrorBoundary at the root level of your application
  2. Use multiple ErrorBoundary components for different sections if needed
  3. Configure excluded keywords based on your application's needs
  4. Implement proper error logging and monitoring

Example

// main.jsx or App.jsx
import React from 'react';
import ErrorBoundary from 'rinshad-react-guard';
import YourApp from './YourApp';

function App() {
  const excludedKeywords = ['ChunkLoadError'];

  return (
    <ErrorBoundary excludedKeywords={excludedKeywords}>
      <YourApp />
    </ErrorBoundary>
  );
}

export default App;

Browser Support

  • Chrome (latest)
  • Firefox (latest)
  • Safari (latest)
  • Edge (latest)

License

MIT License

Support

For support, email [email protected]


Made with ❤️ by rinshad.com