react-js-loading-progress-bar
v0.3.1
Published
React JS loading progress (bar and throbber) component that shows estimated time left (if several requests need to be made) and progress bar with percentage.
Downloads
321
Maintainers
Readme
React-loading-progress
Simple react JS Progress / Loading bar for multiple files
Description
React loading component with progress bar, percentage and time estimated for the operation to be completed.
How it looks:
It has two options the compact mode, that shows the progress bar, percentage and time left in a single line, and the full mode which outputs in different lines how much items has processed, the current percentage, the progress bar and the estimated time to complete the current operation.
You can now opt for two more options:
- Having a spinner instead of a progress bar
- Showing just the spinner and progress bar without any text
How to thank me? Just click on ⭐️ button :)
Installation
Install it from npm and include it in your React build process (using Webpack, Browserify, etc).
npm i react-js-loading-progress-bar
Usage
Import LoadingProgress
in your react component.
import LoadingProgress from 'react-js-loading-progress-bar';
Props available:
| Name | Type | Mandatory | Description
| ------------- |:-------------:| -----:|:-----|
| total | integer | Y |The total items you are going to process |
| active | boolean | Y | If you want to activate the loading component |
| current | integer | Y| The current item being processed |
| showCompact | present? |N | If you want the single line version (full by default) |
| title | String |N | Render custom title |
| hideProcessingRequest | present? |N | Render processing request in full mode |
| hideTimeRemaining | present? |N | Render time remaining in full mode |
| hideProgressBar | present? |N | Hide entirely the progress bar or spinner |
| hideQtyProcessed | present? |N | Hide the amount of items processed |
| useSpinner | present? |N | changes the progress bar with a spinner (throbber) |
| visualOnly | present? |N | Shows only the progress bar or throbber (depending on the mode you are using) |
For example:
<LoadingProgress
active={true}
total={this.state.total}
current={this.state.current}
showCompact
/>
To use the spinner instead of the progress bar you can use the useSpinner prop as follows:
<LoadingProgress
useSpinner
active={true}
total={this.state.total}
current={this.state.current}
/>
Changelog
v0.3.1
- Overall package size optimized
v0.3.0
- Dependencies updated
License
Licensed under the MIT License © jciccio