Skip to content

Installation

@erag/phone-number-vue has a single peer dependency — Vue 3. No masking library, no extra runtime dependencies.

Install the package

bash
npm install @erag/phone-number-vue
bash
yarn add @erag/phone-number-vue
bash
pnpm add @erag/phone-number-vue

Requirements

RequirementVersion
Vue^3.0.0
Node.js>=16
TypeScript^5.0 (optional but recommended)

Verify the install

After installing, import the composable to confirm the package resolves correctly:

ts
import { usePhoneNumber } from '@erag/phone-number-vue'

If TypeScript resolves the types without errors, the install is complete.

What is included

The package ships with:

  • usePhoneNumber — the main composable
  • countries — bundled country metadata array
  • dialCodes — bundled dial-code metadata array
  • phoneNumberData — combined default data object
  • Full TypeScript types for all exports
ts
import {
  usePhoneNumber,
  countries,
  dialCodes,
  phoneNumberData,
} from '@erag/phone-number-vue'

MIT License. Copyright Er Amit Gupta