The Text Area mobile component

Enter multiple lines of text.

A text area to enter multiple lines of text. It can perform validation of required fields, minimum or maximum length, and custom rules.

Properties

autoCapitalize

boolean

Whether to automatically capitalize text input when using a virtual keyboard.

autoResize

boolean

Whether the input field automatically grows with its content.

customValidation

string

A JavaScript conditional statement for custom validation logic. If the statement evaluates to a string, validation fails and it is rendered as the error message. An empty or nullish value is treated as valid input.

disabled

boolean

Whether user input, interaction, or selection is disabled.

formDataKey

string

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

hidden

boolean

Whether the component is visible.

hideValidationMessage

string

Whether to hide the validation message if the input is invalid.

id

string

The name of the component.

invalid

boolean

Whether the current value has failed any validation rules.

label

string

The input label.

labelCaption

string

The additional text to display with the label.

maxLength

number | null

The maximum length of text allowed.

maxLines

number | null

The maximum number of lines to display.

minLength

number | null

The minimum length of text allowed.

minLines

number | null

The minimum number of lines to display.

pattern

'email' | 'url' | 'regex' | null

The validation pattern to enforce.

placeholder

string

The placeholder text for the input.

pluginType

string

The component type.

required

boolean

Whether the input is required for validation.

validationMessage

string

The validation message to display if the input is invalid.

value

string

The value of the component.