Skip to content

api_textarea_properties.md

Latest commit

 

History

History
156 lines (144 loc) · 5.94 KB

api_textarea_properties.md

File metadata and controls

156 lines (144 loc) · 5.94 KB
sidebar_label Form Textarea properties
title JavaScript Form - Textarea Properties
description You can explore the Properties of the Textarea control of Form in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite.

Textarea properties

Usage

{
    type: "textarea",
    name?: string,
    id?: string, // must be unique if set, auto-generated if not set
    value?: string,
    
    css?: string,
    disabled?: boolean, // false by default
    height?: string | number | "content", // "content" by default
    hidden?: boolean, // false by default
    padding?: string | number, 
    required?: boolean, // false by default
    validation?: string | (input: string | number) => boolean,
    width?: string | number | "content", // "content" by default

    maxlength?: number | string,
    minlength?: number | string,
    placeholder?: string, 
    readOnly?: boolean, // false by default
    resizable?: boolean, // false by default

    hiddenLabel?: boolean, // false by default
    label?: string,
    labelPosition?: "left" | "top", // "top" by default
    labelWidth?: string | number,

    helpMessage?: string,
    preMessage?: string,
    successMessage?: string,
    errorMessage?: string,
}

Description

type (required) the type of a control, set it to "textarea"
name (optional) the name of a control
id (optional) the id of a control, must be unique if set, auto-generated if not set
value (optional) the initial value of the textarea
css (optional) adds style classes to a control
disabled (optional) defines whether a control is enabled (false) or disabled (true), false by default
height (optional) the height of a control, "content" by default
hidden (optional) defines whether a control is hidden, false by default
padding (optional) sets padding between a cell and a border of the Textarea control
required (optional) defines whether a control is required, false by default
validation (optional) the rule of input validation. Can be set in two ways:
  • as a predefined string value:
      - "email" - validEmail
      - "integer" - validInteger
      - "numeric" - validNumeric
      - "alphanumeric" - validAplhaNumeric
      - "IPv4" - validIPv4
  • as a function that defines a custom validation rule. It takes as a parameter the value typed in the input and returns true, if the entered value is valid.
width (optional) the width of a control, "content" by default
maxlength (optional) the maximum number of characters allowed in the textarea
minlength (optional) the minimum number of characters allowed in the textarea
placeholder (optional) a tip for the textarea
readOnly (optional) defines whether a textarea is readonly, false by default
resizable (optional) adds a resizer icon into a textarea, if set to true, false by default
hiddenLabel (optional) makes the label invisible, false by default
label (optional) specifies a label for a control
labelPosition (optional) defines the position of a label: "left" | "top", "top" by default
labelWidth (optional) sets the width of the label of a control
helpMessage (optional) adds a help message to a control
preMessage (optional) a message that contains instructions for interacting with the control
successMessage (optional) a message that appears in case of successful validation of the control value
errorMessage (optional) a message that appears in case of error during validation of the control value

Example

<iframe src="https://snippet.dhtmlx.com/mt93jzrk?mode=js" frameborder="0" class="snippet_iframe" width="100%" height="650"></iframe>

Related article: Textarea