react-loader-advanced-next

Version 1.0.2

A simple loader overlaying your component during async events.

This is a simplified and updated version of react-loader-advanced to support more recent react versions keeping basic features intact. react-loader-advanced-next provides a component into which you can wrap an arbitrary React component.

Install

npm install react-loader-advanced-next --save

Compatibility

Compatible with React versions ^16.0.0, ^17.0.0 and ^18.0.0.

Usage

1. Include Loader

Node:

import Loader from 'react-loader-advanced-next';

2. Wrap your component inside the loader

<Loader show={true} message={'loading'}>
  <SomeComponent />
</Loader>

3. Style the loader using foregroundStyle and backgroundStyle

<Loader foregroundStyle={{color: 'white'}}
  backgroundStyle={{backgroundColor: 'black'}}>
...

You may optionally disable all default styling by setting property disableDefaultStyles to true.

4. Optionally if you wish, hack the loader using CSS styles knowing the class-hierarchy

<div class="Loader__background">
  <div class="Loader__foreground">
    <div class="Loader__message">
      Loading
    </div>
  </div>
</div>

See more thorough structure in ./src/react-loader-advanced.js.

Options (props)

show (bool) This is the only required prop. When true, loader overlay is displayed. When false, only actual content is displayed.

priority (int) The loader(s) with the highest priority will always be the only loader(s) showing. If loaders with lower priorities stop loading before the one with the highest priority, they will never be shown. Default priority is 0.

hideContentOnLoad (bool) Hide content underneath loader overlay when loading.

contentBlur (int = px) Blur the background on browsers that support CSS filter().

message (node = element|string) Set the displayed message on foreground while loading. Can be an arbitrary element like a spinner of your choice -- or just a simple string. Defaults to string "loading...".

messageStyle (obj) Extends the message element style.

foregroundStyle (obj) Set a style for the loader foreground. Extends default styles.

backgroundStyle (obj) Set a style for the loader background. Extends default styles.

contentStyle (obj) Extends the content wrapper element style.

disableDefaultStyles (bool) Disables default styles for background, foreground and message if set to true (not recommended).

FAQ

Can I use a spinner element?

Yes, you can define a spinner element in the message-prop.

const spinner = <span>any-spinner-you-want</span>;

<Loader message={spinner}>
...
</Loader>

License

ISC