Text Area Field

The textarea field is used to represent text within a form.


Title Text Area
Description Textarea field for multiple line text
Field Type textarea
Base Field Type text


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


Property Type Default Description
cols number 40 Number of columns
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.

Example 1

A simple textarea field with a string of text.

{% raw %} {% endraw %}

Example 2

Textarea field with options parameter.

{% raw %} {% endraw %}

Example 3

Textarea field rendered in display-only mode.

{% raw %} {% endraw %}

Example 4

This example uses the placeholder option to set up the placeholder text for a text area field.

{% raw %} {% endraw %}

Example 5

This example overrides the view property on the field to have just the single field render in an alternate, display-only view.

{% raw %} {% endraw %}