custom-vue-tel-input
v1.0.0
Published
International Telephone Input with Vue
Downloads
4
Maintainers
Readme
vue-tel-input
International Telephone Input with Vue.
Documentation and Demo
Vue 2 Support
vue-tel-input@legacy
: Guide
Changelog
Getting started
Install the plugin:
npm install vue-tel-input
Add the plugin into your app:
import Vue from 'vue'; import VueTelInput from 'vue-tel-input'; import 'vue-tel-input/vue-tel-input.css'; const app = createApp(App); app.use(VueTelInput); app.mount('#app');
Use the
vue-tel-input
component:<template> <vue-tel-input v-model="phone"></vue-tel-input> </template>
Installation
npm
npm install vue-tel-input
Install the plugin into Vue:
import { createApp } from 'vue';
import App from './App.vue';
import VueTelInput from 'vue-tel-input';
import 'vue-tel-input/vue-tel-input.css';
const globalOptions = {
mode: 'auto',
};
const app = createApp(App);
app.use(VueTelInput, globalOptions); // Define default global options here (optional)
app.mount('#app');
View all available options in Props.
Or use the component directly:
<template>
<vue-tel-input v-model="phone" mode="international"></vue-tel-input>
</template>
<script>
import { ref } from 'vue';
import { VueTelInput } from 'vue-tel-input';
import 'vue-tel-input/vue-tel-input.css';
export default {
components: {
VueTelInput,
},
setup() {
const phone = ref(null);
return {
value,
};
},
};
</script>
Browser
<script src="https://unpkg.com/vue-tel-input"></script>
<link rel="stylesheet" href="https://unpkg.com/vue-tel-input/dist/vue-tel-input.css" />
If Vue is detected in the Page, the plugin is installed automatically.
** Otherwise, manually install the plugin into Vue:
app.use(window['vue-tel-input']);
Component lazy loading
Since the library is about 200kb of JavaScript and 100kb of CSS in order to improve initial page loading time you might consider importing it asynchronously only when user navigates to the page where the library is actually needed. The technique is called Lazy Load and you can use it in some modern bundlers like Webpack and Rollup.
<!-- your-component.vue-->
<template>
<vue-tel-input v-model="value"></vue-tel-input>
</template>
<script>
const VueTelInput = () =>
Promise.all([
import(/* webpackChunkName: "chunk-vue-tel-input" */ 'vue-tel-input'),
import(/* webpackChunkName: "chunk-vue-tel-input" */ 'vue-tel-input/vue-tel-input.css'),
]).then(([{ VueTelInput }]) => VueTelInput);
export default {
components: {
VueTelInput,
},
};
</script>
As you see, we don't use Vue SFC <style></style>
tag here to import component's css as it would result in CSS going to the main/vendors bundle instead of being downloaded on demand.
Development
Clone the project
git clone https://github.com/iamstevendao/vue-tel-input.git
Go to the project directory
cd vue-tel-input
Install dependencies
npm install
Start the server
npm run dev
License
Copyright (c) 2018 Steven Dao. Released under the MIT License.
made with ❤ by Steven.