react-progress-hud

React Progress HUD

React Progress HUD is a React port of the popular SVProgressHUD. It is a clean and easy-to-use HUD meant to display the progress of an ongoing task.

Are you using React Native? Check out React Native Progress HUD.

Install

npm i --save react-progress-hud

Usage

Using the HUD in your app will usually look like this:

import React, { Component } from "react";
import { ProgressHUD, Wrapper } from "react-progress-hud";

class YourComponent extends Component {
  render() {
    return (
      <div>
        <button onClick={this.props.showProgressHUD>Show Progress HUD</button>
        <ProgressHUD
          isVisible={this.props.isVisible}
          clickHandler={this.props.dismissProgressHUD}
          overlayColor="rgba(0, 0, 0, 0.11)"
        />
      </div>
    );
  }
}

export default Wrapper(App);

Showing the HUD

You can display the HUD by calling:

  this.props.showProgressHUD();

Dismissing the HUD

It can be dismissed by calling:

  this.props.dismissProgressHUD();

Props

The following props can be used to modify the HUD's style and/or behaviour:

Prop	Type	Opt/Required	Default	Note
isVisible	Boolean	Required	N/A	Displays the HUD when set to true.
clickHandler	Function	Optional	() => {}	Sets a clickHandler on the ProgressHUD.
overlayColor	String	Optional	rgb(0, 0, 0)	Sets the color of the overlay.
overlayOpacity	String	Optional	0.5	Sets the opacity of the overlay.
color	String	Optional	#000	Sets the color of the spinner.

License

Copyright (c) 2015, Naoufal Kadhom

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.