catest / dva-immer-undo-redo

A plugin of dva to support undo redo based on Immer.

dva-immer-undo-redo

A plugin of dva to support undo redo based on Immer.

Install

$ npm install dva-immer-undo-redo --save

Usage

import createUndoRedo from 'dva-immer-undo-redo';

const app = dva();
app.use(createUndoRedo(options));

options

• options.namespace: property key on global state, type String, Default timeline
• options.include: namespaces that you want to include in the timeline. Default []
• options.limit: the max times to undo or redo, Default 1024

Undo

dispatch({ type: 'timeline/undo' });

Redo

dispatch({ type: 'timeline/redo' });

Clear all undo redo status

dispatch({ type: 'timeline/clear' });

Replace timeline

// state of count's model
{
    count: 0,
}
// add reducer
add(state) {
    state.count += 1;
}
dispatch({ type: 'count/add' }); // { count: 1 }
dispatch({ type: 'count/add' }); // { count: 2 }
dispatch({ type: 'count/add', replace: true }); // { count: 3 }
dispatch({ type: 'timeline/undo' }); // { count: 1 }
dispatch({ type: 'timeline/redo' }); // { count: 3 }

Clear timeline

// state of count's model
{
    count: 0,
}
// add reducer
add(state) {
    state.count += 1;
}
dispatch({ type: 'count/add' }); // { count: 1 }
dispatch({ type: 'count/add' }); // { count: 2 }
dispatch({ type: 'count/add', clear: true }); // { canRedo: false, canUndo: false }

State Structure

timeline: {
  canRedo: false,
  canUndo: false,
  undoCount: 0,
  redoCount: 0,
}

License

MIT