Package Exports
- knockout-undoredo
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (knockout-undoredo) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Knockout Undo-Redo
Generic undo/redo history-management for knockout observables.
Install
$ npm install knockout-undoredo
Usage
import ko from 'knockout';
import UndoManager from 'knockout-undoredo';
class ViewModel {
constructor() {
this.name = ko.observable('Obama');
this.message = ko.pureComputed(() => `Thanks ${this.name()}`);
}
}
const vm = new ViewModel();
// Connect your viewmodel with the undomanager
const undomanager = new UndoManager(vm);
ko.applyBindings(vm);
// ... and later
console.log(vm.message()); // Thanks Obama
vm.name('Trump');
console.log(vm.message()); // Thanks Trump
undomanager.undo();
console.log(vm.message()); // Thanks Obama
undomanager.redo();
console.log(vm.message()); // Thanks Trump##Create changesets as an undo/redo step
knockout-undoredo has the ability to collect multiple changes over a defined time as a changeset. These collections will be merged to just one undo/redo step in the history timeline.
// ...
const undomanager = new UndoManager(vm, {throttle: 300});
console.log(vm.message()); // Thanks Obama
vm.name('Trump');
vm.name('Clinton');
console.log(vm.message()); // Thanks Clinton
undomanager.undo();
console.log(vm.message()); // Thanks ObamaConstructor Options
- `throttle`: Integer (Default: 300)
- Timeout in which changes will be collected into a changeset
- `steps`: Integer (Default: 30)
- Stack size for undoable/redoable changes