CraydelPhoneField

Installation

Get the latest version by NPM:

$ npm i @craydel/craydel-phone-field

Register Plugin

If you use the plugin API, the component will be registered as a global component just like when including it with the script tag, but you won't need to re-register it through the components property in your own components.

Create the plugin file e.g craydel-components.js file.

// craydel-components.js
import Vue from 'vue'
import CraydelPhoneField from '@craydel/craydel-phone-field/src/CraydelPhoneField.vue'

const Components = {
  CraydelPhoneField,
};

Object.keys(Components).forEach(name => {
  Vue.component(name, Components[name]);
});

export default Components;

Next reference the plugin file in your nuxt.config.js

// Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
plugins: [
  '~/plugins/craydel-components.js'
]

Props

| Name | Type | Default | Description | |----------------------|-------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | id | string | random ID | Sets the DOM id on the component. | | is-required | boolean | false | Puts component in a required state. | | required-error | string | 'Phone is required' | Puts the component in an error state and passes through the custom required error message. | | hint | string | undefined | Hint text. | | default-country-code | string | undefined | Sets the default country code. |

Usage

An example showing a phone field with the default country code set to Kenya.

<craydel-phone-field default-country-code="KE"></craydel-phone-field>