Skip to content

Latest commit

 

History

History
111 lines (69 loc) · 2.48 KB

readme.md

File metadata and controls

111 lines (69 loc) · 2.48 KB
Raw

Email Obfuscate Build Status

Example

Guard email addresses from being simply scraped by bots.

Demo

http://dunckr.github.io/email-obfuscate/example/

Overview

Email addresses are harvested from websites using web scrapers.

There are many strategies that can be employed to mitigate scrapers: 1, 2, 3, 4. However, it must be noted that preventing scraping is an arms-race.

This library's aim to prevent searching for mailto links or using email address regexes.

It does this by constructing an email address from an object then drawing the text as an image using the canvas.

For older browsers without a canvas (IE8) we append an element using the alternate text.

Installation

npm install email-obfuscate --save

Usage

import EmailObfuscate from 'email-obfuscate';

var el = document.getElementById('email');

EmailObfuscate(el, {
  // Email construct: name@domain.tld
  name: 'test',
  domain: 'example',
  tld: 'com',
  // Alternate Text
  altText: 'Email'
});

API

EmailObfuscate(el, [options])

el

Type: HTMLElement

The element to replace with EmailObfuscate.

options

name

Type: string
Default: test

The name portion of the email address to use (name@email.com).

domain

Type: string
Default: example

The domain name portion of the email address to use (name@email.com).

tld

Type: string
Default: com

The top-level domain portion of the email address to use (name@email.com).

altText

Type: string
Default: Email

The alternate text to use to represent the email address.

Dev

npm run start

Test

npm run test

Build

npm run build

License

MIT © Duncan Beaton