Skip to content

Cross domain/tab/window (intrabrowser) communication in the browser

Notifications You must be signed in to change notification settings

srcagency/browser-bus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Browser bus

This was supposed to give you seamless (offline) communication across a browser instance. Unfortunately not all browsers like the creative use of technologies.

Tested and working in:

  • Chrome 50
  • Firefox 46
  • IE 10
  • Edge 15

Does not work in:

  • IE 11
  • Safari 9
  • Edge 13-14

If you just need cross-window/tab communication see domain-bus.

var bus = require('browser-bus')({
	relay: 'https://srcagency.github.io/browser-bus/relay.html',
});

bus.listen(function( m ){
	if (m === 'ping')
		bus.write('pong');

	console.log('Received', m);
});

bus.write('ping');

The techniques used are:

  • postMessage for cross-origin

    A limitation of the postMessage API is that you need a reference for the window you are in contact with, meaning it only works with iframes, popups and windows you open from the origin.

  • localStorage for cross-window/tab

    Has opposite traits of the postMessage API: does not need a reference to the receiver, as it is domain-wide by default, but has no cross-domain capabilities.

Interface

var bus = new Bus({
	// if you need offline communication, use techniques to make the relay
	// available offline as well
	relay: 'https://srcagency.github.io/browser-bus/relay.html',
});

// write a message to the bus. Any JSON value is supported via JSON.stringify.
bus.write(message);

bus.listen(fn); // `fn(message)` will be called for each received message

Resources

About

Cross domain/tab/window (intrabrowser) communication in the browser

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published