This is archived documentation for Magento v2.2 and is no longer supported. Go to the latest documentation.

Textarea component

The Textarea component implements the <textarea> form field.

Configuration options

Option Description Type Default
cols The number of columns that will be specified in the cols attribute of the textarea DOM element. Number 15
component The path to the component’s .js file in terms of RequireJS. String 'Magento_Ui/js/form/element/textarea'
elementTmpl The path to the .html template of the particular type of field (textarea). String 'ui/form/element/textarea'
label Label to be displayed in the field. String ''
rows The number of rows that will be specified in the rows attribute of the textarea DOM element. Number 2
template The path to the general field .html template. String 'ui/form/field'

Source files

Extends Abstract:

Examples

Integrate the Textarea component with the Form component

This example integrates the Textarea component with the Form component.

1
2
3
4
5
6
7
8
9
10
11
12
13
<form>
    ...
    <fieldset>
        ...
        <textarea name="textarea_example">
            <settings>
                <cols>15</cols>
                <rows>5</rows>
                <label translate="true">Textarea Field Example</label>
            </settings>
        </textarea>
    </fieldset>
</form>

Result

Textarea Component example