Skip to content

Version 2.0

What it does

This plugin can be used for indenting/outdenting configured list item elements.

Installation

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

cd path/to/your/project

Then you can install the plugin as follows:

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

Configuration

The demo configuration of the plugin looks like this:

{
    pluginId: 'listfeatures',
    ptype: 'uxxeditorlistfeatures',
    paragraphType: 'p',
    enableContextMenu: true,
    lists: [{
        listType: 'list_ordered',
        itemType: 'list_item'
    }, {
        listType: 'list_unordered',
        itemType: 'list_item'
    }]
}

This results into the following: - when element list_item within list_ordered or list_unordered is selected, the indent and outdent button will be enabled (if possible, outdent is not enabled if element is already on first level) - as enableContextMenu config is set to true, also corresponding entries will be added to the context menu - triggering the action will indent/outdent the list_item element

Differences to version 1.0

The listfeatures plugin is now able to also indent/outdent multiple selected list items at once. In order to do so, just select multiple list items and use the indent/outdent buttons.

Updating from v1.0

In order to update the listfeatures plugin from version 1.0 to version 2.0, proceed as follows:

Install new Plugin

  • Open file package.json
  • Locate the listfeatures plugin contained by dependencies
  • Adjust version number: use '~2' instead of currently contained one
  • Run npm install --registry https://npm.xeditor.com:4873

API

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

Changelog

v2.0.0

Changes

  • Changed event parameter item of events listfeaturesbeforemove and listfeaturesbeforemove to items as plugin now able to move multiple items
  • Added config enableMultiMove to be able to deactivate moving of multiple items at once
  • Added own methods onEditorUpdateMenus and checkIndentOutdentEnabled overwriting super class to also enable in/outdent if multiple items selected
  • Removed method elementIsEmpty as not needed
  • Extended methods indent and outdent so those methods can handle moving multiple items at once (plus new result-object property multipleItemsMoved)
  • Added method getListItemsBySelection wich returns an array of listitems based on the current selection