VPhoneInput

Appearance

v-phone-input / VPhoneInputMessagesProps

Interface: VPhoneInputMessagesProps<Country> ​

Defined in: dist/types.d.ts:155

Internal

Props to customize localization related features.

Extends ​

Type Parameters ​

Country ​

Country extends VPhoneInputCountryObject

Properties ​

ariaLabel? ​

readonly optional ariaLabel: VPhoneInputMessage<Country, undefined> | null

Defined in: dist/props/makePhoneInputMessagesProps.d.ts:43

Customize the phone input aria-label.

Inherited from ​

Readonly.ariaLabel

countryAriaLabel? ​

readonly optional countryAriaLabel: VPhoneInputMessage<Country> | null

Defined in: dist/props/makePhoneInputMessagesProps.d.ts:58

Customize the country input aria-label.

Default Value ​

'Country for <label>'

Inherited from ​

Readonly.countryAriaLabel

countryLabel? ​

readonly optional countryLabel: VPhoneInputMessage<Country> | null

Defined in: dist/props/makePhoneInputMessagesProps.d.ts:49

Customize the country input label.

Inherited from ​

Readonly.countryLabel

example? ​

readonly optional example: VPhoneInputMessage<Country, undefined, undefined>

Defined in: dist/props/makePhoneInputMessagesProps.d.ts:28

Customize the phone input example.

Default Value ​

Use awesome-phonenumber package's getExample function with current country.

Inherited from ​

Readonly.example

exampleFormat? ​

readonly optional exampleFormat: PhoneNumberFormat | null

Defined in: dist/props/makePhoneInputMessagesProps.d.ts:19

Format example phone.

Remarks ​

Using null will disable formating example phone numbers.

Default Value ​

displayFormat value if available, 'national' otherwise.

Inherited from ​

Readonly.exampleFormat

invalidMessage? ​

readonly optional invalidMessage: VPhoneInputMessage<Country> | null

Defined in: dist/props/makePhoneInputMessagesProps.d.ts:74

Customize the phone input invalid message returned by the validate function generated rule.

Default Value ​

'The "<label>" field is not a valid phone number (example: <example>).'

Inherited from ​

Readonly.invalidMessage

label? ​

readonly optional label: VPhoneInputMessage<Country, undefined>

Defined in: dist/props/makePhoneInputMessagesProps.d.ts:37

Customize the phone input label.

Default Value ​

'Phone'

Inherited from ​

Readonly.label

placeholder? ​

readonly optional placeholder: VPhoneInputMessage<Country> | null

Defined in: dist/props/makePhoneInputMessagesProps.d.ts:64

Customize the phone input placeholder.

Inherited from ​

Readonly.placeholder