1.0.2 • Published 7 years ago
undobag v1.0.2
UndoBag
A JavaScript micro-library for easy implementation of undo and redo feature.
Steps to Include UndoBag:
For Browser-based Projects:
For browser based projects, include the minified js file in the dist folder of the repo into your markup.
<script type="text/javascript" src="dist/undoBag.min.js"></script>The full non-minified js source is available in the src folder.
For nodeJS Projects:
- Install undobag package using npm
npm install undobag- Require it in your file
var undoBag = require('undobag');UndoBag Usage:
Undobag can be initialized as follows:
Browser-based:
new window.UndoBag(options);NodeJS based:
var anyVariableName = new undoBag(options);where the options is an optional configuration object of the form:
{
length: 20, // configures stack length (can be any positive number) Default value: 10
isDev: true // Indicates whether the ENV is development (enables console logging of stack related data)
//Default value: false
}UndoBag APIs:
| API | Parameters | Description | Return Type |
|---|---|---|---|
| recordChange | item | Pushes the passed data/object to the stack | void |
| canUndo | - | Returns whether undo is possible at that particular point | Boolean |
| canRedo | - | Returns whether redo is possible at that particular point | Boolean |
| undo | - | Returns the next data/obj DOWN the line in the stack | Depens on stack content |
| redo | - | Returns the next data/obj UP the line in the stack | Depens on stack content |
| seek | position | Returns the data/obj at supplied position in the stack (1 based positioning, i.e, position 1 returns obj at index 0) | Depens on stack content |
| flushStack | - | Clears all the contents of the stack | void |
| log | - | logs an object in the console that contains stack related data | void |
Steps to Build from Source:
- Clone this repo.
git clone https://github.com/Parthipan-Natkunam/UndoBag.git- Install dev dependencies
npm install- start Grunt task runner
grunt