Package Exports

react-delay-fallback

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-delay-fallback) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-library-boilerplate

React component to delay children rendering and show a fallback component while waiting

Installation

npm i react-delay-fallback

Compatibility

Compatible with React >=16.8.0
Compatible with Node >=8.0.0\

Feature

Extremely small: it uses react hooks and will weighs less than 1kb in your final bundle
Safe unmounting: it clears timers and listeners at unmounting

Other features

Runtime type checking with prop-types and static with typescript declaration files
Exaustive doc comments
Tree shakable: exported with ESM modules
Tested with available coverage report

API

Index

Delay

React component to delay children rendering

import { Delay } from 'react-delay-fallback

Prop	Type	Default	Usage
`timeout`	number	`0`	Time in milliseconds for rendering
`fallback`	JSX.Element	`undefined`	Component to render instead of children while waiting
`onRender`	Function	`undefined`	Function to trigger on render

Usage examples

import { Delay } from 'react-delay-fallback;

function App() {
    const handleOnRender = () => window.alert('Callback invoked at rendering');

    return (
        <Delay
        timeout={5000}
        fallback={<span>Wait a moment...</span>}
        onRender={handleOnRender}>
            <h1>This</h1>
            <p>Will appear after 5 seconds</p>
        </Delay>
    );
}

Dependencies

No dependencies

Peer dependencies

React: ^16.8.0
ReactDOM: ^15.6.2

License

MIT