reapop v3.0.0 Release Notes
Release Date: 2020-11-17 // over 4 years ago-
๐ฅ Breaking changes
Notification
- The
Notification.closeButton
attribute was renamedNotification.showDismissButton
- ๐ The
Notification.onRemove
was renamedNotification.onDismiss
- 0๏ธโฃ The
default
notification status was renamednone
. - The
STATUS
constant was renamedSTATUSES
- ๐ The position
top
andbottom
were removed.
Actions
- 0๏ธโฃ Notifications have no default properties by default
- ๐ง Default properties of notifications are not configurable via the reducer function anymore.
- ๐ The action
removeNotification
was renameddismissNotification
- The action
notify
now returns a redux action instead of the notification. - ๐ The action
removeNotification
was renameddismissNotification
- ๐ The action
removeNotifications
was renameddismissNotifications
- โก๏ธ Images specified in
Notification.image
won't be preloaded anymore. You need to preload them before creating/updating notifications. - ๐ HTTP status codes passed in
Notification.status
won't be converted anymore to statuses supported by the library. - all Redux actions are not exposed under the
actions
variable.
Components
- The component
NotificationsSystem
requiresnotifications
, anddismissNotification
properties. - ๐ The
filter
property of theNotificationsSystem
component was removed. Use instead thenotification
property. - ๐ Themes are not directly included in this package and build with inline CSS.
Migration guide
- Replace usage of
Notification.closeButton
withNotification.showDismissButton
๐ 2. Replace usage ofNotification.onRemove
withNotification.onDismiss
- Replace usage of
STATUS
withSTATUSES
0๏ธโฃ 4. Replace usage ofSTATUSES.default
withSTATUSES.none
ornull
. - Use the
top-center
orbottom-center
position if you used thetop
orbottom
position ๐ 6. Remove default properties passed to the notifications reducer and use thesetUpNotifications
helper to set up the default properties of your notifications. โก๏ธ 7. Updatenotify(...)
call to get the notification from thepayload
property of the action returned (previously the notification was returned) โก๏ธ 8. Replace usage ofaddNotification
andupdateNotification
actions withnotify
๐ 9. Replace usage ofremoveNotification
action withdismissNotification
๐ 10. Replace usage ofremoveNotifications
action withdismissNotifications
โก๏ธ 11. Make sure to preload images before creating/updating notifications containing images. - Replace statements where you set HTTP status code in
Notification.status
, or set acustomizeNotification
function with thesetUpNotifications
helper to reproduce this behavior - Replace usage of
reapop.actions
and directly importnotify
,dismissNotification
ordismissNotifications
fromreapop
- Add
notifications
anddismissNotification
property to theNotificationsSystem
component. Read the Integration & usage section to learn more about these new properties. ๐ 15. Removefilter
property of theNotificationsSystem
component. ๐ 16. Replace usage ofreapop-theme-*
package with builtin themes. More information in the Themes section of the documentation to get these themes. ๐ 17. If you have a custom theme, read the guide to create a custom theme with a CSS file to learn how to migrate your theme. If you prefer inline CSS, or CSS-in-JS, you might want to take a look at create a custom theme with inline CSS
๐ New
- Compatible with any application state managers. You can use it with mobx for example.
- TypeScript types exposed
- ๐ new API using React hooks and the React context API to use the library with React only
- ๐ New builtin transitions: fade, grow, slide
- Customizable components:
Transition
,NotificationIcon
, andNotification
- ๐ new API to create custom themes (inline CSS or CSS files)
- ๐ new helper function to:
- define default properties for notifications
- define a custom function used to modify notifications
- define the function used to generate notification IDs
๐ More information about these new things in the documentation
๐ Improvements
- Complete rewrite in TypeScript
- โ removed non-customizable behaviors
- โ removed
redux-thunk
dependency
If you have any questions or feedback, feel free to open an issue ๐
- The
Previous changes from v2.1.0
-
๐ Changelog
- โ Added support for Redux v7.x.x
- โ Added support for React >= v16.8.6
- โก๏ธ update all dependencies
- โ migrate tests suite to Jest and add 100% coverage