react-notification

react-notification

Overview

This is a component designed to provide "snackbar" notification messages. I would suggest reading the usage guidelines for snackbars.

Warning: this is a major version zero release. The component is still under development and the API may change at any time. Please report issues and bugs on GitHub.

Getting Started

1. First, install the component via npm: npm install react-notification
2. Require the component: import Notification from 'react-notification';

Usage

<Notfication
  message={string}
  action={string}
  styles={object}
  onClick={func}
/>

Example

See here.

Props

Name	Type	Description	Required
message	string	The message for the notification	true
action	string	The name of the action, e.g., "close" or "undo"
styles	object		bool

*Setting this prop to false will disable all inline styles. This is useful if you aren't using React inline styles and would like to use CSS instead. See styles for more.

Methods

Method	Usage
show	Notification.show()	Opens the notification.
hide	Notification.hide()	Hides the notifciation.

Events

Event	Description
onClick	Callback function to run when the action is clicked

Styles

This component does use basic inline CSS to style the position and visibility of the notification. You have two options for adding additional styles:

1. Remove all inline styles and use only CSS.
2. Add additional inline styles via the style prop.

The DOM tree of the component for reference:

<div class="notficiation-bar">
  <div class="notfication-bar-wrapper" onClick={this.props.onClick}>
    <span class="notfication-bar-message">{this.props.message}</span>
    <span class="notification-bar-action">{this.props.action}</span>
  </div>
</div>

To use additional inline styles, return two objects. The bar object applies styles to the entire notification "snackbar" and the action object applies styles to the action message. Under the hood, this uses Object.assign to handle properly combining styles.

I would highly suggest using this method since the styles included in the component by default handle the visibility of the notification. If you remove these styles, the component won't actually show or hide itself.

getNotificationStyles() {

  var bar = {
    background: '#263238'
  };

  var action = {
    color: '#FFCCBC'
  };

  return { bar, action };

},

render() {
  return (
    <div>
      <Notification
        ref="notification"
        message={this.state.message}
        action={this.state.action}
        styles={this.getNotificationStyles()}
    </div>
  );
}

---

Built with care in New Orleans by Patrick Burtchaell.

Copyright 2015 Patrick Burtchaell. Licensed MIT.