Skip to content

Version 1.1

What it does

This plugin adds the functionality to create comments to Xeditor.


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


The demo configuration of the plugin looks like this:

    pluginId: 'comment',
    ptype: 'uxxeditorcomment'


The API for the plugin can be found here: comment plugin API


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 Selects next comment

Updating from Version 1.0

  • install new version using npm npm install --registry




  • added flag collapsItemsOutOfFrame for enabling/disabling the collapsing of comments that are out of frame. This only affects the comment panel.