{"_id":"base-vue-phone-input","_rev":"15-93b074b2dd91608f4d1065c2f63a77ae","name":"base-vue-phone-input","dist-tags":{"latest":"0.1.13"},"versions":{"0.0.1":{"name":"base-vue-phone-input","version":"0.0.1","_id":"base-vue-phone-input@0.0.1","maintainers":[{"name":"keepitsilent","email":"sidoriki1@yandex.ru"}],"dist":{"shasum":"169ba8edefcc6a798589be38ead14fa30bdfcb1a","tarball":"https://registry.npmjs.org/base-vue-phone-input/-/base-vue-phone-input-0.0.1.tgz","fileCount":6,"integrity":"sha512-6Qf9NQpfRKVubK33gxh+0E4keKEcqA7UIKG5PknAFicFiBuViVzchhmAEKvZzpQGRCqAZYh4/spoWhkGVsdH4g==","signatures":[{"sig":"MEYCIQCV69Uz0tR/N8a/6qDWai4xGnUC5QVGokHloPvqqMy1jAIhAPb55S42yYg/i+OIc5G3hOr7H/OT8eeJv/OHgkYqjUcf","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":360657},"main":"./dist/base-vue-phone-input.umd.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/base-vue-phone-input.js","exports":{".":{"import":"./dist/base-vue-phone-input.js","require":"./dist/base-vue-phone-input.umd.cjs"}},"scripts":{"dev":"vite","build":"vite build && vue-tsc --emitDeclarationOnly","types":"vue-tsc ","preview":"vite preview"},"_npmUser":{"name":"keepitsilent","email":"sidoriki1@yandex.ru"},"_npmVersion":"10.8.1","description":"This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `\n\n\n\n```\n\nBut this input is meant to be customized\n\n## Features\n\n- You can set preferred-countries, ignored-countries or have only-countries\n- Multi options to getting country code : By default the component get the country code via the browser (disable it with no-use-browser-locale) or you can use fetch-country to get the country code via https://ip2c.org/s (network needed) - you can use default-country-code option instead to set one\n- Phone number formatting while typing\n- You can search your country in list (open countries list & type your country name)\n- Keyboard accessibility (Arrow down, Arrow up: Countries list navigation - Escape: Close countries list)\n- Phone number example for each country in placeholder\n- Fully cusstomizable with slots\n\n## Props API\n\n| Prop name | Description | Type | Values | Default |\n| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------ | --------- |\n| modelValue | `@model` Country calling code + telephone number in international format | string | \\- | undefined |\n| countryCode | `@model` Country code selected - Ex: \"FR\" | CountryCode | \\- | undefined |\n| placeholder | Placeholder of the input | string | \\- | undefined |\n| label | label of the input | string | \\- | undefined |\n| preferredCountries | List of country codes to place first in the select list - Ex: \\['FR', 'BE', 'GE'\\] | Array | \\- | undefined |\n| ignoredCountries | List of country codes to be removed from the select list - Ex: \\['FR', 'BE', 'GE'\\] | Array | \\- | undefined |\n| onlyCountries | List of country codes to only have the countries selected in the select list - Ex: \\['FR', 'BE', 'GE'\\] | Array | \\- | undefined |\n| translations | Locale strings of the component | Partial | \\- | undefined |\n| noUseBrowserLocale | By default the component use the browser locale to set the default country code if not country code is provided | boolean | \\- | |\n| fetchCountry | The component will make a request ([https://ipwho.is](https://ipwho.is)) to get the location of the user and use it to set the default country code | boolean | \\- | |\n| customCountriesList | Replace country names | Record | \\- | undefined |\n| autoFormat | Disabled auto-format when phone is valid
`@default` true | boolean | \\- | true |\n| noFormattingAsYouType | Disabled auto-format as you type
`@default` false | boolean | \\- | false |\n| countryLocale | locale of country list - Ex: \"fr-FR\"
`@default` {string} browser locale | string | \\- | undefined |\n| excludeSelectors | Exclude selectors to close country selector list - usefull when you using custom flag | Array | \\- | undefined |\n\n## Events API\n\n| Event | Return |\n| --- | --- |\n| input | [AsYouType value](https://github.com/catamphetamine/libphonenumber-js#as-you-type-formatter) (emit when new value is enter on phone number input && when a country is choosed) |\n| update | All values (Result type) |\n\n## Keyboard accessibility\n\n| Props | Action |\n| --------- | --------------------------------- |\n| ArrowDown | Navigation down in countries list |\n| ArrowUp | Navigation up in countries list |\n| Escape | Close countries list |\n\n## Named slots\n\n| Name | Description | Bindings |\n| -------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| selector | Change the country selector component | **input-value** `String` - current selected country code - Ex: `\"FR\"` **updateInputValue** - action for changing country code by passing country code **countries** - array of all countries |\n| input | Change the input component | **input-value** `String` - phone number value **updateInputValue** - action for updating phone value **placeholder** - placeholder |\n\n## Translations\n\n### Labels & placeholders\n\n```javascript\n\n\n```\n\n### Country list\n\nTwo ways to translate the country list:\n\n#### First solution - set country locale\n\n```javascript\n\n```\n\n#### Second solution - custom list\n\n```javascript\n\n\n```\n\n## Types\n\nResults emitted by @update or @data event\n\n```javascript\nexport type Results = {\n isValid: boolean\n isPossible?: boolean\n countryCode?: CountryCode\n countryCallingCode?: CountryCallingCode\n nationalNumber?: NationalNumber\n type?: NumberType\n formatInternational?: string\n formatNational?: string\n uri?: string\n e164?: string\n rfc3966?: string\n}\n\n```\n\nCountry type\n\n```javascript\nexport interface Country {\n iso2: CountryCode\n dialCode: CountryCallingCode\n name: string\n}\n\n```\n","readmeFilename":"README.md"}