README.md

react-progress-button

Simple React component for a circular Progress Button.

Demo

Install

npm install react-progress-button --save

or

bower install react-progress-button --save

Example

Controlled usage:

var ProgressButton = require('react-progress-button');

var App = React.createClass({
  render() {
    return (
      <div>
        <ProgressButton ref='button' onClick={this.handleClick}>
          Go!
        </ProgressButton>
      </div>
    );
  },

  handleClick() {
    this.refs.button.loading();
    //make asynchronious call
    setTimeout(function() {
      this.refs.button.success();
    }.bind(this), 3000);
  }
});

API

Props

All props are optional. All props other than that will be passed to the top element.

classNamespace

Namespace for CSS classes, default is pb- i.e CSS classes are pb-button.

durationError

Duration (ms) before going back to normal state when an error occurs, default is 1200

durationSuccess

Duration (ms) before going back to normal state when an success occurs, default is 500

onClick

Function to call onClick on the button

onError

Function to call when going back to the normal state after an error

onSuccess

Function to call when going back to the normal state after a success

state

State of the button if you do not want to use the functions. Can be '', loading, success, error or disabled.

type

Type of the button (can be 'submit' for example).

form

Id of the form to submit (useful if the button is not directly inside the form).

shouldAllowClickOnLoading

Wether click event should bubble when in loading state

Methods

loading()

Put the button in the loading state.

disable()

Put the button in the disabled state.

notLoading(), enable()

Put the button in the normal state.

success([callback, dontGoBackToNormal])

Put the button in the success state. Call the callback or the onSuccess prop when going back to the normal state.

error([callback])

Put the button in the error state. Call the callback or the onSuccess prop when going back to the normal state.

Styles

Look at react-progress-button.css for an idea on how to style this component.

---

MIT Licensed