react-resilient icon indicating copy to clipboard operation
react-resilient copied to clipboard

🛡 A component that resiliently renders components that might fail

react-resilient

Build Status npm version

A React component for resiliently render components that might fail. It wraps them around a React Fiber error boundary.

  • Tries to render your component
  • Renders <FallbackComponent /> after the maximum number of retries (props.maxRetries)

⚠️ DISCLAIMER: Experimental

This is experimental and unstable React API. It will be fully supported with [email protected] with first-level support componentDidCatch: https://github.com/facebook/react/pull/10200.


Demo

import React from 'react'
import Resilient from 'react-resilient'

const Broken = () => {
  throw new Error('Broken!')
}

const FallbackComponent = () => (
  <div>This is my fallback</div>
)

export default class Application extends React.Component {
  onError = (error) => {
    console.error('Error catched', error)
  }
  
  render () {
    return (
      <Resilient
        FallbackComponent={FallbackComponent}
        maxRetries={2}
        onError={this.onError}
      >
        <Broken />
      </Resilient>
    )
  }
}

API

<Resilient
  FallbackComponent={React.Component}
  maxRetries={number}
  onError={func}
>
  <YourComponent />
</Resilient>
props.FallbackComponent (optional, defaults to render null)

React component displayed after the maxRetries

props.maxRetries (optional, defaults to 0)

Number of retries before showing the FallbackComponent

props.onError (optional)

Callback for when errors are thrown