jQuery Adapter

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

CKEditor offers native jQuery integration through its jQuery Adapter (a jQuery plugin basically). It provides deep integration of CKEditor into jQuery, using its native features.

Creating Editor Instances

In order to create editor instances, load the usual CKEditor core script file as well as the jQuery Adapter file, in the following order:

<script type="text/javascript" src="/ckeditor/ckeditor.js"></script>
<script type="text/javascript" src="/ckeditor/adapters/jquery.js"></script>

At this point any textarea, p, or div element can be transformed into a rich text editor by using the ckeditor() method.

$( 'textarea.editor' ).ckeditor();

Note that you can also make use of the jQuery chaining.

$( '.section-x' )
    .find( 'textarea.editor' )
    .find( 'a' )
        .addClass( 'mylink' )

The ckeditor() method is the main method of the jQuery adapter. It accepts two optional parameters:

  • A callback function to be executed when the editor is ready.
  • Configuration options specific to the created editor instance.

The configuration options are passed through a simple object that contains properties, each one related to a specific editor setting.

    .ckeditor( function() { /* callback code */ }, { skin : 'office2003' } )
    .ckeditor( callback2 );

The code presented above will not create two editors. On discovering that one editor is already being created, it will wait with the second callback. Each of the callback functions will be executed in the context of the CKEDITOR.editor object (so this will be the editor) and the DOM element object will be passed as parameter.

Code Interaction with Editor Instances

When an editor instance is ready (after the callback call demonstrated above), the ckeditorGet() method can be used to retrieve the CKEDITOR.editor object that represents an editor instance. For example:

var editor = $('.jquery_ckeditor').ckeditorGet();
alert( editor.checkDirty() );

Because setting and retrieving the editor data is a common operation, the jQuery Adapter also provides a dedicated val() method that is an extension of the original jQuery val() method. This method works exactly the same as the jQuery version, but additionally it allows to get and set the editor contents.

// Get the editor data.
var data = $( 'textarea.editor' ).val();
// Set the editor data.
$( 'textarea.editor' ).val( 'my new content' );

This feature can be disabled by setting CKEDITOR.config.jqueryOverrideVal to false before loading the adapter code.

For <textarea> elements the editor will automatically return its content back to the form when it is submitted. CKEditor also automatically works with the official jQuery Form Plugin for AJAX based forms. It does not require any action from the developer's side to support it.

Event handling

Although CKEditor uses its own event system, there are four main events which are being exposed to the jQuery event system. All events use the event namespace, which is simply named .ckeditor.

The following events are available:

  • instanceReady.ckeditor – fired when the editor is created, but before any callback is being passed to the ckeditor() method.
  • setData.ckeditor – fired when data is set in the editor.
  • getData.ckeditor – fired when data is fetched from the editor. The current editor data is also passed in the arguments.
  • destroy.ckeditor – fired when the editor gets destroyed. It can be used, for example, to execute some cleanup code on the page.

The editor instance is always passed as the first data argument for the listener. Both getData and setData are often used internally, so listening to them should be done with care.

jQuery events do bubble up through the DOM, so they can be listened to selectively in certain parts of the document.

This page was last edited on 10 March 2011, at 15:14.