Input (Textfield)     

Quasar’s Input component is the basis for text (we’ll call it “Singe Line Input”) and textarea (we’ll call it “Multiple Line Input”) form input. It can be used for regular text input, passwords, email addresses, numbers, telephone numbers, urls and auto-growing text areas.

Works well with QField for additional functionality such as a helper, error message placeholder and many others.

Installation

Edit /quasar.conf.js:

framework: {
  components: ['QInput']
}

Basic Usage

<!-- Single Line Input -->
<q-input v-model="text" />
<q-input v-model="text" stack-label="Stack Label" />
<q-input v-model="text" float-label="Float Label" placeholder="Gigi" />

<!-- Multiple Line Input -->
<q-input
  v-model="area"
  type="textarea"
  float-label="Textarea"
  :max-height="100"
  rows="7"
/><!-- max-height refers to pixels -->

Vue Properties

Supports v-model which should be bound to a String or Number (depending on type property used) in your scope.

When you set type to “number”, there are some additional properties that you can use:

Also note you can use the native DOM attributes of an input: “min”, “max”, “step”.

When you set type to “textarea”, these is an additional property that you can use:

There’s also the native DOM attribute of a textarea: ‘rows’.

Common input field properties:

Common input frame properties:

IMPORTANT
All DOM attributes that apply to a native <input> or <textarea> can be used. Example: maxlength, rows, min/max/step, autocomplete and so on.

Icon buttons

This section refers to before and after properties which can add additional buttons as icons to the textfield. Here is the structure of the two properties:

{
  // required icon
  icon: String,
  // required function to call when
  // icon is clicked/tapped
  handler: Function,

  // Optional. Show icon button
  // if textfield model has a value
  content: Boolean,

  // Optional. Show icon button
  // if condition is true
  condition: Boolean,

  // Optional. Show icon button
  // if textfield is marked with error
  error: Boolean,

  // Optional. Show icon button
  // if textfield is marked with warning
  warning: Boolean
}

Examples:

<!--
  Show an icon button (with 'warning' as icon)
  when there is an error on QInput (through "error" prop)
-->
<q-input
  v-model="text"
  :error="error"
  type="password"
  :after="[
    {
      icon: 'warning',
      error: true,
      handler () {
        // do something...
      }
    }
  ]"
/>

<!--
  Show an icon button (with 'arrow_forward' as icon)
  when the model has a non empty value
-->
<q-input
  v-model="text"
  :after="[
    {
      icon: 'arrow_forward',
      content: true,
      handler () {
        // do something...
      }
    }
  ]"
/>

Labeling

QInput comes with two built-in labeling possibilities. You can use the float-label or the stack-label properties to add text for the labeling of the field. A stack-label is static in its position above the field, whereas the float-label is more dynamic. Check the examples to the right to see the difference.

<q-input v-model="text" stack-label="Stack Label" placeholder="Add some text..."  />
<q-input v-model="text" float-label="Float Label"/>

As shown above, you can also add a placeholder to help explain to the user what type of input should be entered.

Password Input

If you use the input type password, the component will hide the characters entered by the user, but it will also offer the user a clickable icon to toggle the input, to make the input legible.

<q-input v-model="text" type="password" float-label="Password" />

Number Input

The below example shows a number input type.

<q-input v-model="number" type="number" float-label="Number" />

Prefixes and Suffixes

You can add a text before or after the field as part of an input mask, for instance, for showing Euro or US Dollar currency.

<!-- Notice prefix property -->
<q-input v-model="number" type="number" prefix="$US" stack-label="Number" />

<!-- Notice suffix property -->
<q-input v-model="number" type="number" suffix="€" stack-label="Number" />

<!-- Notice suffix property -->
<q-input v-model="email" type="email" suffix="@gmail.com" stack-label="Type Google Email" />

Error State

You can control the color to show a mistake in user input or some other systematic error. To do this set the error prop to true.

<q-input :error="error" v-model="text" float-label="Colored Black" color="black" />

If you’d like to show the user an explanatory text about the error condition, you can wrap the QInput in a QField component.

<!--
  Notice error prop is now used on wrapper QField
  instead of on QInput now
-->
<q-field :error="error" error-label="Oh buggers! You made a boo boo.">
  <q-input v-model="text" float-label="Colored with Error" color="amber"  />
</q-field>

Please refer to the QField documentation for more info about its usage.

Loading State

If, for some reason, the input requires some longer term background action or process, you can add a spinner to indicate progress by setting the loading prop to true.

<q-input :loading="loading" v-model="text" placeholder="Add some text..." />

Vue Methods

Vue Events

Formatting

It is possible to add formatting to a QInput in two ways. One is for the basic component. The other is with the QField component. Both methods offer “inverted” coloring.

Additional Vue Properties

Basic Formatting Examples

This will color the field black.

<q-input v-model="text" float-label="Colored" color="black" />

This will show an inverted colored input field in amber. Here, the text is automatically inverted to a lighter color.

<q-input v-model="text" inverted-light color="amber" stack-label="Amber Colored Background" />

Alignment

You can also align the input to the right, center or left. The default is left. The below example will show a field for Euro currency input.

<!-- Align textfield content to the right -->
<q-input v-model="number" align="right" type="number" suffix="€" stack-label="Number" />

Basic Usage with QField

It is also possible to further enhance a QInput by wrapping it in a QField component.

<div class="bg-grey-9" style="width: 500px; padding: 25px">
  <q-field
    icon="wifi"
    label="Some Label"
    :count="10"
    helper="Some helper"
    :error="error"
    error-label="Some error"
  >
    <q-input
      v-model="text"
      dark
      color="yellow"
      float-label="Textfield"
    />
  </q-field>
</div>

The above usage of QField will show the input field within a dark grey background with an inverse white text. Notice the usage of the dark prop for QInput. This controls the inversion of the text color.

Please refer to the QField documentation for more info about its usage.

Validations with Vuelidate

Quasar’s recommendation for doing form components validations is Vuelidate as it fits great with the overall architecture. It’s simple, lightweight and model-based.

You need to have Vuelidate added to your project first. See here.

<template>
  <q-input
    type="email"
    :error="$v.email.$error"
    v-model="email"
    @blur="$v.email.$touch"
  />
</template>

<script>
import { required, email } from 'vuelidate/lib/validators'

export default {
  data () {
    return {
      email: ''
    }
  },
  validations: {
    email: { required, email }
  }
}
</script>

For more options like displaying an error label, a helper or character counter, wrap QInput with a QField. Here is a more involved example.

Directive Modifiers for v-model

Vue comes with standard modifiers on v-model, which can be useful in conjunction with QInput. They are .lazy and .trim.

.lazy

Vue will soon supply the .lazy modifier for v-model on components too, but until then, you can use the longer equivalent form:

<q-input
  :value="model"
  @change="val => { model = val }"
/>

.trim

If you want the user’s input to be trimmed automatically, you can add the trim modifier to your v-model managed inputs:

<q-input v-model.trim="msg" />