Skip to content

Version 2.0

What it does

This plugin is used on footnotes or footnote like elements. Configured elements will collapse if not selected, and expand as soon as the cursor is placed in them.

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-footnote --save --registry https://npm.xeditor.com:4873

Configuration

The demo configuration of the plugin looks like this:

{
    pluginId: 'footnote',
    ptype: 'uxxeditorfootnote',
    elementTypes: ['footnote']
}

This results into the following: - when element footnote is not selected, it will collapse and its content will be hidden - when element footnote is selected, it will expand and its content will be shown

API

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

Buttons

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

Button Action
'button:xeditor.footnote.togglestate' Toggles collapse/expand of all footnotes

Differences to version 1.0

  • Introduces additional button xeditor.footnote.togglestate. When active, all footnotes will be expanded, regardless of current selection. Otherwise, only selected footnote will be expanded.
  • Updated to work with Xeditor core v6.

Changelog

v2.0.0

Changes

  • Changed toolbarType to type
  • Adapted usage of BasicElement.addClass and BasicElement.removeClass to new Methods Basic.Element.addClasses and Basic.Element.removeClasses