0.1.0 • Published 8 years ago

browser-postmessage v0.1.0

Weekly downloads
2
License
MIT
Repository
github
Last release
8 years ago

BPM - Browser postMessage

a bidirectionnal iframe events manager

Usage

Developpement

Launch a dev server at http://localhost:3000/ and watch for modifications:

$ gulp dev

Developpement files are located in example/index.html and build/postmessage...

Distribution

prepare files for production in dist directory

$ gulp dist

Production files are located in example/dist/index.html and dist/postmessage...

Library Usage

Initialize library:

var pmInstance = bpm.initialize();

Add an iFrame by ID, create a Frame instance:

var clientFrame = pmInstance.addFrame('myIframe');

Frame communication methods (chainable)

Send event

clientFrame.send({
          name: 'clientFirstMessage',
          msg: 'client has something to say to frame 1'
      }, function(response){
           // handle response ...
      });

Listen event by event's name from child Frame:

clientFrame.listenEventName('childFirstMessage', function(response){
     // handle response ...
});

Listen event by event's type from child Frame:

clientFrame.listenEventType('childFirstMessage', function(response){
     // handle response ...
});