Open
Conversation
This file contains hidden or 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.
This PR introduces a
beforeTransactionBuiltevent inY.Doc. This event fires after the transaction is built (after theydoc.transact()callback finishes) but before the transaction is committed.The purpose of the
beforeTransactionBuiltevent is adding modifications to the document in response to other modifications somewhere else in the same transaction. Having the extra modifications in the same transaction ensures proper undo/redo and synchronization. My use-case is updating the document metadata when something changes deep inside the document:Alternative solutions and why they don't work
beforeObserverCallsCreates another transaction.
Wrapping all my document modifications
It doesn't work with third-party libraries, such as
y-prosemirror.Hijacking
transactWorks well for changes made inside
ydoc.transact, but doesn't work for changes outsideydoc.transact.I'm not 100% happy with the
beforeTransactionBuiltevent name, so I'm open for suggestions.I'm not sure whether there should be a separate "all" event. According to the source code and my experiments,
beforeTransactionandbeforeAllTransactionsevents are always emitted together, so I don't understand how the "all" version should work.