react-toolbox/components/button/readme.md

# Button

A [button](https://material.google.com/components/buttons.html) clearly communicates what action will occur when the user touches it. It consists of text, an image, or both, designed in accordance with your app’s color theme.

<!-- example -->
```jsx
import {Button, IconButton} from 'react-toolbox/lib/button';

const GithubIcon = () => (
  <svg viewBox="0 0 284 277">
    <g><path d="M141.888675,0.0234927555 C63.5359948,0.0234927555 0,63.5477395 0,141.912168 C0,204.6023 40.6554239,257.788232 97.0321356,276.549924 C104.12328,277.86336 106.726656,273.471926 106.726656,269.724287 C106.726656,266.340838 106.595077,255.16371 106.533987,243.307542 C67.0604204,251.890693 58.7310279,226.56652 58.7310279,226.56652 C52.2766299,210.166193 42.9768456,205.805304 42.9768456,205.805304 C30.1032937,196.998939 43.9472374,197.17986 43.9472374,197.17986 C58.1953153,198.180797 65.6976425,211.801527 65.6976425,211.801527 C78.35268,233.493192 98.8906827,227.222064 106.987463,223.596605 C108.260955,214.426049 111.938106,208.166669 115.995895,204.623447 C84.4804813,201.035582 51.3508808,188.869264 51.3508808,134.501475 C51.3508808,119.01045 56.8936274,106.353063 65.9701981,96.4165325 C64.4969882,92.842765 59.6403297,78.411417 67.3447241,58.8673023 C67.3447241,58.8673023 79.2596322,55.0538738 106.374213,73.4114319 C117.692318,70.2676443 129.83044,68.6910512 141.888675,68.63701 C153.94691,68.6910512 166.09443,70.2676443 177.433682,73.4114319 C204.515368,55.0538738 216.413829,58.8673023 216.413829,58.8673023 C224.13702,78.411417 219.278012,92.842765 217.804802,96.4165325 C226.902519,106.353063 232.407672,119.01045 232.407672,134.501475 C232.407672,188.998493 199.214632,200.997988 167.619331,204.510665 C172.708602,208.913848 177.243363,217.54869 177.243363,230.786433 C177.243363,249.771339 177.078889,265.050898 177.078889,269.724287 C177.078889,273.500121 179.632923,277.92445 186.825101,276.531127 C243.171268,257.748288 283.775,204.581154 283.775,141.912168 C283.775,63.5477395 220.248404,0.0234927555 141.888675,0.0234927555" /></g>
  </svg>
);

const TestButtons = () => (
  <div>
    <Button href='http://github.com/javivelasco' target='_blank' raised>
      <GithubIcon /> Github
    </Button>
    <Button icon='bookmark' label='Bookmark' accent />
    <Button icon='bookmark' label='Bookmark' raised primary />
    <Button icon='inbox' label='Inbox' flat />
    <Button icon='add' floating />
    <Button icon='add' floating accent mini />
    <IconButton icon='favorite' accent />
    <IconButton icon={<GithubIcon />} accent />
    <IconButton primary><GithubIcon /></IconButton>
    <Button icon='add' label='Add this' flat primary />
    <Button icon='add' label='Add this' flat disabled />
  </div>
);
```

If you want to provide a theme via context, the component key is `RTButton`.

## Properties

| Name              | Type                  | Default     | Description|
|:-----|:-----|:-----|:-----|
| `accent`          | `Boolean`             | `false`     | Indicates if the button should have accent color.|
| `className`       | `String`              | `''`        | Set a class to style the Component.|
| `disabled`        | `Boolean`             | `false`     | If true, component will be disabled.|
| `flat`            | `Boolean`             | `false`     | If true, the button will have a flat look. |
| `floating`        | `Boolean`             | `false`     | If true, the button will have a floating look. |
| `href`            | `String`              |             | Creates a link for the button. |
| `icon`            | `String` or `Element` |             | Value of the icon (See Font Icon Component). |
| `inverse`         | `Boolean`             |             | If true, the neutral colors are inverted. Useful to put a button over a dark background. |
| `label`           | `String`              |             | The text string to use for the name of the button.|
| `mini`            | `Boolean`             | `false`     | To be used with floating button. If true, the button will be smaller.|
| `neutral`         | `Boolean`             | `true`      | Set it to `false` if you don't want the neutral styles to be included.|
| `onMouseEnter`    | `Function`            |             | Fires after the mouse enters the Component.|
| `onMouseLeave`    | `Function`            |             | Fires after the mouse leaves the Component.|
| `onMouseUp`       | `Function`            |             | Fires after the mouse is released from the Component.|
| `primary`         | `Boolean`             | `false`     | Indicates if the button should have primary color.|
| `raised`          | `Boolean`             | `false`     | If true, the button will have a raised look. |
| `ripple`          | `Boolean`             | `true`      | If true, component will have a ripple effect on click.|
| `theme`           | `Object`              |             | Theme object with classnames that will be used to style the component.|
| `type`            | `String`              | `button`    | Component root container type.|

By default it will have neutral colors and a flat aspect even though the `flat` property is `false` by default. Also, some properties exclude others, for example a button cannot be `flat` and `raised` at the same time.

The `Button` component also accept children so if you want to provide a custom component and text instead of a `label` and `icon` you can do it too. Just check the examples.

## Theme

| Name       | Description|
|:-----------|:-----------|
| `accent`   | Used for the root in case button is accent.|
| `button`   | Used for the root element in any button.|
| `flat`     | Used when the button is flat for the root element.|
| `floating` | Used when the button is floating for the root element.|
| `icon`     | For the icon inside a button.|
| `inverse`  | Used when colors are inverted.|
| `mini`     | Used for mini floating buttons.|
| `neutral`  | Used for neutral colored buttons.|
| `primary`  | Used for primary buttons when button is primary.|
| `raised`   | Used when the button is raised for root element.|
| `ripple`   | Used for the ripple element.|
| `toggle`   | Used for toggle buttons in the root element.|

## Icon Button

Icons are appropriate for toggle buttons that allow a single choice to be selected or deselected, such as adding or removing a star to an item. They are best located in app bars, toolbars, action buttons or toggles. We provide an `IconButton` component bundled with `Button` component. They share a similar API excluding onMouseLeave, onMouseUp and aspect properties.