github LouisBarranqueiro/reapop v1.0.0
1.0.0

latest releases: v4.2.2, v4.2.1, v4.2.0...
7 years ago

Breaking changes

Notification with buttons

Before, notifications with buttons were not dismissed after dismissAfter value even if dismissAfter was defined. It's not the case anymore, now, if a notification have a dismissAfter value and buttons, then the notification will disappear after dismissAfter value.

Guidelines to upgrade from v0.x.x to v1.0.0

Make sure all notifications that require a user action, have a dismissAfter value set to 0.

Default values for notifications

Now, default value for notification are configurable on the redux part, It allow you to easily use your own react components to display notifications (less logic on view part).

Guidelines to upgrade from v0.x.x to v1.0.0

If you didn't customize the default value for notifications you have add () after notificationsReducer because it now a function wrapper. See example below

Example:

import {createStore, compose, applyMiddleware} from 'redux';
import thunk from 'redux-thunk';
import {reducer as notificationsReducer} from 'reapop';

// store
const createStoreWithMiddleware = compose(
  applyMiddleware(thunk)
)(createStore);
const store = createStoreWithMiddleware(combineReducers({
    // reducer must be mounted as `notifications` !
    notifications: notificationsReducer() // notice the `()` now
    // your reducers here
  }), {});

If you customized default value for notifications, you have to:

  • Remove defaultValues props of NotificationSystem component, it is useless now.
  • Define these values where you imported notifications reducer and combine your reducers. See example below

Example:

import {createStore, compose, applyMiddleware} from 'redux';
import thunk from 'redux-thunk';
import {reducer as notificationsReducer} from 'reapop';

// default value for notifications
const defaultNotification = {
        status: 'info',
        position: 'tr',
        dismissible: true,
        dismissAfter: 2000,
        allowHTML: true,
        closeButton: true
      };

// store
const createStoreWithMiddleware = compose(
  applyMiddleware(thunk)
)(createStore);
const store = createStoreWithMiddleware(combineReducers({
    // reducer must be mounted as `notifications` !
    notifications: notificationsReducer(defaultNotification) // pass config here
    // your reducers here
  }), {});

New

  • removeNotifications action creator to remove all notifications. (#21)

Enhancements

  • New way to define default value for notifications to easily write your own react components to display notifications (less logic on view part). (#23)
  • Allow string as notification id (#24)
  • Update dependencies and version supported (#26)

Changelog

  • Add action creator to remove all notifications (#21)
  • Notification with buttons are now dismissible (#22)
  • Default settings on redux part (#23)
  • Allow string as notification id (#24)
  • Add react-css-transition-group as npm dependency (#25)
  • Update dependencies and version supported (#26)
  • Improve code quality (#27)

Don't miss a new reapop release

NewReleases is sending notifications on new releases.