https://github.com/streetstrider/xtab
Browser cross-tab events library
https://github.com/streetstrider/xtab
browser event-emitter javascript localstorage tabs
Last synced: 3 months ago
JSON representation
Browser cross-tab events library
- Host: GitHub
- URL: https://github.com/streetstrider/xtab
- Owner: StreetStrider
- License: other
- Created: 2012-08-09T17:38:45.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2019-04-15T13:45:22.000Z (about 7 years ago)
- Last Synced: 2025-04-14T15:21:27.859Z (about 1 year ago)
- Topics: browser, event-emitter, javascript, localstorage, tabs
- Language: JavaScript
- Homepage:
- Size: 9.77 KB
- Stars: 15
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.txt
Awesome Lists containing this project
README
# XTab
Browser cross-tab events library.
Allow to emit events that will be dispatched to all other tabs from that domain opened.
## install
```bash
$ bower install StreetStrider/XTab
```
```html
```
## usage
### in basic
```javascript
XTab.on('meow', function handler (cat) { ... });
XTab.once('meow', function onceHandler (onlyCat) { ... });
XTab.emit('meow', 'Boris');
```
### multiple handlers
```javascript
function handler1 () { ... };
function handler2 () { ... };
function handler3 () { ... };
XTab.on('meow', handler1);
XTab.on('meow', handler2);
XTab.on('meow', handler3);
```
Handlers will be triggered in straight order of assignment.
### removing handlers
```javascript
XTab.off('meow', handler1); // removes only handler1
XTab.off('meow'); // removes all handlers for meow event
XTab.off(); // removes all handlers
```
### once handlers
```javascript
XTab.once('woff', function run () { ... }); // triggered only once
XTab.emit('woff');
XTab.emit('woff'); // no effect
```
## license
MIT. Copyright © 2012 – 2014 StreetStrider.