CKEDITOR_Adapters.jQuery

Properties

• editor : editorCKEDITOR_Adapters.jQuery#editor

  See source

  Existing CKEditor instance. Allows to easily use the internal API.

  Note: This is not a jQuery object.

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

• promise : FunctionCKEDITOR_Adapters.jQuery#promise

  See source

  The jQuery Promise object that handles the asynchronous constructor. This promise will be resolved after all of the constructors.

Methods

• chainable

  ckeditor( callback, config ) → ObjectCKEDITOR_Adapters.jQuery#ckeditor

  See source

  A jQuery function which triggers the creation of CKEditor with <textarea> and editable elements. Every <textarea> element will be converted to a classic (iframe-based) editor, while any other supported element will be converted to an inline editor. This method binds the callback to the instanceReady event of all instances. If the editor has already been created, the callback is fired straightaway. You can also create multiple editors at once by using $( '.className' ).ckeditor();.

  Note: jQuery chaining and mixed parameter order is allowed.

  Parameters

  callback : Function

  Function to be run on the editor instance. Callback takes the source element as a parameter.

  $( 'textarea' ).ckeditor( function( textarea ) {
      // Callback function code.
  } );
  

  config : Object

  Configuration options for new instance(s) if not already created.

  $( 'textarea' ).ckeditor( {
      uiColor: '#9AB8F3'
  } );
  

  Returns

  Object

  jQuery.fn

  deprecated

  ckeditorGet() → ObjectCKEDITOR_Adapters.jQuery#ckeditorGet

  See source

  Returns an existing CKEditor instance for the first matched element. Allows to easily use the internal API. Does not return a jQuery object.

  Raises an exception if the editor does not exist or is not ready yet.

  Returns

  Object

  CKEDITOR.editor

  val() → ObjectCKEDITOR_Adapters.jQuery#val

  See source

  Overwritten jQuery val() method for <textarea> elements that have bound CKEditor instances. This method gets or sets editor content by using the editor.getData() or editor.setData() methods. To handle the editor.setData() callback (as setData is asynchronous), val( 'some data' ) will return a jQuery Promise object.

  Returns

  Object

  String|Number|Array|jQuery.fn|function(jQuery Promise)

  Events

  • dataReady( evt )CKEDITOR_Adapters.jQuery#dataReady

    See source

    Forwards the CKEditor dataReady event as a jQuery event.

    Parameters

    evt : eventInfo

  • destroy( evt )CKEDITOR_Adapters.jQuery#destroy

    See source

    Forwards the CKEditor destroy event as a jQuery event.

    Parameters

    evt : eventInfo

  • getData( evt )CKEDITOR_Adapters.jQuery#getData

    See source

    Forwards the CKEditor getData event as a jQuery event.

    Parameters

    evt : eventInfo

  • instanceReady( evt )CKEDITOR_Adapters.jQuery#instanceReady

    See source

    Forwards the CKEditor instanceReady event as a jQuery event.

    Parameters

    evt : eventInfo

  • setData( evt )CKEDITOR_Adapters.jQuery#setData

    See source

    Forwards the CKEditor setData event as a jQuery event.

    Parameters

    evt : eventInfo