perf(react): do some light diffing to not reset options on every render #6024

[nperez0111]

Changes Overview

This does a shallow diff between the current options and the incoming ones to determine whether we should try to write the new options and incur a state update within the editor.

It purposefully is not doing a full diff as several options are known to be problematic (callback handlers, extensions array, the content itself), so we rely on referential equality only to do this diffing which should be fairly fast since there are only about 10-15 options, and this diffs only the ones the user has actually attempted to set.

Implementation Approach

Testing Done

Verification Steps

Additional Notes

Checklist

• I have created a changeset for this PR if necessary.
• My changes do not break the library.
• I have added tests where applicable.
• I have followed the project guidelines.
• I have fixed any lint issues.

Related Issues

[changeset-bot]

🦋 Changeset detected

Latest commit: c378469

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 54 packages

Name	Type
@tiptap/react	Patch
@tiptap/core	Patch
@tiptap/extension-blockquote	Patch
@tiptap/extension-bold	Patch
@tiptap/extension-bubble-menu	Patch
@tiptap/extension-bullet-list	Patch
@tiptap/extension-character-count	Patch
@tiptap/extension-code-block-lowlight	Patch
@tiptap/extension-code-block	Patch
@tiptap/extension-code	Patch
@tiptap/extension-collaboration-cursor	Patch
@tiptap/extension-collaboration	Patch
@tiptap/extension-color	Patch
@tiptap/extension-document	Patch
@tiptap/extension-dropcursor	Patch
@tiptap/extension-floating-menu	Patch
@tiptap/extension-focus	Patch
@tiptap/extension-font-family	Patch
@tiptap/extension-gapcursor	Patch
@tiptap/extension-hard-break	Patch
@tiptap/extension-heading	Patch
@tiptap/extension-highlight	Patch
@tiptap/extension-history	Patch
@tiptap/extension-horizontal-rule	Patch
@tiptap/extension-image	Patch
@tiptap/extension-italic	Patch
@tiptap/extension-link	Patch
@tiptap/extension-list-item	Patch
@tiptap/extension-list-keymap	Patch
@tiptap/extension-mention	Patch
@tiptap/extension-ordered-list	Patch
@tiptap/extension-paragraph	Patch
@tiptap/extension-placeholder	Patch
@tiptap/extension-strike	Patch
@tiptap/extension-subscript	Patch
@tiptap/extension-superscript	Patch
@tiptap/extension-table-cell	Patch
@tiptap/extension-table-header	Patch
@tiptap/extension-table-row	Patch
@tiptap/extension-table	Patch
@tiptap/extension-task-item	Patch
@tiptap/extension-task-list	Patch
@tiptap/extension-text-align	Patch
@tiptap/extension-text-style	Patch
@tiptap/extension-text	Patch
@tiptap/extension-typography	Patch
@tiptap/extension-underline	Patch
@tiptap/extension-youtube	Patch
@tiptap/html	Patch
@tiptap/pm	Patch
@tiptap/starter-kit	Patch
@tiptap/suggestion	Patch
@tiptap/vue-2	Patch
@tiptap/vue-3	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[netlify]

✅ Deploy Preview for tiptap-embed ready!

Name	Link
🔨 Latest commit	c378469
🔍 Latest deploy log	https://app.netlify.com/sites/tiptap-embed/deploys/678cd7c45a97cd0008975cb6
😎 Deploy Preview	https://deploy-preview-6031--tiptap-embed.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[pkg-pr-new]

Open in Stackblitz

@tiptap/core

npm i https://pkg.pr.new/@tiptap/core@6031

@tiptap/extension-bubble-menu

npm i https://pkg.pr.new/@tiptap/extension-bubble-menu@6031

@tiptap/extension-blockquote

npm i https://pkg.pr.new/@tiptap/extension-blockquote@6031

@tiptap/extension-bullet-list

npm i https://pkg.pr.new/@tiptap/extension-bullet-list@6031

@tiptap/extension-character-count

npm i https://pkg.pr.new/@tiptap/extension-character-count@6031

@tiptap/extension-bold

npm i https://pkg.pr.new/@tiptap/extension-bold@6031

@tiptap/extension-code

npm i https://pkg.pr.new/@tiptap/extension-code@6031

@tiptap/extension-code-block

npm i https://pkg.pr.new/@tiptap/extension-code-block@6031

@tiptap/extension-code-block-lowlight

npm i https://pkg.pr.new/@tiptap/extension-code-block-lowlight@6031

@tiptap/extension-collaboration

npm i https://pkg.pr.new/@tiptap/extension-collaboration@6031

@tiptap/extension-collaboration-cursor

