Skip to content

Version 2.1

What it does

This plugin adds the functionality to create comments to Xeditor.

Installation

First you have to switch into your project location using the command line.

cd path/to/your/project

Now you should be in the same directory as the package.json file. Then you can install the plugin as follows:

npm install @xeditor/plugin-comment --save --registry https://npm.xeditor.com:4873

Configuration

The demo configuration of the plugin looks like this:

{
    pluginId: 'comment',
    ptype: 'uxxeditorcomment'
}

API

The API can be found here: Comment Plugin 2.1

Buttons

This plugin exports the following button templates that can be used in your toolbar configuration:

Name Function
button:xeditor.comment Creates new comment
button:xeditor.comment.previous Selects previous comment
button:xeditor.comment.next Selects next comment

Updating from Version 2.1

  • install new version using npm npm install --registry https://npm.xeditor.com

Changelog

v2.1.1

Bugfixes

  • Replying to comments will now set editor state to dirty

v2.1.0

Changes

  • Added feature to mark comments as read
  • Added toolbar button xeditor.comment.filterComments which enables to user to toggle display of read comments

Bugfixes

  • Fixed next/previous comment selection
  • Fixed word seperation bug
  • Adjusted the logic of Comment::getOffsetRangeBySelectionForCreate to fix comment boundary detection.
  • Fixed issue causing newly created comments to not be expanded, when the panel is enabled and expanded on inital load of Xeditor
  • Fixed escaping for reviewbar