jquery.dirtyforms.helpers.ckeditor

jquery.dirtyforms.helpers.ckeditor

This is a helper module for the jQuery Dirty Forms project.

Purpose

This helper causes Dirty Forms to read and/or update the dirty status from CKEditor instances on the form. This will ensure that when a user edits a CKEditor field, Dirty Forms will be notified of the event in order to mark the form dirty.

Prerequisites

Prerequesites must be included in this order:

• jQuery (>= 1.4.2)
• jquery.dirtyforms
• CKEditor

If you are using a Package Manager, these dependencies will be installed automatically, but depending on your environment you may still need to add references to them manually.

Download & Installation

There are several different ways to get the code. Some examples below:

CDN

The CKEditor helper is available over jsDelivr CDN and can directly included to every page.

<script type="text/javascript" src="//cdn.jsdelivr.net/jquery.dirtyforms/latest/jquery.dirtyforms.helpers.ckeditor.min.js"></script>

jsDelivr also supports on-the-fly concatenation of files, so you can reference only 1 URL to get jQuery, ckeditor, jquery.dirtyforms, and jquery.dirtyforms.helpers.ckeditor in one request.

<script type="text/javascript" src="//cdn.jsdelivr.net/g/jquery@1.11.4,ckeditor(ckeditor.js),jquery.dirtyforms(jquery.dirtyforms.min.js+jquery.dirtyforms.helpers.ckeditor.min.js)"></script>

Self-Hosted

Download and save one of two available files to include the CKEditor helper to your page, either the latest distribution or the latest minified version.

<script type="text/javascript" src="jquery.dirtyforms.helpers.ckeditor.min.js"></script>

You can also conveniently get all of the latest Dirty Forms files in one Zip Download.

Package Managers

The CKEditor helper is even available through NPM, Bower, and NuGet. Just use one of the following commands below to install the helper, including all dependencies.

// NPM
$ npm install jquery.dirtyforms.helpers.ckeditor

// Bower
$ bower install jquery.dirtyforms.helpers.ckeditor

// NuGet
PM> Install-Package jquery.dirtyforms.helpers.ckeditor

SourceMaps

A SourceMap file is also available via CDN or your favorite package manager.

####CDN

<script type="text/javascript" src="//cdn.jsdelivr.net/jquery.dirtyforms/latest/jquery.dirtyforms.helpers.ckeditor.min.js.map"></script>

Package Managers

NPM or Bower will install the file into the destination directory.

jquery.dirtyforms.helpers.ckeditor.min.js.map

For NuGet, this file is not included in the package, but you can get it from here if you really need it.

##Usage

This helper is completely automatic - there are no properties or methods to interact with. Simply include the reference to the helper after the prerequisites and use Dirty Forms as per the documentation and CKEditor as per the documetation.

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js" type="text/javascript"></script>
<script src="//cdn.jsdelivr.net/ckeditor/latest/ckeditor.min.js" type="text/javascript"></script>
<script src="//cdn.jsdelivr.net/jquery.dirtyforms/latest/jquery.dirtyforms.min.js" type="text/javascript"></script>
<script src="//cdn.jsdelivr.net/jquery.dirtyforms/latest/jquery.dirtyforms.helpers.ckeditor.min.js" type="text/javascript"></script>

If not using a CDN, you need to apply the dependencies in the same order as the example above.