Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mathieudutour/react-progress-button
:cyclone: Simple react.js component for an inline progress indicator
https://github.com/mathieudutour/react-progress-button
button component progress react
Last synced: 5 days ago
JSON representation
:cyclone: Simple react.js component for an inline progress indicator
- Host: GitHub
- URL: https://github.com/mathieudutour/react-progress-button
- Owner: mathieudutour
- License: mit
- Created: 2015-04-28T09:32:05.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-02-15T18:00:33.000Z (almost 3 years ago)
- Last Synced: 2024-12-01T04:04:43.537Z (12 days ago)
- Topics: button, component, progress, react
- Language: JavaScript
- Homepage: https://mathieudutour.github.io/react-progress-button
- Size: 341 KB
- Stars: 527
- Watchers: 15
- Forks: 65
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-components-all - react-progress-button - Simple react.js component for an inline progress indicator. (Uncategorized / Uncategorized)
- awesome-list - react-progress-button - Simple react.js component for an inline progress indicator. (Demos / Loader)
- awesome-react-components - react-progress-button - Simple react.js component for an inline progress indicator. (UI Components / Loader)
- awesome-react-components - react-progress-button - Simple react.js component for an inline progress indicator. (UI Components / Loader)
README
# react-progress-button
[](https://travis-ci.org/mathieudutour/react-progress-button)
[](https://www.npmjs.com/package/react-progress-button)
[](https://david-dm.org/mathieudutour/react-progress-button)
[](https://david-dm.org/mathieudutour/react-progress-button#info=devDependencies)
> Simple [React](http://facebook.github.io/react/index.html) component for a circular Progress Button.
### [Demo](https://mathieudutour.github.io/react-progress-button)
[](https://github.com/mathieudutour/react-progress-button/blob/master/example/index.html)
## Install
```bash
npm install react-progress-button --save
```
## Example
### Controlled usage:
```javascript
import ProgressButton from 'react-progress-button'
const App = React.createClass({
getInitialState () {
return {
buttonState: ''
}
},
render () {
return (
Go!
)
},
handleClick () {
this.setState({buttonState: 'loading'})
// make asynchronous call
setTimeout(() => {
this.setState({buttonState: 'success'})
}, 3000)
}
})
```
[Source](https://github.com/mathieudutour/react-progress-button/blob/master/example/index.html)
### Using Promises:
If the function passed in via the `onClick` prop return a Promise or if a promise
is passed as an argument of the `loading` method,
the component will automatically transition to its success or error
states based on the outcome of the Promise without the need for
external manipulation of state using a ref.
```javascript
import ProgressButton from 'react-progress-button'
const App = React.createClass({
render () {
return (
Go!
)
},
handleClick() {
return new Promise(function(resolve, reject) {
setTimeout(resolve, 3000)
})
}
});
```
[Source](https://github.com/mathieudutour/react-progress-button/blob/master/example/index-promises.html)
## API
### Props
All props are optional. All props other than that will be passed to the top element.
##### controlled
`true` if you control the button state (by providing `props.state` and `props.onClick`).`false` to let the button manage its state with Promises.
##### 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 when the button is clicked; if it returns a Promise
then the component will transition to the success/error state based on
the outcome of the Promise
##### 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
Whether 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 onError prop when going back to the normal state.
## Styles
Look at [react-progress-button.css](https://github.com/mathieudutour/react-progress-button/blob/master/react-progress-button.css) for an idea on how to style this component.
If you are using webpack, you'll need to have ```css-loader``` installed and include
```
{
test: /\.css$/,
loader: "style!css"
}
```
in your webpack config. In your jsx file you can then import the CSS with ```import "../node_modules/react-progress-button/react-progress-button.css";``` although the path depends on how deeply nested your jsx is. If you wish to theme it yourself, copy the CSS to a convenient location and point the import path at the copy, which is part of your repo, unlike the original in ```node_modules```.
## License
MIT