Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsdir/react-ladda
React wrapper for Ladda buttons.
https://github.com/jsdir/react-ladda
javascript ladda-buttons react reactjs
Last synced: 4 days ago
JSON representation
React wrapper for Ladda buttons.
- Host: GitHub
- URL: https://github.com/jsdir/react-ladda
- Owner: jsdir
- License: mit
- Created: 2014-05-21T07:32:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-10-03T08:23:41.000Z (over 5 years ago)
- Last Synced: 2024-04-24T16:58:57.888Z (9 months ago)
- Topics: javascript, ladda-buttons, react, reactjs
- Language: JavaScript
- Size: 78.1 KB
- Stars: 295
- Watchers: 6
- Forks: 48
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-components-all - react-ladda - React wrapper for Ladda buttons. (Uncategorized / Uncategorized)
- awesome-list - react-ladda - React wrapper for Ladda buttons. (Demos / Loader)
- awesome-react-components - react-ladda - React wrapper for Ladda buttons. (UI Components / Loader)
README
react-ladda
===========
[](https://travis-ci.org/jsdir/react-ladda)
[](https://david-dm.org/jsdir/react-ladda)
[](https://www.npmjs.org/package/react-ladda)
[](https://codeclimate.com/github/jsdir/react-ladda)
A React wrapper for [Ladda buttons](https://github.com/hakimel/Ladda). [Example](https://github.com/jsdir/react-ladda/blob/master/example/README.md)
## Installation
`react-ladda` can be installed directly through npm:
```sh
$ npm install --save react-ladda
```
## Usage
`LaddaButton` is a React component that renders a [Ladda button](https://github.com/hakimel/Ladda). You can change the button's loading state and progress using the `loading` and `progress` props.
```jsx
import React, { Component } from 'react';
import LaddaButton, { XL, SLIDE_UP } from 'react-ladda';
class App extends Component {
state = { loading: false };
toggle() {
this.setState({
loading: !this.state.loading,
progress: 0.5,
});
}
render() {
return (
Click Here!
);
}
};
ReactDOM.render(, document.body);
```
Although this package doesn't include the styles for the Ladda buttons, there are many different ways to include them. The easiest way is to add the following tag to your document:
```html
```
## Props
All of the native [Ladda button options](https://github.com/hakimel/Ladda#html) are supported through props:
Prop | Type | Description
-------------------- | --------- | -----------
`loading` | `boolean` | Displays the button's loading indicator
`progress` | `number` | Number from 0.0 to 1.0
`data-color` | `string` | Color applied to the button (`{green,red,blue,purple,mint}`)
`data-size` | `string` | A [button size](#sizes)
`data-style` | `string` | A [button style](#styles)
`data-spinner-size` | `number` | Number representing the size of the spinner in pixels
`data-spinner-color` | `string` | Color applied to the spinner (eg. `#eee`)
`data-spinner-lines` | `number` | Number of spokes in the spinner
## Sizes and Styles
Ladda comes with a variety of different [sizes and styles](http://lab.hakim.se/ladda/) that you can use. Button sizes and styles can be directly imported from `react-ladda`:
```js
import LaddaButton, { XS, EXPAND_LEFT } from 'react-ladda'
```
### Sizes
- `XS`
- `S`
- `L`
- `XL`
### Styles
- `CONTRACT`
- `CONTRACT_OVERLAY`
- `EXPAND_LEFT`
- `EXPAND_RIGHT`
- `EXPAND_UP`
- `EXPAND_DOWN`
- `SLIDE_LEFT`
- `SLIDE_RIGHT`
- `SLIDE_UP`
- `SLIDE_DOWN`
- `ZOOM_IN`
- `ZOOM_OUT`
## Development
After cloning and running `npm install`, you can use the following `npm` commands for easier development:
Command | Description
--------------- | -----------
`npm test` | Runs the test suite
`npm run watch` | Runs the test suite and reruns when any source or test file changes
`npm run lint` | Lints both the source and test files
`npm run build` | Compiles the source into ES5 and outputs the results into `dist`
_Contributions are more than welcome!_