V1 is no longer in development.
The plugin was made over Vue3 while considering the Quasar Framework v2.X. The plugin provides auto country detection on user inputs as well as dropdown for country which supports search by name, country code, and country phone code.
Live preview of the code is available in CodePen
Contributors are welcome.
yarn
yarn add vue3-q-tel-input@v1.1.9
npm
npm i vue3-q-tel-input@1.1.9
Import the component as
import Vue3QTelInput from 'vue3-q-tel-input'
Import the styles as
import 'vue3-q-tel-input/dist/vue3-q-tel-input.esm.css'
http://unpkg.com/vue3-q-tel-input@latest/dist/vue3-q-tel-input.min.js
http://unpkg.com/vue3-q-tel-input@latest/dist/vue3-q-tel-input.esm.css
https://cdn.jsdelivr.net/npm/vue3-q-tel-input@latest/dist/vue3-q-tel-input.min.js
https://cdn.jsdelivr.net/npm/vue3-q-tel-input@latest/dist/vue3-q-tel-input.esm.css
<vue3-q-tel-input v-model:tel="tel" />
All the props that are supported in the quasar input field are available in the plugin as well. example
<vue3-q-tel-input v-model:tel="tel" dense outlined />
All the slots that are supported in the quasar input field are available in the plugin as input slots. The country selection element uses append slot.
example
<vue3-q-tel-input>
<template v-slot:append>
<q-avatar>
<img src="https://cdn.quasar.dev/logo-v2/svg/logo.svg">
</q-avatar>
</template>
</vue3-q-tel-input>
All the slots that are supported in quasar select field are available in the plugin as country select control slots with the prefix cs-.
example
<vue3-q-tel-input>
<template v-slot:cs-before-options>
<q-item>
<q-item-section>
This renders as before-options q-select slot in the country list
</q-item-section>
</q-item>
</template>
</vue3-q-tel-input>
| Prop | Type | Description | Usage |
|---|---|---|---|
| tel | string or number | The telephone value | v-model:tel="telephone_number" |
| Prop | Type | Required | Description |
|---|---|---|---|
| required | Boolean | No | Shows error validation when the field is empty |
| search-text | String | No | The label for the search field inside the country dropdown |
| search-icon | String | No | Set the icon for the search field to something else |
| default-country | String | No | The default country to load. eg: us, ae, de, in, etc. |
| dropdown-options | Obejct | No | The props available for the Quasar Select |
| eager-validate | Boolean | No | Set to true if the validation needs not be run on loading |
| use-icon | Boolean | No | Set to use the emoji icon instead of the default flag images |
| no-results-text | String | No | Set a string when the search results nothing, default: 'No results found' |
| disableAutoCountrySelection | Boolean | No | Prevent the input field value from changing the country selection |
| Emitter | Type | Description |
|---|---|---|
| update:tel | string | Triggers when an update is made to the model value |
| input | string | Triggers when the input value changes |
| error | boolean | true when the input is invalid and false when valid |
| country | Country | Gets back the object information of a country |