Search (Textfield)     

The Search component offers the user an input field with additional features for searching purposes. For autocomplete functionality, also refer to QAutocomplete documentation.

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

Installation

Edit /quasar.conf.js:

framework: {
  components: ['QSearch']
}

Basic Usage

<q-search v-model="search" />

Vue Properties

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

A more involved example:

<q-search
  v-model="searchModel"
  :debounce="600"
  placeholder="Hotels"
  icon="local_hotel"
  float-label="What is your hotel?"
/>

Common input field properties:

Also note you can use the native DOM attributes of an input: “name”, “maxlength”, “autocomplete” and so on.

Common input frame properties:

Icon buttons

This section refers to before and after properties which can add additional buttons such 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 model has a value
  content: Boolean,

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

Examples:

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

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

Lazy Input

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

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

Vue Methods

Vue Events

Coloring

Use the color prop with one of the Quasar colors from the Color Palette, like primary, secondary, orange-7, teal-2:

<q-search color="orange" v-model="search" />

Use the inverted prop, to change the background of the input to the color.

<q-search inverted color="orange" v-model="search" />

Error State

Use the error prop to show there has been an error. This will turn the component color to red.

<q-search error v-model="search" />
<q-search :error="hasError" inverted v-model="search" />

Disable

Use the disable prop to stop user input.

<q-search disable v-model="search" color="primary" />

Usage with Layout

If you’d like to set search within a QToolbar on QLayout:

<q-layout>
  ...
  <!--
    Notice we set a color for QToolbar and
    QSearch has "inverted" and color="none" specified.
    This makes QSearch use background color set by QToolbar.
  -->
  <q-toolbar slot="header" color="primary">
    <q-search inverted color="none" v-model="search" />
  </q-toolbar>
  ...
</q-layout>

Formatting

It is possible to add formatting to a QSearch 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-search 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-search v-model="text" inverted 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 example below will show a field for Euro currency input.

<!-- Align textfield content to the right -->
<q-search v-model="text" align="right" />

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-search
      v-model="text"
      dark
      inverted
      color="black"
      float-label="Textfield"
    />
  </q-field>
</div>

The above usage of QField will show the input field within a dark grey background and 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.