Install/Enable Plugins

CKeditor Builder Install

The easiest way to install plugins is to add them to the build when downloading the ckeditor.

The build can be configure on the build page. When this method is  used, all the dependencies will be automatically resolved for us.

CKeditor Manual Install

The second way is to manually install the desired plugin. However, we'll have to check the plugin dependencies and download the dependent plugins as well.

 

The plugins should be copied to the plugins directory of ckeditor. /path/to/[ckeditor folder]/plugins. If the name of the plugin is language, then the plugin would be placed in /path/to/[ckeditor folder]/plugins/language.

Enable Plugin

The CKEDITOR.config.extraPlugins is used to enable addon plugins.

 
Method #1: Enabling via a config file.

The module can be enabled in the default config.js file located in the root ckeditor folder. Or in a custom config file that we defined.

//a configuration file such as the config.js file
//in the root ckeditor directory
//or a custom config file that we will load
CKEDITOR.editorConfig = function( config ) {

  //specify a comma separated list of plugins to enable.
  config.extraPlugins = 'myplugin1, myplugin2, myplugin3';
};
 
Method #2: Enabling Inline

We could also enable the plugins when we instantiate a ckeditor.

CKEDITOR.replace( 'editor1', {
  extraPlugins : 'myplugin1,myplugin2,myplugin3'
} );

 

Cookbook Category: 

Add new comment