Natural Preference for Minification
Introducing npm Teams! Private packages + team management tools.Learn more »

white-label-mediator

1.0.11 • Public • Published

white-label-mediator

Build Status Coverage Status

A simple ES6 JS mediator that allows communication between views.

A mediator pattern (also sometimes called pub/sub) is an event bus for messaging between views. It's strength is in that it decouples views from one another because you are not directly binding events between views. You simply are broadcasting a message through the mediator that other views throughout the application can listen and react to as needed.

Events are emited using Node.js' events module. For more options on how to listen to events please look at the Node.js documentation:

https://nodejs.org/api/events.html

Learn more about ES6 classes here:

https://babeljs.io/docs/learn-es2015/

Install

Install the node module:

npm install white-label-mediator --save

Import

import Mediator from 'white-label-mediator';

Instantiate

const myMediator = new Mediator();

Extend

extend the Mediator class for your own needs:

const MyMediator = class extends Mediator {
    someGreatFeature() {
        console.log('this is great!');
    }
};

const myMediator = new MyMediator();

myMediator.someGreatFeature();

On

In a separate view you subscribe to a message that the mediator will publish from another view. The first argument is the name of the message you want to subscribe to. The second argument in the callback.

myMediator.on('main-menu', (data) => {
    window.console.log(data);
});

Emit

In a separate view you publish message that other views are subscribed too. The first argument is the name of the message you want to publish. The second argument is data you can pass along with your message event and is optional. The data passed can be any data type.

myMediator.emit('main-menu', {
    state: 'open'
});

Nothing will happen if you publish a message that no other views are subscribed to.

Let's look at an example:

import the mediator module

import Mediator from 'white-label-mediator';

instantiate the mediator

const myMediator = new Mediator();

import the view module

import View from 'white-label-view';

create the first view to listen to the mediator for a 'window-scrolling' message

const MyView1 = class extends View {
    initialize() {
        this.addListeners();
    }
    addListeners() {
        myMediator.on('window-scrolling', (data) => {
            window.console.log('MyView2 is messaging that the window is scrolling', data);
        });
    }
};

create the second view to emit through the mediator the 'window-scrolling' event as the window scrolls and pass the event object along

const MyView2 = class extends View {
    initialize() {
        this.addListeners();
    }
    addListeners() {
        window.addEventListener('scroll', (e) => {
            myMediator.emit('window-scrolling', e);
        }, false);
    }
};

instantiate the views

const myView1 = new MyView1();
const myView2 = new MyView2();

initialize the views

myView1.initialize();
myView2.initialize();

Install

npm i white-label-mediator

DownloadsWeekly Downloads

0

Version

1.0.11

License

MIT

Last publish

Collaborators

  • avatar