https://github.com/stutrek/cross-tab-channel

A simple library for sending data across open browser tabs
https://github.com/stutrek/cross-tab-channel

Last synced: about 1 month ago
JSON representation

A simple library for sending data across open browser tabs

• Host: GitHub
• URL: https://github.com/stutrek/cross-tab-channel
• Owner: stutrek
• Created: 2017-05-19T18:01:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-05-25T22:28:32.000Z (over 7 years ago)
• Last Synced: 2024-09-26T04:15:23.159Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 66.4 KB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# cross-tab-channel

This is a simple library for sending data between browser tabs. It uses storage events for same domain use, and adds in postMessage with an iframe for cross domain messaging. There is also a [redux middleware](https://github.com/stutrek/cross-tab-middleware).

## Why this one?

There are a few of these, but none were what I wanted.

* Cross Domain

* Simplicity - the first release was 1.2k and under 50 lines of code. You get a channel that is an emitter. Nothing else.

* no OnBeforeUnload events - these events mess with the browser cache in undesireable ways that can make hitting the back button painful.

## Usage

### Same Domain

Use this library to listen to messages on a channel. Strings identify channels.

```javascript

import CrossTab from 'cross-tab-channel';

var channel = new CrossTab('my-channel-name');

channel.listen(function (message) {

    console.log(message);

});

channel.emit({

    my: 'data'

});

channel.remove(anyPreviouslyAppliedListener);

```

You may emit messages of any type, as long as they can be JSON encoded.

### Cross Domain

This is more tricky because the browser won't send storage events across domains. It needs to load an iframe hosted on your domain so the library can postMessages to and from it. Luckilly, [that iframe](./dist/iframe.html) has already been made and can be hosted statically after changing the `trustedDomain` variable to the domain you wish to share messages with.

```javascript

import CrossDomain from 'cross-tab-channel/dist/CrossDomain';

// create the iframe that will serve as middleman between your domain and this one

// you can find iframe.html in the dist folder of this repo.

CrossDomain.createIframe('//your-domain.com/path/to/iframe.html');

// channel names are shared with normal, same domain, messaging.

var channel = new CrossDomain('my-channel-name');

channel.listen(function (message) {

    console.log(message);

});

channel.emit({

    my: 'data'

});

channel.remove(anyPreviouslyAppliedListener);

```

#### Cross Domain Security

If you are not in control of all domains you are using, anyone running JavaScript on the receiving site can intercept messages, including advertisers and trackers. Currently there is no validation to ensure third parties aren't sending fake events.

* **Do not send privacy critical data**, such as passwords, credit card numbers, or secret tokens across domains.

* **Do not make the `trustedDomain` in the iframe infinitely configurable.** If a potentially evil third party can change that trusted domain they can read your messages.

## Testing

`yarn start` will start the dev server. Visit http://localhost/test.html and http://127.0.0.1/crossDomain.html and open the console to see it in action.

## Browser Compatibility

Briefly tested on IE9 with surprisingly successful results.