Adds automatic undo/redo functionality for javascript objects, using Object.observe() (deprecated)
JavaScript HTML
Clone or download
azazdeaz Merge pull request #4 from bryant1410/master
Fix broken headings in Markdown files
Latest commit 462c60c Apr 18, 2017
Permalink
Failed to load latest commit information.
bower_components add global blacklist/whitelist functionality Jul 17, 2014
test add global blacklist/whitelist functionality Jul 17, 2014
.gitignore
.travis.yml
LICENSE Initial commit May 26, 2014
LazyJsonUndoRedo.js add global blacklist/whitelist functionality Jul 17, 2014
LazyJsonUndoRedo.min.js add global blacklist/whitelist functionality Jul 17, 2014
LazyJsonUndoRedo.min.js.map add global blacklist/whitelist functionality Jul 17, 2014
README.md Fix broken Markdown headings Apr 17, 2017
bower.json 0.9.7 Jul 18, 2014
package.json 0.9.7 Jul 18, 2014

README.md

LazyJsonUndoRedo Build Status

Gitter

Update: The world has changed and Object.observe() will not going to be a thing anymore. I leave this repo here as a fun experiment.

An experimental tool to create a 'drop in' history handler with automatic undo/redo functionality for nested javascript objects, using Object.observe() or Polymer shim.

Can be usefull for small editor tools but it's not recommended to be used in production.

Object.observe() is only supported in Chrome 36+, Opera 23+, io.js and Nodejs 11.13+ yet, but LJUR is also usable with polymer(observe-js)

Demo

edit json

edit maze

Install

bower install --save LazyJsonUndoRedo
npm install --save lazy-json-undo-redo

Unit tests

native

with polymer shim

Usage

Init
 var o = {}, ljur = new LazyJsonUndoRedo(o);
 
 o.a = 1;
 ljur.undo();
 console.log(o.a); // undefined
 ljur.redo();
 console.log(o.a); // 1


Flagging
 o = {}, ljur = new LazyJsonUndoRedo(o);
 //the changes between the start- end endFlag calls will be treated as one step 
 //in the history  
 var endFlagId = ljur.startFlag();
 o.c = {}
 o.c.b = 1
 o.c.e = 2
 o.f = 4;
 ljur.endFlag(endFlagId);
 ljur.undo();
 console.log(o); //{}
 ljur.redo();
 console.log(o); //{c: {b: 1, e: 2}, f: 4}
 
 //or wrap a function between flags:
 var changerFn = ljur.wrap(function () {/*do changes on o*/});
 changerFn();//all changes are reversible with one undo() call


Force save
 //fast changes can be merged by the api (specially if you're using shim)
 o = {}, ljur = new LazyJsonUndoRedo(o);
 o.g = {};
 o.g.h = 1;
 ljur.undo();
 console.log(o); //{}

 //to avoid this, you can force the history save with ljur.rec()
 o.i = {};
 ljur.rec();
 o.i.j = 2;
 ljur.undo();
 console.log(o); // {i: {}}


Use whitelists
 //if you want to specify witch properties should be listened on an object, 
 // you can use whitelists: 
 o = {};
 ljur = new LazyJsonUndoRedo();
 ljur.setWhiteList(o, ['a', 'b']);
 ljur.observeTree(o);//you have to set the whitelist before start to observe the object
 o.a = 7; //will be undoable
 o.c = 8; //won't be undoable, because 'c' is not on the whitelist
 ljur.undo();
 console.log(o); // {c: 8}
 
 ljur.getWhitelist(o); //['a', 'b']
 ljur.removeWhiteList(o);//whitelists are removable


Use blacklists
 //works the same as whitelists
 ljur.setBlacklist(object, blacklistedKeys);
 ljur.removeBlacklist(object);


Use global black- and whitelist
 //you can use this two list for all of the objects added to ljur
 ljur.addToGlobalWhitelist('a', 'b', 'x', 'd', 'e');
 ljur.removeFromGlobalWhitelist('e', 'x');
 ljur.addToGlobalBlacklist('a', 'b', 'x', 'd', 'e');
 ljur.removeFromGlobalBlacklist('e', 'x');



Listen to more objects
 ljur.observeTree(o2);
 ljur.observeTree(o3);


Check support
 LazyJsonUndoRedo.checkSupport();//true is native Object.observe() or Polymer is present
 ljur.usingShim;//true if the instance is using Polymer shim