adampoczatek / clickago.js Goto Github PK

Hi @adampoczatek

I think you need to select a license to encourage open source contributions.

Cheers.

Extra properties:

• name - could be used to display history.
• beforeMethodCall - a function called just before undo/redo.
• timestamp (readonly).

Extra methods:

• action.abort() - prevents from undo/redo.
• clickago.getActions() - returns an array of actions - this could be used to create a history of actions or some sort of indicator to show users what will happen when they undo/redo.

Events

• undo
• redo
• register

Ability to register actions without rollbacks

As per title, make sure users can register actions with no rollbacks.

Examples:

var clickago = new Clickago();

// Events
clickago.listen("undo", function (event, action) { /* ... */ });
clickago.listen("redo", function (event, action) { /* ... */ });
clickago.listen("register", function (event, action) { /* ... */ });

// Properties
clickago.register({
    method: /* ... */,
    thisArg: /* ... */,
    arguments: /* ... */,
    name: "Register User",
    beforeMethodCall: function (action) {
        if (!window.confirm("This will delete all customers permanently, are you sure you want to do this?")) {
            // Action methods
            action.abort();
        }
    }
});

clickago.getActions(); // returns '[{ ... }]'

General info:

• Browser support details.
• Note about dependencies.
• Index of methods and options.

API:

• Include version number per each method/option.

Related to #9