@mollahdev/email-auto-fill
v1.0.1
Published
A simple class to auto fill email address based on user input
Downloads
8
Maintainers
Readme
Email Auto Fill
Available as an NPM Package.
Install with NPM:
npm i @mollahdev/email-auto-fill
A simple class to auto fill email address based on user input. This package assumes that your code will run in an ES2015+ environment.
Import and Configure
import EmailAutoFill from '@mollahdev/email-auto-fill';
const eaf = new EmailAutoFill({
domains: [
{
name: 'gmail.com',
autoCompleteAfter: 1, // define the number of characters to be typed before auto complete
misspelledVariations: [
'gmial.com',
'gmai.com',
'gamil.com',
'gmal.com',
'gamil.com',
'gmail.cm',
'mgail.com',
'gmil.com',
'gmail.om',
'gmaill.com',
'gmi.com',
'gmail.co',
'gmal.com',
'gmali.com',
'gml.com',
'gmal.com',
'gmali.com',
'gma.com'
]
},
{
name: 'yahoo.com',
autoCompleteAfter: 2
},
{
name: 'icloud.com',
autoCompleteAfter: 2
},
{
name: 'me.com',
autoCompleteAfter: 2
},
{
name: 'mac.com',
autoCompleteAfter: 2
},
{
name: 'outlook.com',
autoCompleteAfter: 2
},
{
name: 'protonmail.com',
autoCompleteAfter: 2
},
{
name: 'zohocorp.com',
autoCompleteAfter: 2
},
{
name: 'gmx.com',
autoCompleteAfter: 2
},
{
name: 'aoicorp.com',
autoCompleteAfter: 2
}
],
/**
* this subscribe method will be triggered when you receive any value by using dispatch method
*/
subscribe( value ) {
console.log(value)
}
})
// dispatch method will trigger subscribe method if any suggesation or auto-fill available
eaf.dispatch('auto-fill', 'example@g')
eaf.dispatch('suggesation', '[email protected]')
Event List
- auto-fill
- suggesation
auto-fill
'auto-fill' event generate a complete email address based on your input. e.g. if your input is example@gma, it will give you [email protected]. It will trigger the subscribe method once you complete username then @ sign then a character. e.g. example@y. You can use this event on input change.
eaf.dispatch('auto-fill', 'example@g')
// subscribe method will give you this output
{
"type": "auto-fill",
"inValue": "example@g",
"outValue": "[email protected]"
}
suggesation
'suggesation' event generate a complete email address if the email domain is listed in the misspelledVariations property. e.g. if your input is [email protected], it will give you [email protected]. You can use this event on form submit.
eaf.dispatch('suggesation', '[email protected]')
// subscribe method will give you this output
{
"type": "suggesation",
"inValue": "[email protected]",
"outValue": "[email protected]"
}