Textarea

Textarea components are used for collecting large amounts of textual data.

Usage

A multi-line text-field is useful for larger amounts of text.

API

v-textarea
Name
append-icon
Default
undefined
Type
string

Appends an icon to the component, uses the same syntax as v-icon

Name
append-outer-icon New in — v1.1
Default
undefined
Type
string

Appends an icon to the outside the component's input, uses same syntax as v-icon

Name
auto-grow
Default
false
Type
boolean

Automatically grow the textarea depending on amount of text

Name
autofocus
Default
false
Type
boolean

Enables autofocus

Name
background-color
Default
undefined
Type
string

Changes the background-color of the input

Name
box
Default
false
Type
boolean

Applies the alternate box input style

Name
browser-autocomplete
Default
undefined
Type
string

Configures the default <input> autocomplete attribute

Name
clear-icon
Default
'$vuetify.icons.clear'
Type
string

Applied when using clearable and the input is dirty

Name
clearable
Default
false
Type
boolean

Add input clear functionality, default icon is Material Icons clear

Name
color
Default
'primary'
Type
string

Applies specified color to the control - it can be the name of material color (for example success or purple) or css color (#033 or rgba(255, 0, 0, 0.5))

Name
counter
Default
undefined
Type
boolean | number | string

Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.

Name
dark
Default
false
Type
boolean

Applies the dark theme variant

Name
disabled
Default
false
Type
boolean

Disable the input

Name
dont-fill-mask-blanks
Default
false
Type
boolean

Disables the automatic character display when typing

Name
error
Default
false
Type
boolean

Puts the input in a manual error state

Name
error-count
Default
1
Type
number | string

The total number of errors that should display at once

Name
error-messages
Default
[]
Type
string | array

Puts the input in an error state and passes through custom error messsages. Will be combined with any validations that occur from the rules prop. This field will not trigger validation

Name
flat
Default
false
Type
boolean

Removes elevation (shadow) added to element when using the solo or solo-inverted props

Name
full-width
Default
false
Type
boolean

Designates input type as full-width

Name
height
Default
undefined
Type
number | string

Sets the component height

Name
hide-details
Default
false
Type
boolean

Hides hint, validation errors

Name
hint
Default
undefined
Type
string

Hint text

Name
label
Default
undefined
Type
string

Sets input label

Name
light
Default
false
Type
boolean

Applies the light theme variant

Name
loading
Default
false
Type
boolean | string

Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - primary, secondary, success, info, warning, error) or a Boolean which uses the component color (set by color prop - if it's supported by the component) or the primary color

Name
mask
Default
undefined
Type
object | string

Apply a custom character mask to the input. See mask table below for more information

Name
messages
Default
[]
Type
string | array

Displays a list of messages or message if using a string

Name
no-resize
Default
false
Type
boolean

Remove resize handle

Name
outline
Default
false
Type
boolean

Applies the outline style to the input

Name
persistent-hint
Default
false
Type
boolean

Forces hint to always be visible

Name
placeholder
Default
undefined
Type
string

Sets the input’s placeholder text

Name
prefix
Default
undefined
Type
string

Displays prefix text

Name
prepend-icon
Default
undefined
Type
string

Prepends an icon to the component, uses the same syntax as v-icon

Name
prepend-inner-icon New in — v1.1
Default
undefined
Type
string

Prepends an icon inside the component's input, uses the same syntax as v-icon

Name
readonly
Default
false
Type
boolean

Puts input in readonly state

Name
return-masked-value
Default
false
Type
boolean

Returns the unmodified masked string

Name
reverse New in — v1.1
Default
false
Type
boolean

Reverses the input orientation

Name
row-height
Default
24
Type
number | string

Height value for each row

Name
rows
Default
5
Type
number | string

Default row count

Name
rules
Default
[]
Type
array

Accepts an array of functions that return either True or a String with an error message

Name
single-line
Default
false
Type
boolean

Label does not move on focus/dirty

Name
solo
Default
false
Type
boolean

Changes the style of the input

Name
solo-inverted
Default
false
Type
boolean

Reduces element opacity until focused

Name
success New in — v1.1
Default
false
Type
boolean

Puts the input in a manual success state

Name
success-messages New in — v1.1
Default
[]
Type
string | array

Puts the input in a success state and passes through custom success messsages.

Name
suffix
Default
undefined
Type
string

Displays suffix text

Name
type
Default
'text'
Type
string

Sets input type

Name
validate-on-blur
Default
false
Type
boolean

Delays validation until blur event

Name
value
Default
undefined
Type
any

Input value

Examples

Auto grow

Textarea can automatically resize when entered text exceeds its size.

Beautiful Forms

Utilizing alternative input styles, you can create amazing interfaces that are easy to build and easy to use.

Edit this page | language on Github