bt/README.md

1.6 KiB

bt

manage communication between browser tabs

require

html5 localStorage

Initialize

$v(document).ready(function() {
    $bt.init();
}

Internal Commands

// append data on node to other browser tabs
$bt.append('#test', "<b>it's cool to append</b>");

// rewrite content on node to other browser tabs
$bt.html('#test', "<b>it's cool to rewrite</b>");

// rewrite content to specific browser tabs
$bt.html('#test', "<b>it's cool to rewrite</b>", '1449974562012');

// perform a node synchro to other browser tabs
$bt.sync('#test');

// reload other browser tabs
$bt.reload();

// reload other browser tabs to specific url
$bt.reload(window.location.path+"?reloaded=1");

// get browser tab list
$bt.list;

// current browser tab id
$bt.id;

Custom Commands

// define a new custom cmd
$bt.CMD_CUSTOM = "customCmd";
// treat custom command to other browser tabs
$bt.on = function(cmd) {
    switch (cmd.name) {
        case $bt.CMD_CUSTOM :
            // do stuff
            $bt.log("custom command `'+cmd.name+'` with `'+cmd.customKey+'`');
        break;
    }
}

// send a custom command to other browser tabs
$bt.send({ name : $bt.CMD_CUSTOM, customKey : 'customValue' });

Bonus

// alias localStorage : clear|rem|get|set
$l;
// alias json : str|obj
$j
// minimal vanilla jquery style : ready|on|html|append|attr|val|foreach
$v

Demo

on chromium/chrome browser make sure to test on a web server (not directly file://)

enjoy !