Plugin System

Jodit plugins are designed to extend the basic functionality of the editor.
There are built-in plugins, without which the editor will not work correctly. There are plugins that add completely new functionality.
You can write your own plugin that will either change the current behavior of the editor or add a new function.

Plugins can be both simple functions and complex classes.

In the simplest case, it's just a function that receives a Jodit instance as input.

Jodit.plugins.add('alertMyId', jodit => {
  alert(jodit.id);
});

The moment you create an instance of Jodit, all plugins are initialized.

const editor = Jodit.make('#editorId'); // alert('editorId')

This is usually not what you expect. You probably want the plugin to take action on certain events.
The EventEmiter editor will help you with this.

Jodit.plugins.add('keyLogger', jodit => {
  jodit.events.on('keydown', e => {
    sendAnalytics('keydown', e.key);
  });
});

As mentioned above, plugins can be more complex than just a function. A plugin can be a class:

class resizeEditor {
  hasStyle = true;

  buttons = [
    {
      name: 'custom',
      group: 'other'
    }
  ];

  static requires = ['enter', 'drag-and-drop'];

  init(jodit: IJodit): void {
    jodit.events.on('afterInit', () => {
      Jodit.ns.Helpers.css(jodit.editor, {
        width: 400
      });
    });
  }

  destruct() {
    Jodit.ns.Helpers.css(this.jodit.editor, {
      width: null
    });
  }
}

Jodit.plugins.add('resizeEditor', resizeEditor); // Constructor, not instance

hasStyle

  • Type: boolean
  • Default: false

Jodit will try to load the styles along the same path as the plugin is loaded.

buttons

  • Type: Array
  • Default: []
export interface IPluginButton {
  name: string;
  group?: ButtonGroup;
  position?: number;
  options?: IControlType;
}

export type ButtonGroup =
  | string
  | 'source'
  | 'font-style'
  | 'script'
  | 'list'
  | 'indent'
  | 'font'
  | 'color'
  | 'media'
  | 'state'
  | 'clipboard'
  | 'insert'
  | 'history'
  | 'search'
  | 'other'
  | 'info';

Buttons to be automatically added to the editor's button groups.
Those. If the plugin is connected, the button will appear in the list, if not connected, it will disappear.

Jodit.defaultOptions.controls.insertTime = {
  icon: require('./icon.svg'),
  tooltip: 'Insert Time',
  exec: (editor: IJodit) => {
    editor.s.insertHTML(new Date().toTimeString());
    editor.synchronizeValues(); // For history module we need to synchronize values between textarea and editor
  }
};

class insertTimePlugin {
  buttons = [
    {
      name: 'insertTime',
      group: 'insert'
    }
  ];
}

Jodit.plugins.add('insertTimePlugin', insertTimePlugin);

In the exec method we insert the current time into the editor.
At the same time, if we disable the plugin, the button will disappear from the list.

Note that after insertion we call the synchronizeValues method, which synchronizes the values between the textarea and the editor.

This is necessary for the history module to work correctly, since the editor does not use MutationObserver to track changes internally.

We may move to MutationObserver in the future, but until that happens, you need to call synchronizeValues yourself after inserting content to the editor.

static requires

  • Type: Array
  • Default: []

If your plugin depends on other plugins, then it must be initialized after them.

Debug

Since version 3.12.4 you can disable all Jodit plugins during development and work only with your own plugin.
This will allow you to find out if it works correctly and if it breaks the behavior of the editor or if it is caused by other plugins.

Jodit.make('#editor', {
  safeMode: true,
  safePluginsList: ['about'],
  extraPlugins: ['yourPluginDev']
});

Classes

Interfaces

Previous
Contributing guide
Next
Modules