https://github.com/iamstevendao/vue-tel-input
International Telephone Input with Vue
https://github.com/iamstevendao/vue-tel-input
hacktoberfest input international-telephone javascript phone phone-input vue vue-tel
Last synced: 5 months ago
JSON representation
International Telephone Input with Vue
- Host: GitHub
- URL: https://github.com/iamstevendao/vue-tel-input
- Owner: iamstevendao
- License: mit
- Created: 2017-12-14T01:06:00.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-01-05T03:09:45.000Z (9 months ago)
- Last Synced: 2025-04-19T08:37:57.434Z (6 months ago)
- Topics: hacktoberfest, input, international-telephone, javascript, phone, phone-input, vue, vue-tel
- Language: CSS
- Homepage: https://iamstevendao.com/vue-tel-input/
- Size: 8.23 MB
- Stars: 836
- Watchers: 14
- Forks: 356
- Open Issues: 153
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# vue-tel-input
International Telephone Input with Vue.
[](https://www.npmjs.com/package/vue-tel-input) [](https://github.com/iamstevendao/vue-tel-input)
## Documentation and Demo
[Visit the website](https://iamstevendao.com/vue-tel-input/)
## Vue 2 Support
`vue-tel-input@legacy`: [Guide](https://iamstevendao.com/vue-tel-input/guide/legacy.html)
## Changelog
[Go to Github Releases](https://github.com/iamstevendao/vue-tel-input/releases)
## Getting started
- Install the plugin:
```sh
npm install vue-tel-input
```
- Add the plugin into your app:
```javascript
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');
```
[More info on installation](#installation)
- Use the `vue-tel-input` component:
```html
```
## Installation
### npm
```bash
npm install vue-tel-input
```
Install the plugin into Vue:
```javascript
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](https://iamstevendao.com/vue-tel-input/usage/props.html).
Or use the component directly:
```html
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,
};
},
};
```
### Browser
```html
```
**If Vue is detected in the Page, the plugin is installed automatically.**
\*\* Otherwise, manually install the plugin into Vue:
```js
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](https://webpack.js.org/guides/lazy-loading/) and you can use it in some modern bundlers like Webpack and Rollup.
```html
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,
},
};
```
As you see, we don't use Vue SFC `` 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
```bash
git clone https://github.com/iamstevendao/vue-tel-input.git
```
Go to the project directory
```bash
cd vue-tel-input
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run dev
```
## License
Copyright (c) 2018 Steven Dao.
Released under the [MIT License](https://github.com/iamstevendao/vue-tel-input/blob/master/LICENSE).
made with ❤ by [Steven](https://github.com/iamstevendao).