New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature/undo redo #296
Merged
Merged
Feature/undo redo #296
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #277
Parcel's buffer was already made of an array of changes, that get applied to a value on submit. Perfect for exposing this as undo / redo. Care is taken to only store data that says how to make the changes, rather than cached data of the result of those changes, so it should be really quite efficient on memory.
Works with rebasing (so if your "save" action changes your parcel data), works with submitting changes after having undone a few actions. Even works with undoing actions past the point where the data was last submitted and going into negative change territory.
react-dataparcels
parcel.meta.undo()
andparcel.meta.redo()
touseParcel
,useBuffer
andBoundary
parcel.meta.canUndo
,parcel.meta.canRedo
&parcel.meta.synced
booleansuseParcel
anduseBuffer
have an optionalhistory
param, to set the minimum number of history items to always remember. Often there'll be many items being remembered anyway because the history array is only cleared on submit / debounce. Thishistory
param instructs the hooks not clear all history items on submit if it would result in a number of history items lower thanhistory
.