React Redux Loading Bar
A React component that provides Loading Bar (aka Progress Bar) for long running tasks. Works out of the box with redux-promise-middleware
and can be easily tweaked for other usage.
Consists of:
- React component — displays loading bar and simulates progress
- Redux reducer — manages loading bar's part of the store
- Redux middleware — dispatches
SHOW
/HIDE
for actions with promises
Examples
See Demo or its source code.
Installation
npm install --save react-redux-loading-bar
Usage
Mount the LoadingBar
component anywhere in your application:
import LoadingBar from 'react-redux-loading-bar' Component { return <header> <LoadingBar /> </header> }
Good news is that it doesn't include any positioning, so you can attach it to the top of any block or the whole page.
Install the reducer to the store:
import combineReducers from 'redux'import loadingBarReducer from 'react-redux-loading-bar' const reducer =
(Optional) Apply middleware to automatically show and hide loading bar on actions with promises:
import createStore applyMiddleware from 'redux'import loadingBarMiddleware from 'react-redux-loading-bar'import rootReducer from './reducers' const store =
Usage with custom suffixes or another Promise Middleware
You can configure promise type suffixes that are used in your project:
import createStore applyMiddleware from 'redux'import loadingBarMiddleware from 'react-redux-loading-bar'import rootReducer from './reducers' const store =
If you're not using redux-promise-middleware
or any other promise middleware, you can skip installing the loadingBarMiddleware()
and dispatch SHOW
/HIDE
actions manually. The other option is to write your own middleware that will be similar to the bundled one.
Usage without middleware
You can dispatch SHOW
/HIDE
actions wherever you want by importing the corresponding action creators:
import showLoading hideLoading from 'react-redux-loading-bar' // do long running stuff
You need to dispatch HIDE
as many times as SHOW
was dispatched to make the bar disappear. In other words, the loading bar is shown until all long running tasks complete.
redux-saga
Usage with Install the loadingBarMiddleware()
and mount Loading Bar in your application.
You can import and dispatch showLoading
and hideLoading
from your sagas.
import showLoading hideLoading from 'react-redux-loading-bar' { try const payload = // payload processing finally }
Usage with jQuery Ajax Requests
If you happen to use jQuery for Ajax requests, you can dispatch SHOW
/HIDE
actions on ajaxStart
/ajaxStop
global events:
See a demo or checkout the code.
Styling
You can apply custom styling right on the LoadingBar
component. For example you can change the color and height of the loading bar:
<LoadingBar = />
Alternatively, you can specify your own CSS class.
Please note that will disable default styling (which is color: red; height: 3px; position: absolute;
).
<LoadingBar ="loading" />
Don't forget to set height
, color
and position
for the loading
class in your CSS files.
Configure Progress Simulation
You can change updateTime (by default 200ms), maxProgress (by default 90%) and progressIncrease (by default 5%):
<LoadingBar = = = />
Tests
npm test
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
To see what has changed in recent versions of Loading Bar, see the CHANGELOG.
Licensed MIT. Copyright 2016-current Anton Mironov.