npm i https://pkg.pr.new/@tiptap/extension-collaboration-cursor@6031

@tiptap/extension-color

npm i https://pkg.pr.new/@tiptap/extension-color@6031

@tiptap/extension-document

npm i https://pkg.pr.new/@tiptap/extension-document@6031

@tiptap/extension-dropcursor

npm i https://pkg.pr.new/@tiptap/extension-dropcursor@6031

@tiptap/extension-floating-menu

npm i https://pkg.pr.new/@tiptap/extension-floating-menu@6031

@tiptap/extension-focus

npm i https://pkg.pr.new/@tiptap/extension-focus@6031

@tiptap/extension-font-family

npm i https://pkg.pr.new/@tiptap/extension-font-family@6031

@tiptap/extension-gapcursor

npm i https://pkg.pr.new/@tiptap/extension-gapcursor@6031

@tiptap/extension-hard-break

npm i https://pkg.pr.new/@tiptap/extension-hard-break@6031

@tiptap/extension-heading

npm i https://pkg.pr.new/@tiptap/extension-heading@6031

@tiptap/extension-highlight

npm i https://pkg.pr.new/@tiptap/extension-highlight@6031

@tiptap/extension-history

npm i https://pkg.pr.new/@tiptap/extension-history@6031

@tiptap/extension-horizontal-rule

npm i https://pkg.pr.new/@tiptap/extension-horizontal-rule@6031

@tiptap/extension-image

npm i https://pkg.pr.new/@tiptap/extension-image@6031

@tiptap/extension-italic

npm i https://pkg.pr.new/@tiptap/extension-italic@6031

@tiptap/extension-link

npm i https://pkg.pr.new/@tiptap/extension-link@6031

@tiptap/extension-list-item

npm i https://pkg.pr.new/@tiptap/extension-list-item@6031

@tiptap/extension-list-keymap

npm i https://pkg.pr.new/@tiptap/extension-list-keymap@6031

@tiptap/extension-mention

npm i https://pkg.pr.new/@tiptap/extension-mention@6031

@tiptap/extension-ordered-list

npm i https://pkg.pr.new/@tiptap/extension-ordered-list@6031

@tiptap/extension-paragraph

npm i https://pkg.pr.new/@tiptap/extension-paragraph@6031

@tiptap/extension-placeholder

npm i https://pkg.pr.new/@tiptap/extension-placeholder@6031

@tiptap/extension-strike

npm i https://pkg.pr.new/@tiptap/extension-strike@6031

@tiptap/extension-subscript

npm i https://pkg.pr.new/@tiptap/extension-subscript@6031

@tiptap/extension-superscript

npm i https://pkg.pr.new/@tiptap/extension-superscript@6031

@tiptap/extension-table

npm i https://pkg.pr.new/@tiptap/extension-table@6031

@tiptap/extension-table-cell

npm i https://pkg.pr.new/@tiptap/extension-table-cell@6031

@tiptap/extension-table-header

npm i https://pkg.pr.new/@tiptap/extension-table-header@6031

@tiptap/extension-table-row

npm i https://pkg.pr.new/@tiptap/extension-table-row@6031

@tiptap/extension-task-item

npm i https://pkg.pr.new/@tiptap/extension-task-item@6031

@tiptap/extension-task-list

npm i https://pkg.pr.new/@tiptap/extension-task-list@6031

@tiptap/extension-text

npm i https://pkg.pr.new/@tiptap/extension-text@6031

@tiptap/extension-text-align

npm i https://pkg.pr.new/@tiptap/extension-text-align@6031

@tiptap/extension-text-style

npm i https://pkg.pr.new/@tiptap/extension-text-style@6031

@tiptap/extension-typography

npm i https://pkg.pr.new/@tiptap/extension-typography@6031

@tiptap/extension-underline

npm i https://pkg.pr.new/@tiptap/extension-underline@6031

@tiptap/extension-youtube

npm i https://pkg.pr.new/@tiptap/extension-youtube@6031

@tiptap/html

npm i https://pkg.pr.new/@tiptap/html@6031

@tiptap/pm

npm i https://pkg.pr.new/@tiptap/pm@6031

@tiptap/react

npm i https://pkg.pr.new/@tiptap/react@6031

@tiptap/starter-kit

npm i https://pkg.pr.new/@tiptap/starter-kit@6031

@tiptap/suggestion

npm i https://pkg.pr.new/@tiptap/suggestion@6031

@tiptap/vue-2

npm i https://pkg.pr.new/@tiptap/vue-2@6031

@tiptap/vue-3

npm i https://pkg.pr.new/@tiptap/vue-3@6031

commit: c378469