feature: add support for blocknote transactions #1147
+203
−170
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
YousefED
changed the title
YousefED
changed the title
nperez0111
reviewed
Jan 14, 2025
Comment on lines
+488
to
+509
| /** | ||
| * Dispatch a transaction, but only if not in a "blocknote transact". | ||
| */ | ||
| public dispatch(tr: Transaction) { | ||
| if (!this.activeTransaction) { | ||
| this._tiptapEditor.dispatch(tr); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Execute a function within a "blocknote transaction". | ||
| * All changes to the editor within the transaction will be grouped together, so that | ||
| * we can dispatch them as a single operation (thus creating only a single undo step) | ||
| */ | ||
| public transact(func: () => void) { | ||
| this.activeTransaction = this._tiptapEditor.state.tr; | ||
| try { | ||
| func(); | ||
| this._tiptapEditor.dispatch(this.activeTransaction); | ||
| } finally { | ||
| this.activeTransaction = undefined; | ||
| } |
There was a problem hiding this comment.
Just for awareness, Tiptap already has a way to capture transactions without immediately dispatching them: https://github.com/ueberdosis/tiptap/blob/44cae5badc07e715bf6554e7042a9e4e926e57b7/packages/core/src/Editor.ts#L414-L429
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 is a POC for blocknote-level transactions. It should make it possible to clean our existing commands (those in
blockManipulationfurther down by migrating away from tiptap-style commands). It also unlocks the possibility for userland-transactions.For example, the following bug is fixed:
closes https://github.com/TypeCellOS/BlockNote/issues?q=is%3Aissue+is%3Aopen+undo
TODO:
editor.state? It's likely they should read the state from theactiveTransactioninstead (diagnose, create tests, and fix)transact