1.1.1 • Published 5 years ago

react-whc-notification v1.1.1

Weekly downloads
3
License
MIT
Repository
github
Last release
5 years ago

react-whc-notification

A react、vue、react native module to post and observer notification, it works on React 、React-Native 、Vue、H5. (支持一对多发送通知消息、主要解决react、react-native、vue、h5夸组件页面之间的通信状态管理等)

该组件可以用来替代Redux,Vuex进行状态管理,使用更加简单高效,强力推荐

PRs Welcome NPM version License MIT

Content

Installation

  • 1.Run npm i react-whc-notification --save
  • 2.import Notification from 'react-whc-notification'

Getting started

Add react-whc-notification to your js file.

import Notification from 'react-whc-notification'

Add observer notification:

 constructor(props) {
      super(props);
      Notification.addObserver(this, 'ObserverNotificationName' ,(param) => {
          console.log(param);
      });

      // 最后一个参数true用来补发通知(主要是用于监听已经发过的通知但是监听者还没来得及注册监听的情况)
      Notification.addObserver(this, 'ObserverNotificationName' ,(param) => {
          console.log(param);
      }, true);
  }

Post notification:

Notification.post('ObserverNotificationName', '通知传递的参数可以是任意数据类型');

Remove specified observer notification:

componentWillUnmount() {
    Notification.removeObserver(this, 'ObserverNotificationName');
}

Remove all observer notification:

componentWillUnmount() {
    Notification.removeObserver(this);
}

API

MethodTypeOptionalDescription
post(string, any)functiontruepost notification
addObserver(object, string, function, boolean)functiontrueobserver notification
removeObserver(object, string)functiontrueremove observer notification

Contribution

Issues are welcome. Please add a screenshot of bug and code snippet. Quickest way to solve issue is to reproduce it on one of the examples.

Pull requests are welcome. If you want to change API or making something big better to create issue and discuss it first.


MIT Licensed