mailcheck-vue

1.0.4 • Public • Published

mailcheck-vue

npm npm

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 string the v-model key we should update on click
    data string the v-model value we want to check
    domains array Mailcheck.domains mailcheck
    topLevelDomains array Mailcheck.topLevelDomains mailcheck
    secondLevelDomains array Mailcheck.secondLevelDomains mailcheck
    distanceFunction 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 👂.


  • to style the result, use mail-check ex.
    .mail-check {
        cursor: pointer;
        color: red;
    }

Dependencies (1)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i mailcheck-vue

    Weekly Downloads

    22

    Version

    1.0.4

    License

    MIT

    Unpacked Size

    5.82 kB

    Total Files

    4

    Last publish

    Collaborators

    • ctf0