The ckeditor field.

The CK Editor field renders the CK editor control that allows users to visually work with HTML and save the results back into a text property.

Properties

Title	CK Editor
Description	Provides an instance of a CK Editor control for use in editing HTML.
JSON Schema Type(s)	string
Field Type	ckeditor
Base Field Type	textarea

Schema

Property	Type	Default	Description
default	any		The default value to be assigned for this property. If the data for the field is empty or not provided, this default value will be plugged in for you. Specify a default value when you want to pre-populate the field's value ahead of time.
dependencies	array		List of property dependencies.
description	string		Detailed description of the property.
disallow	array		List of disallowed values for the property.
enum	array		List of specific values for this property
format	string		Data format of the property.
maxLength	number		Maximum length of the property value.
minLength	number		Minimal length of the property value.
pattern	string		Regular expression for the property value.
readonly	boolean		Indicates that the field is read-only. A read-only field cannot have it's value changed. Read-only fields render in a grayed-out or disabled control. If the field is rendered using a view with the displayReadonly attribute set to false, the read-only field will not appear.
required	boolean		Indicates whether the field's value is required. If set to true, the field must take on a valid value and cannnot be left empty or unassigned.
title	string		Short description of the property.
type	string	string	Data type of the property.

Options

Property	Type	Default	Description
allowOptionalEmpty			Allows this non-required field to validate when the value is empty
autocomplete	string		Allows you to specify the autocomplete attribute for the underlying input control whether or not field should have autocomplete enabled.
ckeditor	any		Use this entry to provide configuration options to the underlying CKEditor plugin.
cols	number	40	Number of columns
data	object		Allows you to specify a key/value map of data attributes that will be added as DOM attribuets for the underlying input control. The data attributes will be added as data-{name}='{value}'.
disabled	boolean		Field will be disabled if true.
disallowEmptySpaces	boolean		Whether to disallow the entry of empty spaces in the text
disallowOnlyEmptySpaces	boolean		Whether to disallow the entry of only empty spaces in the text
fieldClass	string		Specifies one or more CSS classes that should be applied to the dom element for this field once it is rendered. Supports a single value, comma-delimited values, space-delimited values or values passed in as an array.
focus	checkbox	true	If true, the initial focus for the form will be set to the first child element (usually the first field in the form). If a field name or path is provided, then the specified child field will receive focus. For example, you might set focus to 'name' (selecting the 'name' field) or you might set it to 'client/name' which picks the 'name' field on the 'client' object.
form	object		Options for rendering the FORM tag.
helper	string		Field help message.
helpers	array		An array of field help messages. Each message will be displayed on it's own line.
helpersPosition	string	below	Defines the placement location of the helper text relative to the control (either 'above' or 'below')
hidden	boolean		Field will be hidden if true.
hideInitValidationError	boolean		Hide initial validation errors if true.
id	string		Unique field id. Auto-generated if not provided.
inputType	string		Allows for the override of the underlying HTML5 input type. If not specified, an assumed value is provided based on the kind of input control (i.e. 'text', 'date', 'email' and so forth)
label	string		Field label.
maskString	string		Expression for the field mask. Field masking will be enabled if not empty.
name	string		Field Name.
optionLabels	array		An array of string labels for items in the enum array
placeholder	string		Field placeholder.
readonly	boolean		Field will be readonly if true.
rows	number	5	Number of rows
showMessages	boolean	true	Display validation messages if true.
size	number	40	Field size.
sort	function		Defines an f(a,b) sort function for the array of enumerated values [{text, value}]. This is used to sort enum and optionLabels as well as results that come back from any data sources (for select and radio controls). By default the items are sorted alphabetically. Don't apply any sorting if false.
type	string	ckeditor	Field type.
typeahead			Provides configuration for the $.typeahead plugin if it is available. For full configuration options, see: https://github.com/twitter/typeahead.js
validate	boolean	true	Field validation is required if true.
view	string		Allows for this field to be rendered with a different view (such as 'display' or 'create')
wordlimit	number	-1	Limits the number of words allowed in the text area.

Requirements

The CK Editor field depends on the CKEditor library. You can acquire this library from http://www.ckeditor.com. This must be included in your page ahead of the control loading in order for this to work properly.

Example 1

A full example of the CK Editor at work. This has a lot of buttons. The point here is to show how it looks in full. In the examples that follow, we'll trim this down.

Example 2

Here is a simplified version of the CK Editor with many of the buttons removed.

A full example of the CK Editor at work. This has a lot of buttons. The point here is to show how it looks in full. In the examples that follow, we'll trim this down.

Example 3

Here we bind multiple CK Editors into the same form.

Example 4

An example where we set the value after render.