react-toolbox/components/button/readme.md

34 lines
1.6 KiB
Markdown
Raw Normal View History

2015-07-02 14:17:35 +03:00
# Button
A button clearly communicates what action will occur when the user touches it. It consists of text, an image, or both, designed in accordance with your apps color theme.
2015-07-02 14:17:35 +03:00
```
var Button = require('react-toolbox/components/button');
<Button className="accent" label="Flat button" />
<Button className="primary" type="raised" label="Raised" />
<Button className="accent" type="raised" label="Raised" icon="assignment_turned_in" />
<Button className="primary" type="floating" icon="add" />
<Button className="accent mini" type="floating" icon="add" />
2015-07-02 14:17:35 +03:00
```
## Properties
| Name | Type | Default | Description|
|:- |:-: | :- |:-|
| **className** | String | | Set the class-styles of the Component.|
2015-07-07 12:30:22 +03:00
| **disabled** | Boolean | | If true, component will be disabled.|
| **icon** | String | | Default value using JSON data.|
| **label** | String | | The text string to use for the floating label element.|
2015-07-07 12:30:22 +03:00
| **loading** | Boolean | | If true, component will be disabled and show a loading animation.|
| **ripple** | Boolean | | If true, component will have a ripple effect on click.|
| **type** | String | "flat" | Type of the component, overwrite this property if you need set a different stylesheet.|
2015-07-02 14:17:35 +03:00
## Methods
#### loading
If true, component will be disabled and show a loading animation.
```
input_instance.loading(true);
```