Chore/action exports (#41)

* Add .vscode to gitignore * Add test for action exports * Add action imports to example * Add action import examples to readme
gor181 · Jul 18, 2017 · f2722b6 · f2722b6
1 parent 1103df6
commit f2722b6
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,4 @@ example/dist
 *.sublime-*
 .idea/
 *.DS_Store
+.vscode
diff --git a/README.md b/README.md
@@ -103,7 +103,7 @@ Dispatch notification actions from any other component:
 import React, {PropTypes} from 'react';
 import ReactDOM from 'react-dom';
 
-import Notifications from 'react-notification-system-redux';
+import Notifications, { success } from 'react-notification-system-redux';
 
 const notificationOpts = {
   // uid: 'once-please', // you can specify your own uid if required
@@ -127,7 +127,7 @@ class OtherComponent extends React.Component {
 
   handleClick() {
     this.context.store.dispatch(
-      Notifications.success(notificationOpts)
+      success(notificationOpts)
     );
   }
 
@@ -165,6 +165,18 @@ dispatch(Notifications.warning(notification));
 dispatch(Notifications.info(notification));
 dispatch(Notifications.hide(uid)); // Hides notification based on uid
 dispatch(Notifications.removeAll()); // Removes all notifications
+
+// OR //
+
+import { show, success, error, warning, info, hide, removeAll } from 'react-notification-system-redux';
+
+dispatch(show(notification, level));
+dispatch(success(notification));
+dispatch(error(notification));
+dispatch(warning(notification));
+dispatch(info(notification));
+dispatch(hide(uid)); // Hides notification based on uid
+dispatch(removeAll()); // Removes all notifications
 ```
 
 

diff --git a/example/src/components/container.js b/example/src/components/container.js
@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 import {connect} from 'react-redux';
 import ReactDOM from 'react-dom';
 
-import Notifications from 'react-notification-system-redux';
+import Notifications, { success, error, warning, info, removeAll } from 'react-notification-system-redux';
 
 const notificationOpts = {
   // uid: 'once-please', // you can specify your own uid if required
@@ -33,14 +33,14 @@ class Container extends React.Component {
   }
 
   handleClick() {
-    this.dispatchNotification(Notifications.success, 250);
-    this.dispatchNotification(Notifications.error, 500);
-    this.dispatchNotification(Notifications.warning, 750);
-    this.dispatchNotification(Notifications.info, 1000);
+    this.dispatchNotification(success, 250);
+    this.dispatchNotification(error, 500);
+    this.dispatchNotification(warning, 750);
+    this.dispatchNotification(info, 1000);
   }
 
   handleRemoveAll() {
-    this.context.store.dispatch(Notifications.removeAll());
+    this.context.store.dispatch(removeAll());
   }
 
 	render() {

diff --git a/test/__tests__/notifications.js b/test/__tests__/notifications.js
@@ -3,7 +3,7 @@ import { mount } from 'enzyme';
 import { expect } from 'chai';
 import { jsdom } from 'jsdom';
 import sinon from 'sinon';
-import Component from '../../src/notifications';
+import Component, { show, success, error, warning, info, hide, removeAll } from '../../src/notifications';
 import NotifySystem from 'react-notification-system';
 
 const createDOM = () => jsdom('<!doctype html><html><body><div></div></body></html>');
@@ -36,7 +36,17 @@ describe('NotificationsComponent', () => {
 
   beforeEach(() => {
     DOM = createDOM();
-  });
+	});
+
+	it('exports all actions', () => {
+		expect(show).to.be.a('function');
+		expect(success).to.be.a('function');
+		expect(error).to.be.a('function');
+		expect(warning).to.be.a('function');
+		expect(info).to.be.a('function');
+		expect(hide).to.be.a('function');
+		expect(removeAll).to.be.a('function');
+	});
 
   it('should render one <NotifySystem /> component', () => {
     const wrapper = mountComponent();