mailcheck-vue

mailcheck-vue

Installation

npm install mailcheck-vue --save

Usage

• register the component

  window.Vue = require('vue')
  
  Vue.component('MailCheck', require('mailcheck-vue'))
  

• now use it like

  <mail-check
      model-name="email"
      :data="email"
      :domains="['gmail.com', 'aol.com']"
      :topLevelDomains="['com', 'net', 'org']"
      :secondLevelDomains="['hotmail']"
      :distanceFunction="someFunction">
  
      <span>Did you Mean</span>
  </mail-check>
  

  prop	required	type	default	description
  modelName	:white_check_mark:	string		the v-model key we should update on click
  data	:white_check_mark:	string		the v-model value we want to check
  domains	:x:	array	Mailcheck.domains	mailcheck
  topLevelDomains	:x:	array	Mailcheck.topLevelDomains	mailcheck
  secondLevelDomains	:x:	array	Mailcheck.secondLevelDomains	mailcheck
  distanceFunction	:x:	function	Mailcheck.sift4Distance	mailcheck

# Why we need both data & modelName ?
to update the parent v-model without the need to use an EventBus, if someone have a better idea am all :ear:.

• to style the result, use mail-check ex.

  .mail-check {
      cursor: pointer;
      color: red;
  }