Summernote Editor Field
The summernote field.
The Summernote Editor field renders the Summernote editor control that allows users to visually work with HTML and save the results back into a text property.
Properties
| Title | Summer Note Editor |
| Description | Provides an instance of a Summernote Editor control for use in editing HTML. |
| Field Type | summernote |
| Base Field Type | text |
Schema
| 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. | |
| 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}'. | |
| 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 | |
| enum | array | List of specific values for this property | |
| 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) | |
| maskString | string | Expression for the field mask. Field masking will be enabled if not empty. | |
| placeholder | string | Field placeholder. | |
| size | number | 40 | Field size. |
| trim | boolean | Remove whitespace from the beginning and end of string | |
| typeahead | Provides configuration for the $.typeahead plugin if it is available. For full configuration options, see: https://github.com/twitter/typeahead.js |
Options
| Property | Type | Default | Description |
|---|---|---|---|
| name | string | Field Name. | |
| 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. | |
| summernote | any | Use this entry to provide configuration options to the underlying Summernote plugin. |
Requirements
The Summernote Editor field depends on the Summernote Editor library. You can acquire this library from http://summernote.org/. 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 Summernote 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 Summernote Editor with many of the buttons removed.
Example 3
Here we bind multiple Summernote Editors into the same form.