Custom Plugins

Creating a Plugin

Plugins must be added as a property of the sceditor.plugins.* object.

For example to create a plugin called myplugin it would be:

// Created in sceditor.plugins.[name] object
sceditor.plugins.myplugin = function() {
	// Place signal handlers and functions here
};

To then enable the plugin in the editor, add myplugin to the plugins option when creating the editor.

Important: When creating a custom plugin, it must be done before creating an instance of the editor, e.g. before calling sceditor.create().

Handling Signals

To create a signal handler, just create a function with the name of the signal and it will automatically be called whenever that signal is raised.

e.g.

sceditor.plugins.myplugin = function() {
	base.signalKeydownEvent = function(e) {
		// this will automatically be called when 'myplugin'
		// is registered with an editor instance and there
		// is a keydown event
	};
};

All signals will have this set to the editor instance that the plugin applies to.

init

Called when the plugin is registered to the editor.

destroy

Called when destroy() is called on the editor or the plugin is removed from the editor.

This signal should be used to unbind any DOM events and to do any clean up so that any memory used can be freed by the browser.

signalReady

Called after the editor is created.

Important: This can be called before the page fully loaded.