Merge pull request #317 from Tofandel/master

fix: delta comparison
vueup · Feb 4, 2023 · dc589e1 · dc589e1
2 parents 545cfa4 + f96121b
commit dc589e1
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 16 deletions.
diff --git a/demo/src/examples/BasicExample.vue b/demo/src/examples/BasicExample.vue
@@ -13,15 +13,10 @@ export default defineComponent({
   },
   setup: () => {
     const content = ref<Delta>(
-      new Delta([
-        { insert: 'Gandalf', attributes: { bold: true } },
-        { insert: ' the ' },
-        { insert: 'Grey', attributes: { color: '#ccc' } },
-      ])
+      new Delta()
     )
 
     return { content }
   },
 })
 </script>
-
diff --git a/demo/src/examples/ContentType.vue b/demo/src/examples/ContentType.vue
@@ -50,10 +50,12 @@ export default defineComponent({
       ]);
       contentHTML.value = '<h3>This is a different HTML header</h3>';
       contentText.value = 'This is some more plain text';
+
+      setTimeout(() =>
+          contentDelta.value.insert('\n I am also deeply reactive and a ref update works'), 200)
     }
 
     return { contentDelta, contentHTML, contentText, update }
   },
 })
 </script>
-
diff --git a/packages/vue-quill/src/components/QuillEditor.ts b/packages/vue-quill/src/components/QuillEditor.ts
@@ -185,12 +185,18 @@ export const QuillEditor = defineComponent({
       )
     }
 
+    const maybeClone = (delta: Delta | string) => {
+      return typeof delta === 'object' ? delta.slice() : delta
+    }
+
     const deltaHasValuesOtherThanRetain = (delta: Delta): boolean => {
-      return Object.values(delta).some((v) => !v.retain)
+      return Object.values(delta.ops).some(
+        (v) => !v.retain || Object.keys(v).length !== 1
+      )
     }
 
-    // eslint-disable-next-line vue/no-setup-props-destructure
-    let internalModel = props.content // Doesn't need reactivity
+    // Doesn't need reactivity, but does need to be cloned to avoid deep mutations always registering as equal
+    let internalModel: typeof props.content
     const internalModelEquals = (against: Delta | String | undefined) => {
       if (typeof internalModel === typeof against) {
         if (against === internalModel) {
@@ -211,10 +217,7 @@ export const QuillEditor = defineComponent({
       oldContents: Delta,
       source: Sources
     ) => {
-      // Quill should never be null at this point because we receive an event
-      // so content should not be undefined but let's make ts and eslint happy
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      internalModel = getContents()!
+      internalModel = maybeClone(getContents() as string | Delta)
       // Update v-model:content when text changes
       if (!internalModelEquals(props.content)) {
         ctx.emit('update:content', internalModel)
@@ -302,6 +305,7 @@ export const QuillEditor = defineComponent({
       } else {
         quill?.setContents(content as Delta, source)
       }
+      internalModel = maybeClone(content)
     }
 
     const getText = (index?: number, length?: number): string => {
@@ -338,14 +342,14 @@ export const QuillEditor = defineComponent({
       (newContent) => {
         if (!quill || !newContent || internalModelEquals(newContent)) return
 
-        internalModel = newContent
         // Restore the selection and cursor position after updating the content
         const selection = quill.getSelection()
         if (selection) {
           nextTick(() => quill?.setSelection(selection))
         }
         setContents(newContent)
-      }
+      },
+      { deep: true }
     )
 
     watch(