Markdown Editor Field
The markdown field.
The Markdown Editor field renders the SimpleMDE Markdown editor control that allows users to visually work with Markdown.
Properties
| Title | Markdown |
| Description | Provides an instance of a Markdown Editor control for use in editing HTML |
| Field Type | markdown |
| Base Field Type | textarea |
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 |
|---|---|---|---|
| cols | number | 40 | Number of columns |
| markdown | any | Use this entry to provide configuration options to the underlying Markdown plugin. | |
| name | string | Field Name. | |
| rows | number | 5 | Number of rows |
| 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. | |
| wordlimit | number | -1 | Limits the number of words allowed in the text area. |
Requirements
The Markdown Editor field depends on the SimpleMDE Markdown Editor library. You can acquire this library from https://simplemde.com/. This must be included in your page ahead of the control loading in order for this to work properly. Check out more configurable options here https://github.com/sparksuite/simplemde-markdown-editor/.
Example 1
An example of a SimpleMDE Markdown field with a custom toolbar.
Example 2
An example of a SimpleMDE Markdown field with auto-focus and auto-save enabled.
Example 3
An example of a SimpleMDE Markdown field with spellChecker disabled.
Example 4
A SimpleMDE Markdown field with a button so that you can pull back the resulting JSON.