Skip to content

Document highlighting comments by author feature #4555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
suriyaprakasamr wants to merge 2 commits into
base: development
Choose a base branch
from
+29 −0
Open

Document highlighting comments by author feature #4555

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76b2d26
Document highlighting comments by author feature
suriyaprakasamr Sep 4, 2026
d351975
Update comments documentation with reviewed API
suriyaprakasamr Sep 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions Document-Processing/Word/Word-Processor/vue/comments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,35 @@ The following example illustrates how to enable mention support in the DOCX Edit

> The Web API hosted link `https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/` utilized in the DOCX Editor's serviceUrl property is intended solely for demonstration and evaluation purposes. For production deployment, please host your own web service with your required server configurations. You can refer and reuse the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server) for hosting your own web service and use for the serviceUrl property.

## Highlight comments by author

When `highlightCommentsByAuthor' is enabled, each comment marker and pane border is displayed in the author’s avatar color. Selecting a comment highlights the corresponding text in that color. If multiple comments appear on the same line, the marker retains the first author’s avatar color.

The following example illustrates how to enable comment highlights in the DOCX Editor

```
<template>
<div id="app">
<ejs-documenteditorcontainer ref='documenteditor' :serviceUrl='serviceUrl' :documentEditorSettings='settings' height="590px" id='container' :enableToolbar='true'></ejs-documenteditorcontainer>
</div>
</template>
<script>
import { DocumentEditorContainerComponent, Toolbar } from '@syncfusion/ej2-vue-documenteditor';
export default {
data() {
return {
serviceUrl:'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/',
settings: { commentSettings: { highlightCommentsByAuthor : true } }
},
},
provide: {
//Inject require modules.
DocumentEditorContainer: [Toolbar]
}
}
</script>
```

## Events

DocumentEditor provides [beforeCommentAction](https://ej2.syncfusion.com/vue/documentation/api/document-editor#beforecommentaction) event, which is triggered on comment actions like Post, edit, reply, resolve and reopen. This event provides an opportunity to perform custom logic on comment actions like Post, edit, reply, resolve and reopen. The event handler receives the [CommentActionEventArgs](https://ej2.syncfusion.com/vue/documentation/api/document-editor/commentActionEventArgs) object as an argument, which allows access to information about the comment.
Expand Down