react-toolbox/components/button
Javi Velasco c09f7c4ad7 Round ripple for floating buttons 2015-11-15 21:42:32 +01:00
..
__test__ FIXED eslint 2015-11-04 21:41:08 +02:00
_config.scss Better variables and props for button 2015-10-21 00:48:24 +02:00
index.jsx Merge branch 'master' into pure-components 2015-11-11 20:04:10 +01:00
readme.md Proper import path for documentation files 2015-11-10 11:07:43 +01:00
style.scss Round ripple for floating buttons 2015-11-15 21:42:32 +01:00

readme.md

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.

import Button from 'react-toolbox/lib/button';

const TestButtons = () => (
  <div>
    <Button label="Flat button" />
    <Button kind="raised" label="Raised" />
    <Button kind="raised" label="Raised accent" accent icon="favorite" />
    <Button className="primary" kind="floating" icon="add" />
    <Button mini kind="floating" icon="add" accent />
  </div>
);

Properties

Name Type Default Description
accent Bool 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.
icon String Value of the icon (See icon component).
kind String flat Type of the component, overwrite this property if you need set a different stylesheet.
label String The text string to use for the name of the button.
loading Boolean false If true, component will be disabled and show a loading animation.
mini Boolean false To be used with floating button. If true the button will be smaller.
onClick Function Callback called when the button is clicked.
primary false If true, component will have the primary color.
ripple Boolean true If true, component will have a ripple effect on click.