<p align="center"> <img alt="logo" title="react-preloading-screen" src="logo.svg" width="250"> </p> <p align="center"><b>react-preloading-screen</b></p> <p align="center">Minimal preloading component for React</p>
npm install react-preloading-screen
react-preloading-screen
Minimal preloading component for React
This is a React component that implements a preloading screen functionality in React. Demo can be found here
``bash`
npm install --save react-preloading-screen`
orbash`
yarn add react-preloading-screen
Wrap your app in a Preloader component and add a Placeholder component inside with the content of your preloading screen:
`jsx
import React from 'react';
import { Preloader, Placeholder } from 'react-preloading-screen';
class MyApp extends React.Component {
render() {
return (
Welcome to my app!
It's being preloaded!
Loading...
);
}
}
`
Preloader component supports the following props:
| Prop | Explanation |
| ------------- | ------------- |
|fadeDuration | Amount of time it takes for preloader to fade out (ms)|className
| | Class name passed to preloader divstyle
| | JSX Style object to override preloader styles. _Keep in mind: Opacity attribute is used for fade animation._|
This component uses requestAnimationFrame to check for document.readyState and removes overlay once it's complete.
For browsers that don't support requestAnimationFrame there's a polyfill provided that you can import:
`jsx``
import 'react-preloading-screen/raf-polyfill';