on('transaction') vs on('update')

[Benny739]

on('transaction') vs on('update')

[sibiraj-s]

To be frank, I don't remember why I made the change. Also, I don't remember seeing an update event. At that time most of their docs were in progress. Or I could not have noticed/missed.

I am open to making this change. But, unless we properly evaluate the difference between the two events. I think it is worth considering it as a breaking change. Thoughts?

[Benny739]

Yeah we could consider it a breaking change.
According to the tiptap docs update is the proper event here.
I tested it and I could not see any difference. On transaction just emits way more often but when it comes to the content change there was no difference.
I think we could go with a minor version and mention the change in the behavior.

Should I create a PR?

[sibiraj-s]

And I think I remember the reason for using the transaction event. There are certain commands where update events are not triggered. But I think there is a workaround, all commands of this category we need to add an extra boolean parameter to manually tell tiptap to fire the event.

Example:

Before

editor.commands.setContent(‘Hello World!')

After

editor.commands.setContent(‘Hello World!’, true)

Ref: https://tiptap.dev/api/commands/set-content

[sibiraj-s]

And need to verify the OnPush changedetection strategy as well.

[sibiraj-s]

Note: Moving from transaction to update event might fix #24

[Benny739]

Yes the emitUpdate option is actually important, because #24 arises from onTransaction not respecting the emitUpdate

this.editor.chain().setContent(value, false).run();

We already have emitUpdate = false in writeValue, so it shouldn't trigger an update, but only on('update') respects that option.

OnPush is no problem here, because handleChange isn't changing. The only difference the on('update') should do, is not emit a value in the writeValue function.

[sibiraj-s]

Fixed in v7.0.0

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in the thread.