Skip to content
On this page

VTextArea

Props

NameTypeDescription
success-textstringThe success text for the form element.
helper-textstringThe helper text for the form element.
char-countbooleanWhether to show the character count.
error-textstringThe error text for the form element.
labelstringThe label for the form element.
aria-currentEnum:
page
step
location
date
time
true
false
Indicates the element that represents the current item within a container or set of related elements.
disabledbooleanSets the element's disabled state. A disabled element will not be included during form submission.
initial-valuestringThe initial value of the form. This value sets the value property only when the value property has not been explicitly set.
valuestringThe current value of the element. This property serves as a mechanism to set the value property through both property assignment and the .setAttribute() method. This is useful for setting the field's value in UI libraries that bind data through the .setAttribute() API and don't support IDL attribute binding.
requiredbooleanRequire the field to be completed prior to form submission.
read-onlybooleanWhen true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly
resizeEnum:
none
both
horizontal
vertical
The resize mode of the element.
autofocusbooleanIndicates that this element should get focus after the page finishes loading.
formstringThe https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id
liststringAllows associating a https://developer.mozilla.org/en-US/docs/Web/HTML/Element/datalist
maxlengthnumberThe maximum number of characters a user can enter.
minlengthnumberThe minimum number of characters a user can enter.
namestringThe name of the element.
placeholderstringSets the placeholder value of the element, generally used to provide a hint to the user.
colsnumberSizes the element horizontally by a number of character columns.
rowsnumberSizes the element vertically by a number of character rows.
spellcheckbooleanSets if the element is eligible for spell checking but the UA.
wrapEnum:
hard
soft
off
The wrap attribute

Events

NameEvent TypeDescription
clickMouseEventFires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
focusFocusEventFires when the element receives focus.
blurFocusEventFires when the element loses focus.
keydownKeyboardEventFires when a key is pressed.
keyupKeyboardEventFires when a key is released.
inputEventFires when the value of an element has been changed.
changeCustomEvent<undefined>Emits a custom 'change' event when the textarea emits a change event

Slots

NameDescription
helper-textDescribes how to use the text-area. Alternative to the helper-text attribute.

Methods

NameTypeDescription
select() => voidSelects all the text in the text area
validate() => void{@inheritDoc (FormAssociated:interface).validate}