{
  "$schema": "https://ai.syncfusion.com/schema/registry-item.json",
  "name": "docx-editor-compare-documents",
  "framework": "vue",
  "type": "registry:component",
  "component": "DocxEditor",
  "variant": "compare-documents",
  "dependencies": [
    "@syncfusion/ej2-vue-buttons",
    "@syncfusion/ej2-vue-documenteditor"
  ],
  "description": "Word editor compares uploaded original and revised documents and displays the revision results.",
  "meta": {
    "essentialStudioRelease": "2026 Volume 3 (v35.1.37)",
    "license": "commercial-or-community",
    "licenseNote": "The Syncfusion package is licensed. The composition in this file is source you own and edit. See https://ai.syncfusion.com/licensing.md",
    "requiresLicenseKey": true,
    "requiresServerEndpoint": true,
    "platformIndex": "https://ai.syncfusion.com/vue/llms.txt",
    "skillPack": "syncfusion/vue-ui-components-skills",
    "docs": "https://ai.syncfusion.com/gallery/vue/docx-editor-compare-documents.md"
  },
  "files": [
    {
      "target": "src/components/docx-editor-compare-documents/DocxEditor.vue",
      "content": "<template>\n<div class=\"control-section\" style=\"width: 100%;\">\n  <!-- Shared container -->\n  <div style=\"width: 760px; margin: 10px auto\">\n    <!-- Upload row -->\n    <div style=\"display: flex; gap: 6px\">\n      <!-- Original file section-->\n      <div style=\"width: 360px; border-radius: 6px; padding: 14px; border: 1px dashed #ccc\">\n        <!-- Top row -->\n        <div style=\"display: flex; align-items: center; gap: 10px;\">\n          <span>Original document</span>\n          <label style=\" padding: 4px 10px;\n            border: 1px solid #ccc;\n            border-radius: 4px;\n            cursor: pointer;\">\n            Choose file\n            <input type=\"file\"\n              style=\"display: none;\"\n              accept=\".docx,.sfdt\"\n              @change=\"onOriginalFileChange\" />\n          </label>\n        </div>         \n        <!-- Filename + Delete icon -->\n        <div style=\"display: flex; justify-content: space-between; align-items: center; margin-top: 6px; font-size: 12px; color: #666;\">\n          <span>{{ getOriginalFileName() }}</span>\n          <span\n            v-if=\"originalFile\"\n            class=\"e-icons e-trash\"\n            @click=\"removeOriginalFile\"\n            style=\"cursor: pointer;\"\n            title=\"Remove file\">\n          </span>\n        </div>\n      </div>\n      <!-- Revised file section-->\n      <div style=\"width: 360px; border-radius: 6px; padding: 14px; border: 1px dashed #ccc;\">\n        <!-- Top row -->\n        <div style=\"display: flex; align-items: center; gap: 10px;\">\n          <span>Revised document</span>\n          <label style=\"\n            padding: 4px 10px;\n            border: 1px solid #ccc;\n            border-radius: 4px;\n            cursor: pointer;\">\n            Choose file\n            <input type=\"file\"\n              style=\"display: none;\"\n              accept=\".docx,.sfdt\"\n              @change =\"onRevisedFileChange\" />\n          </label>\n        </div>\n        <!-- Filename + Delete icon -->\n        <div style=\"display: flex; justify-content: space-between; align-items: center; margin-top: 6px; font-size: 12px; color: #666;\">\n          <span>{{ getRevisedFileName() }}</span>\n          <span\n            v-if=\"revisedFile\"\n            class=\"e-icons e-trash\"\n            @click=\"removeRevisedFile\"\n            style=\"cursor: pointer;\"\n            title=\"Remove file\">\n          </span>\n        </div>\n      </div>\n    </div>\n    <!-- Checkbox, Compare & Download buttons  -->\n    <div style=\"display: flex; justify-content: space-between; align-items: center; margin-top: 12px;\">  \n      <!-- Checkbox -->\n      <div>\n      <label style=\"cursor: pointer;\">\n          <input\n            type=\"checkbox\"\n            :checked=\"showResult\"\n            @change=\"onShowResultChange\"\n            style=\"margin-right: 6px;\" />\n          <span>Show comparison results with tracked changes</span>\n      </label>\n      </div>\n      <!-- Buttons -->\n      <div style=\"display: flex; gap: 10px; margin-right: 32px;\">\n        <ejs-button\n          class=\"e-btn e-primary\"\n          :disabled=\"!originalFile || !revisedFile\"\n          @click=\"onCompare\">\n          Compare\n        </ejs-button>\n        <ejs-button\n          class=\"e-btn e-outline e-flat e-primary\"\n          iconCss=\"e-icons e-download\"\n          :disabled=\"!compareClicked\"\n          @click=\"onDownload\">\n          Dowload Result Document\n        </ejs-button>\n      </div>\n    </div>\n  </div>\n\n  <!-- Editors Area -->\n  <div style=\"display: flex; gap: 6px; height: calc(100vh - 330px); padding: 0px 10px;\">\n    <!-- Left Container -->\n    <div style=\"width: 50%; display: flex; flex-direction: column; border: 1px solid #ddd; overflow: hidden;\">\n      <div style=\"padding: 8px; font-weight: 600;\" class=\"e-de-ctn-title\">Original Document</div>\n      <div style=\"flex: 1px; display:block; height: calc(100vh - 330px);\">\n        <ejs-documenteditorcontainer\n        id=\"editor1\"\n        ref=\"editor1\"\n        :serviceUrl=\"serviceUrl\"\n        height=\"100%\"\n        width=\"100%\"\n        :enableToolbar=\"false\"\n        :showPropertiesPane=\"false\"\n        >\n        </ejs-documenteditorcontainer>\n      </div>\n    </div>    \n    <!-- Right Editor -->\n    <div style=\"width: 50%; display: flex; flex-direction: column; border: 1px solid #ddd; overflow: hidden;\">\n      <div class=\"e-de-ctn-title\" style=\"display: flex; justify-content: space-between; align-items: center\">\n        <div style=\"float: left; padding: 8px; font-weight: 600; flex: 1px;\" >\n          {{\n            showResult\n              ? 'Result Document (with tracked changes)'\n              : 'Revised Document'\n          }}\n        </div>\n        <ejs-button \n          v-if=\"showResult\"\n          class=\"e-de-ctn-title\"\n          iconCss=\"e-icons e-eye\"\n          style=\"float: right; font-weight: 400; background: transparent; box-shadow: none; border-color: transparent; border-radius: 0px;\n                color: inherit; font-size: 12px;\"\n          title=\"Show/Hide Revisions Pane\"\n          @click=\"onToggleRevisionsPane\">\n          {{showRevisions ? ' Hide Review Pane' : ' Show Review Pane'}}\n        </ejs-button>\n      </div>\n      <div style=\"flex: 1px; display:block; height: calc(100vh - 330px);\">\n        <ejs-documenteditorcontainer\n        id=\"editor2\"\n        ref=\"editor2\"\n        :serviceUrl=\"serviceUrl\"\n        height=\"100%\"\n        width=\"100%\"\n        :enableToolbar=\"false\"\n        :showPropertiesPane=\"false\"\n        >\n        </ejs-documenteditorcontainer>\n      </div>\n    </div>\n  </div>\n\n  <!-- Waiting Popup Overlay -->\n  <div class=\"overlay\" id=\"popup-overlay\" style=\"display: none;\"></div>\n  <div id='waiting-popup' style=\"display: none;\">\n    <svg class=\"circular\" height=\"40\" width=\"40\">\n      <circle class=\"circle-path\" cx=\"25\" cy=\"25\" r=\"20\" fill=\"none\" stroke-width=\"6\" stroke-miterlimit=\"10\" />\n    </svg>\n  </div>\n</div>    \n</template>\n\n<script>\nimport { DocumentEditorContainerComponent } from \"@syncfusion/ej2-vue-documenteditor\";\nimport { ButtonComponent } from \"@syncfusion/ej2-vue-buttons\";\nimport { originalDocument, revisedDocument } from \"../datasource/docx-editor-data\";\nimport \"../style.css\";\n\nexport default {\n  components: {\n    'ejs-documenteditorcontainer': DocumentEditorContainerComponent,\n    'ejs-button': ButtonComponent\n  },\n  data() {\n    return {\n      originalFile: null,\n      revisedFile: null,\n      showResult: true,\n      compareClicked: false,\n      showRevisions: false,\n      serviceUrl: 'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/'\n    };\n  },\n  mounted() {\n    this.$nextTick(() => {\n      // Set up synced scrolling between editors\n      const editor1 = this.$refs.editor1.ej2Instances.documentEditor;\n      const editor2 = this.$refs.editor2.ej2Instances.documentEditor;\n      \n      if (editor1 && editor2) {\n        editor1.showRevisions = false;\n        editor1.open(JSON.stringify(originalDocument));\n        editor2.showRevisions = false;\n        editor2.open(JSON.stringify(revisedDocument));\n        editor1.viewChange = () => {\n          const pos = editor1.selection.getScrollPosition();\n          editor2.selection.setScrollPosition(pos);\n        };\n        \n        editor2.viewChange = () => {\n          const pos = editor2.selection.getScrollPosition();\n          editor1.selection.setScrollPosition(pos);\n        };\n      }\n    });\n  },\n  methods: {\n    onOriginalFileChange(e) {\n      this.originalFile = e.target.files ? e.target.files[0] : null;\n    },\n    \n    onRevisedFileChange(e) {\n      this.revisedFile = e.target.files ? e.target.files[0] : null;\n    },\n    \n    isSupportedFormatType(formatType) {\n      switch (formatType) {\n        case '.docx':\n        case '.sfdt':\n          return true;\n        default:\n          return false;\n      }\n    },\n    \n    async openFileInEditor(file, editorRef) {\n      // Using slice instead of substr (which is deprecated)\n      const formatType = file.name.slice(file.name.lastIndexOf('.')).toLowerCase();\n      \n      if (formatType === '.sfdt') {\n        const reader = new FileReader();\n        reader.onload = e => {\n          const docData = e.target?.result;\n          if (docData && editorRef.ej2Instances.documentEditor) {\n            editorRef.ej2Instances.documentEditor.showRevisions = false;\n            editorRef.ej2Instances.documentEditor.open(docData);\n          }\n        };\n        reader.readAsText(file);\n      }\n      else if (this.isSupportedFormatType(formatType)) {\n        const formData = new FormData();\n        formData.append('file', file);\n        \n        try {\n          const response = await fetch(this.serviceUrl + 'Import', {\n            method: 'POST',\n            body: formData\n          });\n          \n          const sfdtString = await response.text();\n          let sfdtObject = null;\n          \n          try {\n            sfdtObject = JSON.parse(sfdtString);\n          } catch (e) {\n            alert(\"Unable to display the compared document. Please try again.\");\n          }\n          \n          if (sfdtObject && editorRef.ej2Instances.documentEditor) {\n            editorRef.ej2Instances.documentEditor.showRevisions = false;\n            editorRef.ej2Instances.documentEditor.open(JSON.stringify(sfdtObject));\n          } else {\n            alert(\"Unable to display the compared document. Please try again.\");\n          }\n        } catch (e) {\n          alert('Failed to import document file. Please check if the server supports this format.');\n        }\n      }\n      else {\n        alert('This Compare Documents demo supports only DOCX and SFDT file formats. Please select a valid DOCX or SFDT document and try again.');\n      }\n    },\n    \n    async loadComparedDocumentAndOpen(editorRef, originalFile, revisedFile) {\n      const formData = new FormData();\n      formData.append(\"originalFile\", originalFile);\n      formData.append(\"revisedFile\", revisedFile);\n      formData.append(\"author\", \"Author\");\n      formData.append(\"dateTime\", new Date().toISOString());\n      try {\n        const response = await fetch(this.serviceUrl + 'CompareDocuments', {\n          method: 'POST',\n          body: formData\n        });\n        \n        if (!response.ok) {\n          alert(\"Failed to compare the selected documents. Please try again.\");\n          return;\n        }\n        \n        const sfdtString = await response.text();\n        let sfdtObject = null;\n        \n        try {\n          sfdtObject = JSON.parse(sfdtString);\n        } catch {\n          alert(\"The comparison could not be completed due to no valid JSON. Please try again.\");\n          return;\n        }\n        \n        if (sfdtObject && editorRef.ej2Instances.documentEditor) {\n          editorRef.ej2Instances.documentEditor.showRevisions = false;\n          editorRef.ej2Instances.documentEditor.open(JSON.stringify(sfdtObject));\n        } else {\n          alert(\"Unable to display the comparison result. Please try again.\");\n        }\n      } catch (e) {\n        alert('Error comparing documents: ' + e);\n      }\n      this.showHideWaitingIndicator(false);\n    },\n    \n    onShowResultChange(e) {\n      this.showResult = e.target.checked;\n    },\n\n    async onCompare() {\n      this.compareClicked = false;\n      \n      setTimeout(async () => {\n        if(this.originalFile && this.revisedFile){\n          var orginalFileFormatType = this.originalFile.name.slice(this.originalFile.name.lastIndexOf('.')).toLowerCase();\n          var revisedFileFormatType = this.revisedFile.name.slice(this.revisedFile.name.lastIndexOf('.')).toLowerCase();\n          if(this.isSupportedFormatType(orginalFileFormatType) && this.isSupportedFormatType(revisedFileFormatType)){\n            this.compareClicked = true;\n            this.showRevisions = false;\n            this.showHideWaitingIndicator(true);\n            if (this.showResult) {\n              if (this.originalFile) await this.openFileInEditor(this.originalFile, this.$refs.editor1);\n              if (this.originalFile && this.revisedFile) {\n                await this.loadComparedDocumentAndOpen(this.$refs.editor2, this.originalFile, this.revisedFile);\n              }\n            } else {\n              if (this.originalFile) await this.openFileInEditor(this.originalFile, this.$refs.editor1);\n              if (this.revisedFile) await this.openFileInEditor(this.revisedFile, this.$refs.editor2);\n            }\n            this.showHideWaitingIndicator(false);\n          }\n          else{\n            alert('This Compare Documents demo supports only DOCX and SFDT file formats. Please select a valid DOCX or SFDT document and try again.');\n          }\n        }\n        else{\n          alert('This Compare Documents demo supports only DOCX and SFDT file formats. Please select a valid DOCX or SFDT document and try again.');\n        }\n      }, 0);\n    },\n    \n    onDownload() {\n      if (this.$refs.editor2.ej2Instances.documentEditor) {\n        this.$refs.editor2.ej2Instances.documentEditor.save('Result', 'Docx');\n      }\n    },\n\n    getOriginalFileName() {\n      if (!this.originalFile) {\n        return 'Supported formats: SFDT, DOCX';\n      }\n\n      const size = Math.round(this.originalFile.size / 1024);\n      return `${this.originalFile.name} (${size} KB)`;\n    },\n\n    getRevisedFileName() {\n      if (!this.revisedFile) {\n        return 'Supported formats: SFDT, DOCX';\n      }\n\n      const size = Math.round(this.revisedFile.size / 1024);\n      return `${this.revisedFile.name} (${size} KB)`;\n    },\n\n    removeOriginalFile() {\n      this.originalFile = null;\n      this.compareClicked = false;\n    },\n\n    removeRevisedFile() {\n      this.revisedFile = null;\n      this.compareClicked = false;\n    },\n\n    showHideWaitingIndicator(show) {\n      let waitingPopUp = document.getElementById('waiting-popup');\n      let inActiveDiv = document.getElementById('popup-overlay');\n      if (waitingPopUp && inActiveDiv){\n        inActiveDiv.style.display = show ? 'block' : 'none';\n        waitingPopUp.style.display = show ? 'block' : 'none';\n      }\n    },\n\n    onToggleRevisionsPane() {\n      this.showRevisions = !this.showRevisions;\n      const editor2 = this.$refs.editor2.ej2Instances.documentEditor;      \n      if (editor2) {\n        editor2.showRevisions = this.showRevisions;\n      }\n    }\n\n  }\n};\n</script>\n\n<style>\n\n.overlay {\n    position: fixed;\n    top: 0;\n    left: 0;\n    width: 100vw;\n    height: 100vh;\n    background-color: rgba(56, 56, 56, 0.5);\n    z-index: 9999;\n    display: none;\n    cursor: not-allowed;\n}\n\n#waiting-popup {\n    width: 56px;\n    height: 56px;\n    position: fixed;\n    top: 50%;\n    left: 50%;\n    transform: translate(-50%, -50%);\n    border-radius: 50%;\n    padding: 3px;\n    background: white;\n    box-shadow: 0px 3px 6px rgba(0,0,0,.3);\n    z-index: 10000;\n    display: none;\n}\n\n\n.circular {\n    animation: rotate 2s linear infinite;\n    height: 50px;\n    width: 50px;\n    border-radius: 50%;\n}\n\n.circle-path {\n    stroke-dasharray: 1, 200;\n    stroke-dashoffset: 0;\n    animation: dash 1.5s ease-in-out infinite, color 6s ease-in-out infinite;\n    stroke-linecap: round;\n    stroke: #ff4081;\n}\n\n@keyframes rotate {\n    100% {\n        transform: rotate(360deg);\n    }\n}\n\n@keyframes dash {\n    0% {\n        stroke-dasharray: 1, 200;\n        stroke-dashoffset: 0;\n    }\n\n    50% {\n        stroke-dasharray: 89, 200;\n        stroke-dashoffset: -35;\n    }\n\n    100% {\n        stroke-dasharray: 89, 200;\n        stroke-dashoffset: -124;\n    }\n}\n\n\n[class^=\"sf-icon-\"], [class*=\" sf-icon-\"] {\nfont-family: 'Font Mail merge icon' !important;\ncolor: rgba(0, 0, 0, 0.54);\nfont-weight: 600;\nfont-size: 14px;\n}\n.sf-icon-FinishMerge:before { content: \"\\e700\"; }\n.sf-icon-InsertMergeField:before { content: \"\\e701\"; }\n\n\n\n[class^=\"e-de-icon-\"],\n[class*=\" e-de-icon-\"] {\n    font-family: 'Sample brower icons' !important;\n}\n\n.e-de-icon-Print:before {\n    content: \"\\e723\";\n}\n\n.e-de-icon-Download:before {\n    content: \"\\e728\";\n}\n</style>"
    }
  ]
}