v-phone-input / VPhoneInputMessagesComposableOptions

Interface: VPhoneInputMessagesComposableOptions<Country>

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

Internal

Options for usePhoneInputMessages composable.

Extends

• VPhoneInputExtractComposableOptions<VPhoneInputMessagesProps<Country>>

Type Parameters

Country

Country extends VPhoneInputCountryObject

Properties

ariaLabel?

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

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

Customize the phone input aria-label.

Inherited from

VPhoneInputExtractComposableOptions.ariaLabel

---

country

readonly country: MaybeRef<Country>

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

Country to resolve messages with.

---

countryAriaLabel?

readonly optional countryAriaLabel: MaybeRef<VPhoneInputMessage<Country> | null | undefined>

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

Customize the country input aria-label.

Default Value

'Country for <label>' when using the component, null otherwise.

Inherited from

VPhoneInputExtractComposableOptions.countryAriaLabel

---

countryLabel?

readonly optional countryLabel: MaybeRef<VPhoneInputMessage<Country> | null | undefined>

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

Customize the country input label.

Default Value

'Country for <label>' when using the composable, null otherwise.

Inherited from

VPhoneInputExtractComposableOptions.countryLabel

---

example?

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

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

Customize the phone input example.

Default Value

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

Inherited from

VPhoneInputExtractComposableOptions.example

---

exampleFormat?

readonly optional exampleFormat: MaybeRef<PhoneNumberFormat | null | undefined>

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

VPhoneInputExtractComposableOptions.exampleFormat

---

exampleType?

readonly optional exampleType: MaybeRef<PhoneNumberTypes | undefined>

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

Type of phone number to use for example phone.

Default Value

'mobile'

Inherited from

VPhoneInputExtractComposableOptions.exampleType

---

invalidMessage?

readonly optional invalidMessage: MaybeRef<VPhoneInputMessage<Country> | null | undefined>

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

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

VPhoneInputExtractComposableOptions.invalidMessage

---

label?

readonly optional label: MaybeRef<VPhoneInputMessage<Country, undefined> | undefined>

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

Customize the phone input label.

Default Value

'Phone'

Inherited from

VPhoneInputExtractComposableOptions.label

---

placeholder?

readonly optional placeholder: MaybeRef<VPhoneInputMessage<Country> | null | undefined>

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

Customize the phone input placeholder.

Inherited from

VPhoneInputExtractComposableOptions.placeholder