react-toolbox/components/snackbar
Robert Parker 68926f8289 Fix a few incorrect exports in typings and build with updated Babel 2016-06-07 15:41:51 -07:00
..
Snackbar.js Better PropType syntax and delete required className api 2016-06-03 23:44:33 +02:00
_config.scss Remove all `unquote` calls 2015-11-19 12:21:51 +01:00
index.d.ts Fix a few incorrect exports in typings and build with updated Babel 2016-06-07 15:41:51 -07:00
index.js Autoinject theme for Switch, Table and Snackbar 2016-05-30 06:59:44 +02:00
readme.md Autoinject theme for Switch, Table and Snackbar 2016-05-30 06:59:44 +02:00
theme.scss Plain SASS imports 🎨 2016-06-04 22:06:59 +02:00

readme.md

Snackbar

Snackbars provide lightweight feedback about an operation by showing a brief message at the bottom of the screen. Snackbars can contain an action.

import { Button, Snackbar } from 'react-toolbox';

class SnackbarTest extends React.Component {
  handleClick = () => {
    this.refs.snackbar.show();
  };

  handleSnackbarClick = () => {
    this.refs.snackbar.hide();
  };

  render () {
    return (
      <section>
        <Button label='Show Snackbar' raised onClick={this.handleClick} />
        <Snackbar
          action='Nice'
          icon='question_answer'
          label='A new developer started using React Toolbox'
          onClick={this.handleSnackbarClick}
          ref='snackbar'
          type='accept'
      />
      </section>
    );
  }
}

This component can be styled by context providing a theme with the key RTSnackbar through the theme provider.

Properties

Name Type Default Description
action String Label for the action component inside the Snackbar.
active Boolean false If true, the snackbar will be active.
className String '' Additional class name to provide custom styling.
icon String or Element String key for an icon or Element which will be displayed in left side of the snackbar.
label String Text to display in the content. Required.
onClick Function Callback function that will be called when the button action is clicked.
onTimeout Function Callback function when finish the set timeout.
timeout Number Amount of time in milliseconds after the Snackbar will be automatically hidden.
type String Indicates the action type. Can be accept, warning or cancel

Theme

Name Description
accept Added to the root element in case it's accept type.
active Added to the root element when its active.
button Used for the button inside the component.
cancel Added to the root element in case it's cancel type.
icon Used for the icon element.
label Used for the label element.
snackbar Used as the className for the root element of the component.
warning Added to the root element in case it's warning type.