Skip to content
This repository has been archived by the owner on Jan 17, 2021. It is now read-only.

yongzhenlow/email-autocomplete

Repository files navigation

jquery.email-autocomplete.js

A jQuery plugin that suggests and autocompletes the domain whenever your users type in an email address field.

Build Status CDNJS version

What does it do?

When your user types in "user@gm", the plugin will suggest for e.g. "user@gmail.com", based on the first result from a list of predefined email domains.

diagram

Press the tab-key, or simply click on the suggestion to automatically fill in the rest of the domain. (or tap on the suggestion for mobile users.)

You can also use the right arrow key.

See a live demo here.

Installation

Bower

bower install email-autocomplete --save

Download

Download or clone this repo and copy dist/jquery.email-autocomplete.min.js into your javascripts directory.

Usage (jQuery)

Add jquery.email-autocomplete.min.js into your HTML, before the closing </body> tag.

<script src="jquery.min.js"></script>
<script src="jquery.email-autocomplete.min.js"></script>

You should also have a email input field.

<input id="email" name="email" type="email" />

Now, attach the plugin to the email input field.

<script>
$("#email").emailautocomplete({
  suggClass: "custom-classname",
  domains: ["example.com"]
});
</script>

Settings

Option Type Default Description
suggClass string 'eac-sugg' Classname for the suggestion text element.
domains array See list of domains below Array of domains used for autocompleting.

Styling

Use the following CSS to style the suggestion text color. Remember to update the classname if you've changed it to a custom one.

.eac-sugg {
  color: #ccc;
}

Domains

These are the plugin default domains if the domains option is not supplied.

  • gmail.com
  • googlemail.com
  • yahoo.com
  • yahoo.co.uk
  • hotmail.com
  • hotmail.co.uk
  • live.com
  • msn.com
  • comcast.net
  • sbcglobal.net
  • verizon.net
  • facebook.com
  • outlook.com
  • att.net
  • gmx.com
  • icloud.com
  • me.com
  • mac.com
  • aol.com

Author

  • Low Yong Zhen

Known Issues

  • On Android stock browser, if "Settings > Accessibility > Scale text up and down" value is not at 100%, the text width will be calculated incorrectly.