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

react-safe-lazy

v0.1.0

Published

Safely use `React.lazy` with retry and reload strategies.

Downloads

3,279

Readme

react-safe-lazy

GitHub branch check runs codecov NPM version npm bundle size

A simple and safe way to use React.lazy when you are iterating React app fast. It will catch the error and automatically retry to import or refresh the page when a lazy React component fails to load.

Installation

npm i react-safe-lazy
  • Direct dependencies: 0.
  • Peer dependency: react@^18.0.0.

Usage

Just replace React.lazy with safeLazy and you are good to go.

import { safeLazy } from 'react-safe-lazy';

const MyComponent = safeLazy(() => import('./MyComponent'));

Documentation

The default safeLazy function

The default safeLazy function have the following strategy:

  • It will not retry calling the import function if it fails.
  • It will reload the page (window.location.reload) once if the lazy component fails to load. If the lazy component fails to load again, the error will be thrown.

Customizing the safeLazy function

You can create a custom safeLazy function by calling the createSafeLazy function with a configuration object.

import { createSafeLazy } from 'react-safe-lazy';

const safeLazy = createSafeLazy({ /* configuration */ });
const MyComponent = safeLazy(() => import('./MyComponent'));

The configuration object has the following properties:

type SafeLazyConfigInit = {
  /**
   * The configuration for force-reloading components that fail to load. If set to `false`, the
   * component will not be force-reloaded.
   *
   * @default
   * { maxRetries: 1, storageKey: 'forceReloadedImportFunctions' }
   */
  forceReload?: false | Partial<ForceReloadConfig>;
  /**
   * The number of times to retry importing the component if it fails to load.
   *
   * @default 0
   */
  importRetries?: number;
};

type ForceReloadConfig = {
  /**
   * The maximum number of times to reload the page (using `window.location.reload`) if the
   * component fails to load.
   */
  maxRetries: number;
  /**
   * The key used to store the force-reloaded function information in the session storage.
   *
   * @default 'forceReloadedImportFunctions'
   */
  storageKey?: string;
};

For example, to retry importing the component 3 times and reload the page up to 2 times if the component fails to load, you can use the following configuration:

const safeLazy = createSafeLazy({
  importRetries: 3,
  forceReload: {
    maxRetries: 2,
  },
});

License

MIT