redux-toastr

##redux-toastr demo

redux-toastr is a React toastr message implemented with Redux, primary consists of three things: a reducer, toastr emitter and a React component.

The reducer listens to dispatched actions from the component to maintain the toastr state in Redux.

Implementation Guide

1. Installation

npm install --save redux-toastr

2. Add the redux-toastr css link to your app

NOTE: This can be change at anytime

<link href="http://diegoddox.github.io/redux-toastr/1.0.0/redux-toastr.min.css" rel="stylesheet" type="text/css">

3. The third thing you need to do is to add the redux-toastr reducer to Redux.

import {createStore, combineReducers} from 'redux'
import {reducer as toastrReducer} from 'redux-toastr'
const reducers = {
  // ... other reducers ...
  toastr: toastrReducer // <- Mounted at toastr.
}
const reducer = combineReducers(reducers)
const store = createStore(reducer)

NOTE: The default mount point for redux-toastr is toastr.

4. Add the redux-toastr React component to the root of your app

import {Provider}  from 'react-redux'
import ReduxToastr from 'redux-toastr'

<Provider store={store}>
  <div>
    ... other things like router ...
    // props are not required
    <ReduxToastr
      timeOut={4000}
      newestOnTop={false}
      position="top-left"/>
  </div>
</Provider>

default props: In case you don't pass the props

timeOut: 5000
newestOnTop: true
position: 'top-right'

positions: top-left top-right bottom-left and bottom-right

5. Add the redux-toastr toastr emitter

The toastr method use eventemitter3 to dispatch the actions

import React, {Component}  from 'react'
import {toastr} from 'redux-toastr'

export class YourComponent extends Component {
  render() {
    return (
      <div>
        <button
          onClick={() => toastr.success('The title', 'The message')}
          type="button">Toastr Success</button>
      </div>
    )
  }
}

Or you can bind the actions to your component if you prefer.

import {bindActionCreators} from 'redux'
import {actions as toastrActions} from 'redux-toastr'
// In your React component
constructor(props) {
  super(props);
  // Bind the redux-toastr actions to the component
  this.toastr = bindActionCreators(toastrActions, this.props.dispatch)
}

Toastr methods

Toastr: success info warning and error

Each of this method can take up to three arguments the title a message and options. In options you can specify the timeout icon onShowComplete and onHideComplete

import {toastr} from 'redux-toastr'

const toastrOptions = {
  timeOut: 3000,
  icon: 'my-icon-name',
  onShowComplete: () => console.log('SHOW: animation is done'),
  onHideComplete: () => console.log('HIDE: animation is done')
}

toastr.success('Title', 'Message', toastrOptions)
toastr.info('The message', toastrOptions)
toastr.warning('The title', 'The message')
toastr.error('The message')

Toastr: message

This one are in case you wanna show a large amount of information, unlike the other methods above this will not close automatically to close the user has to click on the close button.

In case you don't pass the title a default one will be provided.

const toastrMessageOptions = {
  onShowComplete: () => console.log('SHOW: animation is done'),
  onHideComplete: () => console.log('HIDE: animation is done')
};
toastr.message('Title', 'text <img src="myimage.jpg" />', toastrMessageOptions)

This method uses React dangerouslySetInnerHTML to display the message.

Toastr: confirm

The confirm method takes two arguments, the first is the message the second is a object where you can specify what will happen when the user clicks on ok or cancel button

NOTE: You can only have one at a time, right now if you have one confirm and you fire another it will be ignored.

const toastrConfirmOptions = {
  onOk: () => console.log('OK: clicked'),
  onCancel: () => console.log('CANCEL: clicked')
};
toastr.confirm('Are you sure about that!', toastrConfirmOptions)

You can change the ok and cancel text by passing the confirm props to the ReduxToastr component

const confirmOptions = {
  okText: 'confirm text',
  cancelText: 'cancel text'
};
<ReduxToastr confirm={confirmOptions}/>

Run a local demo

git clone https://github.com/diegoddox/redux-toastr.git
cd redux-toastr/demo/
npm install
npm start

open your browser at http://localhost:3000

TODO

create test.