# Textarea (fw-textarea)

fw-textarea displays an input box on the user interface and enables assigning multi-line text value to it. The size of the input box is based on the cols and rows attributes.

# Usage

Show Code

# Properties

Property Attribute Description Type Default
autofocus autofocus If true, the textarea is autofocused boolean false
cols cols Width of the input box, specified as number of columns. number undefined
disabled disabled Disables the text area on the interface. If the attribute’s value is undefined, the value is set to false. boolean false
label label Label displayed on the interface, for the component. string ''
maxlength maxlength Maximum number of characters a user can enter in the input box. number undefined
minlength minlength Minimum number of characters a user must enter in the input box for the value to be valid. number undefined
name name Name of the component, saved as part of form data. string ''
placeholder placeholder Text displayed in the input box before a user enters a value. string undefined
readonly readonly If true, the user cannot enter a value in the input box. If the attribute’s value is undefined, the value is set to false. boolean false
required required Specifies the input box as a mandatory field and displays an asterisk next to the label. If the attribute’s value is undefined, the value is set to false. boolean false
rows rows Height of the input box, specified as number of rows. number undefined
state state Theme based on which the input box is styled. "error" or "normal" or "warning" 'normal'
stateText state-text Descriptive or instructional text displayed below the input box. string ''
value value Default value displayed in the input box. string ''
wrap wrap Type of text wrapping used by the input box. If the value is hard, the text in the textarea is wrapped (contains line breaks) when the form data is saved. If the value is soft, the text in the textarea is saved as a single line, when the form data is saved. "hard" or "soft" 'soft'

# Events

Event Description Type
fwBlur Triggered when the input box loses focus. CustomEvent<void>
fwChange Triggered when the value in the input box is modified. CustomEvent<any>
fwFocus Triggered when the input box comes into focus. CustomEvent<void>
fwInput Triggered when a value is entered in the input box. CustomEvent<KeyboardEvent>

# Methods

# setFocus() => Promise<void>

Sets focus on a specific fw-textarea. Use this method instead of the global input.focus().

# Returns

Type: Promise<void>


Built with ❤ at Freshworks

Last Updated: 9/15/2020, 10:34:26 AM