Text field

Text fields components are used for collecting user provided information.

Usage

A simple text field with placeholder and/or label.

API

v-text-field
Name
append-icon
Default
undefined
Type
string

Components.TextFields.

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

Components.TextFields.

Name
autofocus
Default
false
Type
boolean

Components.TextFields.

Name
background-color
Default
undefined
Type
string

Components.TextFields.

Name
box
Default
false
Type
boolean

Components.TextFields.

Name
browser-autocomplete
Default
undefined
Type
string

Components.TextFields.

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

Components.TextFields.

Name
clearable
Default
false
Type
boolean

Components.TextFields.

Name
color
Default
'primary'
Type
string

コンポーネントに色を設定します。この色は、定義されている色の名前(例えばsuccesspurple)や、CSSの色指定(#033rgba(255, 0, 0, 0.5))を設定できます。

Name
counter
Default
undefined
Type
boolean | number | string

Components.TextFields.

Name
dark
Default
false
Type
boolean

ダークテーマを適用します。

Name
disabled
Default
false
Type
boolean

Components.TextFields.

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

Components.TextFields.

Name
error
Default
false
Type
boolean

Components.TextFields.

Name
error-count
Default
1
Type
number | string

Components.TextFields.

Name
error-messages
Default
[]
Type
string | array

Components.TextFields.

Name
flat
Default
false
Type
boolean

Components.TextFields.

Name
full-width
Default
false
Type
boolean

Components.TextFields.

Name
height
Default
undefined
Type
number | string

Components.TextFields.

Name
hide-details
Default
false
Type
boolean

Components.TextFields.

Name
hint
Default
undefined
Type
string

Components.TextFields.

Name
label
Default
undefined
Type
string

Components.TextFields.

Name
light
Default
false
Type
boolean

ライトテーマを適用します。

Name
loading
Default
false
Type
boolean | string

Components.TextFields.

Name
mask
Default
undefined
Type
object | string

Components.TextFields.

Name
messages
Default
[]
Type
string | array

Components.TextFields.

Name
outline
Default
false
Type
boolean

Components.TextFields.

Name
persistent-hint
Default
false
Type
boolean

Components.TextFields.

Name
placeholder
Default
undefined
Type
string

Components.TextFields.

Name
prefix
Default
undefined
Type
string

Components.TextFields.

Name
prepend-icon
Default
undefined
Type
string

Components.TextFields.

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

Components.TextFields.

Name
readonly
Default
false
Type
boolean

Components.TextFields.

Name
return-masked-value
Default
false
Type
boolean

Components.TextFields.

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

Components.TextFields.

Name
rules
Default
[]
Type
array

Components.TextFields.

Name
single-line
Default
false
Type
boolean

Components.TextFields.

Name
solo
Default
false
Type
boolean

Components.TextFields.

Name
solo-inverted
Default
false
Type
boolean

Components.TextFields.

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

Components.TextFields.

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

Components.TextFields.

Name
suffix
Default
undefined
Type
string

Components.TextFields.

Name
type
Default
'text'
Type
string

Components.TextFields.

Name
validate-on-blur
Default
false
Type
boolean

Components.TextFields.

Name
value
Default
undefined
Type
any

Components.TextFields.

Supplemental

Mask legend
MaskDescription
Masks
#Any digit
AAny capital letter
aAny small letter
NAny capital alphanumeric character
nAny small alphanumeric character
XAny special symbol (-!$%^&*()_+|~=`{}[]:";'<>?,./\) or space
Pre-made
credit-card#### - #### - #### - ####
date-with-time##/##/#### ##:##
phone(###) ### - ####
social###-##-####
time##:##
time-with-seconds##:##:##

Examples

Single line

Single line text fields do not float their label on focus or with data.

Disabled and readonly

Text fields can be disabled or readonly.

Icons

You can add icons to the text field with prepend-icon, append-icon and append-outer-icon props.

Clearable

When clearable, you can customize the clear icon with clear-icon.

Icon events

click:prepend, click:append, click:append-outer, and click:clear will be emitted when you click on the respective icon. Note that these events will not be fired if the slot is used instead.

Icon slots

Instead of using prepend / append / append-outer icons you can use slots to extend input's functionality.

Label slot

Text field label can be defined in label slot - that will allow to use HTML content

Character counter

Use a counter prop to inform a user of the character limit. The counter does not perform any validation by itself. You will need to pair it with either the internal validation system, or a 3rd party library. You can use it on regular, box or outline text fields.

Password input

A password input can be used with an appended icon and callback to control the visibility.

Validation

Vuetify includes simple validation through the rules prop. The prop accepts an array of callbacks. While validating rules, the current v-model value will be passed to the callback. This callback should return either true or a String, the error message.

Full-width text field with character counter

Full width text fields allow you to create boundless inputs. In this example, we use a v-divider to separate the fields.

Hint text

The hint property on text fields adds the provided string beneath the text field. Using persistent-hint keeps the hint visible when the text field is not focused. Hint prop is not supported in solo mode.

Prefixes & suffixes

The prefix and suffix properties allows you to prepend and append inline non-modifiable text next to the text field.

Custom validation

While the built in v-form or 3rd party plugin such as vuelidate or vee-validation can help streamline your validation process, you can choose to simply control it yourself.

Box style

Text fields can be used with an alternative box design. Append and prepend icon props are not supported in this mode.

Solo style

Text fields can be used with an alternative solo design.

Outline style

Text fields can be used with an alternative outline design.

Custom colors

You can optionally change a text field into any color in the Material design palette. Below is an example implementation of a custom form with validation.

Masks

Text fields can validate against character masks. Using either a pre-made or custom rules, you can optionally format and validate specific character sets. Note that masks work only with text fields, using them with date/number/file etc inputs may end up in unexpected behaviour or exception.

Progress bar

You can display a progress bar instead of the bottom line. You can use the default indeterminate progress having same color as the text field or designate a custom one using the progress slot

Edit this page | language on Github