Skip to content

BaseMultilineTextInput

A multiline textfield base component

Props

Prop nameDescriptionTypeValuesDefault
modelValueinput displayed in the textarea.
if tabs prop is set, this needs to be an object with properties corresponding to
tab names.
object|string-''
labelset the label for the input componentstring-''
showLabelset true if label should be visibleboolean-true
placeholderset input field placeholderstring-''
tabsset tabs for the input fieldarray-['default']
tabLabelsgive the possibility to specify what should be displayed in the tabsarray-[]
activeTabset the currently active tab (specify the property of the object not the label)string-''
tabsLegendset a legend for the tabs to be read (for accessibility only, hidden)string-'Radiogroup'
inputIdset id which is used for label + idstring|number-''
languageset a language (ISO 639-1)string-''
requiredmark as required field (currently only used for aria-required)boolean-false
invalidmark the form field as invalid and ideally also provide an error message
to display below the form field.
for an example see BaseInput
boolean-false
disabledset true if input field should be disabled.
for an example see BaseInput
boolean-false
errorMessageadd an error message to be displayed below form field if field is invalid.
for an example see BaseInput
string-''
showErrorIcondefine if error icon should be shown.
for an example see BaseInput
boolean-true
clearableif true a remove icon will be shown allowing to remove
all input at once.
for an example see BaseInput
boolean-false
assistiveTextprovide assistive text for screen readers
clearInput: text read for remove input icon if prop clearable is set true
object-{
clearInput: 'Clear input'
}

Events

Event namePropertiesDescription
update:model-valueundefined string, Object - the altered field inputEvent emitted on input, passing input string or input object

Slots

NameDescriptionBindings
label-additionto add drop down needed for text input field (base specific) or any other element deemed necessary
input-field-addition-beforeSlot to allow for additional elements in the input field <div> (before <input>)
input-field-addition-afterfor adding elements after input
post-input-fieldelements after the actual input element but within the input field container. for an example see BaseChipsInputField
error-iconuse a custom icon instead of standard error/warning icon. for an example see BaseChipsInputField
remove-iconuse a custom icon instead of standard remove icon. for an example see BaseChipsInputField

Demo

Basic example with no extra settings

Example with Tabs