editor.setEditable should be allowed to omit update.

[ZaymonFC]

What problem are you facing?

After #3140 some behaviour broke in my app because I wasn't expecting the command to trigger onUpdate().

What’s the solution you would like to see?

I'd like an optional parameter emitUpdate similar to the API provided by editor.commands.setContent:

tiptap/packages/core/src/commands/setContent.ts

Line 21 in c729810

export const setContent: RawCommands['setContent'] = (content, emitUpdate = false, parseOptions = {}) => ({ tr, editor, dispatch }) => {

The parameter would gate the event emission here:

tiptap/packages/core/src/Editor.ts

Lines 170 to 173 in c729810

	public setEditable(editable: boolean): void {
	this.setOptions({ editable })
	this.emit('update', { editor: this, transaction: this.state.tr })
	}

What alternatives did you consider?

Maybe there's a way to look at the editor state or transaction state in the onUpdate({editor, transaction}) => ... callback to know when the isEditable property has been flipped but I couldn't think of anything.

Anything to add? (optional)

I'm happy to implement this PR if you all don't see any issues with this. Adding an optional parameter is a non-breaking change and the default value should be true.

[dominikklein]

I can agree that something like this is really needed, struggled yesterday about the same situation. The editable flag is for me more a read-only, so the value still exists and I was really confused that the onUpdate is triggered.

[Rhys-T]

Would it make sense for setEditable to have its own event type, rather than triggering update? That way, node views could always be sure that they were correctly following the isEditable status of the editor, but unrelated uses of onUpdate wouldn't get triggered unnecessarily. (On the other hand, that would be a breaking change for any code that's currently using onUpdate to watch isEditable…)

[ZaymonFC]

@Rhys-T Breaking an existing contract for the added functionality probably isn't worth it. Consuming code won't be affected by the suggested change and it's lower touch. If there's a case for what you are suggesting I think it would warrant it's own issue and discussion.

[github-actions]

This issue is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 7 days

[ZaymonFC]

Resolved with the merge of #3301