prosemirror-history

[ WEBSITE | ISSUES | FORUM | CHANGELOG ]

This is a core module of ProseMirror. ProseMirror is a well-behaved rich semantic content editor based on contentEditable, with support for collaborative editing and custom document schemas.

This module implements an undo/redo history plugin for ProseMirror.

The project page has more information, a number of examples and the documentation.

This code is released under an MIT license. There's a forum for general discussion and support requests, and the Github bug tracker is the place to report issues.

We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.

1.4.1 (2024-07-10)

Bug fixes

Fix an issue where mark steps could cause the history to treat otherwise adjacent changes as non-adjacent, and start superfluous new undo events.

1.4.0 (2024-03-21)

New features

Add undoNoScroll/redoNoScroll commands.

1.3.2 (2023-05-17)

Bug fixes

Include CommonJS type declarations in the package to please new TypeScript resolution settings.

1.3.1 (2023-04-26)

Bug fixes

Fix an issue where, if a composition moved the selection, it might get split across multiple undo events.

1.3.0 (2022-05-30)

Bug fixes

Fix an issue where the default behavior of history beforeInput events could still go through when the undo history is empty.

New features

Include TypeScript type declarations.

1.2.0 (2021-08-18)

Bug fixes

Fix a bug that caused the beforeInput handler to not actually invoke the history commands properly.

New features

The history plugin now listens for beforeInput events with historyUndo or historyRedo type, and applies the undo/redo commands when they occur.

1.1.3 (2019-12-10)

Bug fixes

Fixes a regression where appeneded transactions were combined into the previous history event even if that had been explicitly closed.

1.1.2 (2019-11-20)

Bug fixes

Rename ES module files to use a .js extension, since Webpack gets confused by .mjs

1.1.1 (2019-11-19)

Bug fixes

The file referred to in the package's module field now is compiled down to ES5.

1.1.0 (2019-11-08)

Bug fixes

Prevents appended transactions from starting a new event group, even if they were created a while after the previous transaction.

New features

Add a module field to package json file.

1.0.4 (2019-02-19)

Bug fixes

Fix a bug that corrupted selection data in the history when applying remote steps in some cases.

1.0.3 (2018-10-08)

Bug fixes

Appending a transaction to an undo transaction will no longer immediately clear the redo history.

When handling appended transactions, the history will keep the last step in the original transaction, not the one from the appended transaction, for testing whether a subsequent transaction is adjacent to the previous one.

1.0.2 (2018-03-13)

Bug fixes

Fix a bug that could corrupt the history when rebasing changes because of collaborative editing.

1.0.1 (2018-03-05)

Bug fixes

Fix crash that could occur (in specific circumstance) when redoing.

0.24.0 (2017-09-25)

New features

It is no longer necessary to manually enable the preserveItems option to the history plugin when using collaborative editing. (This behavior is now automatically enabled when necessary.)

0.20.0 (2017-04-03)

Bug fixes

Appended transactions no longer generate undo history events.

0.19.0 (2017-03-16)

New features

A new function closeHistory can be used to force separation of history events at the start of a given transaction.

0.18.0 (2017-02-24)

Bug fixes

Fix a problem where simultaneous collaborative editing could break the undo history.

0.17.1 (2017-02-02)

Bug fixes

Fix issue where collaborative editing corner cases could corrupt the history.

0.12.1 (2016-11-01)

Bug fixes

Fix crash in undo or redo commands when the history is empty.

0.12.0 (2016-10-21)

Breaking changes

The history export is now a function that creates a history plugin, rather than a plugin instance.

New features

Add a newGroupDelay plugin option. This brings back the behavior where pausing between edits will automatically cause the history to put subsequent changes in a new undo event.

0.11.0 (2016-09-21)

Breaking changes

Moved into a separate module. Now acts as a plugin that can be omitted or replaced by a different implementation if desired.

Merging subsequent changes into a single undo 'event' is now done by proximity in the document (the changes must touch) rather than in time. This will probably have to be further refined.