amaryllis-notifications

React notification system with redux

Installation

npm install --save amaryllis-notifications

Dependecies

In order to use the redux actions, this package assumes that you have react-redux and redux-thunk installed and configured.

Documentation

0. Include css file in your app

Either by copying the css to your html or requiring it directly from node_modules using SASS or other preprocessor

using sass:

@import '../node_modules/amaryllis-notifications/dist/amaryllis-notifications.min.css';

1. Add Notifications Reducer to redux

import { createStore, applyMiddleware } from "redux";
import thunk from 'redux-thunk';
import { combineReducers } from 'redux';
import { NotificationsReducers as notifications } from 'amaryllis-notifications';

const rootReducer = combineReducers({
    notifications
});

const store = createStore(
    rootReducer,
    applyMiddleware(
        thunk));

export default store;

2. Add Notifications Component to your react application

Preferabble high in the DOM tree

import { Notifications, NotificationsActions, AMARYLLIS_TYPES, setDefaults} from 'amaryllis-notifications';

ReactDOM.render(
    <Provider store={Store}>
        <React.Fragment>
            <Notifications animation={"fade"}/>
            <Page />
        </React.Fragment>
    </Provider>,
	document.getElementById('example')
);

3. Use it in your app

const mapActionsToProps = {
    notify: NotificationsActions.notify
}

class Page extends React.Component {
    componentDidMount(){
        const { ...props } = this.props;
        setDefaults({timeout:0, styles:{}})
        props.notify("Title", "Message", {icon:"fa-dove", type:AMARYLLIS_TYPES.WARNING });
    
    }

    render(){
        return (<div></div>);
    }
}

Page = connect(null, mapActionsToProps)(Page)

4. Options

Options:

• timeout: The message will be dissmissed by default after 3 seconds, if you want it to be static until clicked, use 0, or set other timeout in ms

• type: The type of the message, available types are:

  • AMARYLLIS_TYPES.INFO
  • AMARYLLIS_TYPES.WARNING
  • AMARYLLIS_TYPES.SUCCESS
  • AMARYLLIS_TYPES.ERROR
  • AMARYLLIS_TYPES.HAPPY

  all other type willbe considered custom and look for customization, either by providing a css class or by addidng style object

• icon:

Animations: Message Types: Customization:

changing the default options

License

MIT