obfuscate-link-wc

obfuscate-link web component

Web component to obfuscate emails, links and more

Give Crawlers & Spammers a harder time collecting your infos while still display the infos nicely.

<obfuscate-link id="obfuscate" email="aXZvQGxvY2FsLmRldg==">custom link</obfuscate-link>
<br />
<obfuscate-link id="obfuscate" email="aXZvQGxvY2FsLmRldg=="></obfuscate-link>
<br />
<obfuscate-link id="obfuscate" tel="aXZvQGxvY2FsLmRldg==" link-text="Call us"></obfuscate-link>
<br />
<obfuscate-link id="obfuscate" sms="aXZvQGxvY2FsLmRldg=="></obfuscate-link>
<br />
<obfuscate-link id="obfuscate" facetime="aXZvQGxvY2FsLmRldg=="></obfuscate-link>
<br />
<obfuscate-link id="obfuscate" href="aXZvQGxvY2FsLmRldg=="></obfuscate-link>

Encoding

The obfuscate-link web component expects an already encoded value. The default encoding is base64. Please base64 encode your link yourself before entering it.

You can add your own decoder to provide a more sophisticated encoding and hence you must also have your own encoder to encode your value.

Add your decoder like this:

<script>
  function decoder(value) {
    console.log('custom decoder');
    return window.atob(value);
  }
  obfuscate.decoder = decoder;
</script>

Styling

This component supports styling the generated link via Shadow Parts. You can style the element with:

obfuscate-link::part(link) {
  color: red;
  text-decoration: underline wavy;
}

Using this component

There are three strategies we recommend for using web components built with Stencil.

Script tag

• Put a script tag similar to this <script type='module' src='https://unpkg.com/obfuscate-link-wc@1.0.0/www/build/obfuscate-link.esm.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Node Modules

• Run npm install my-component --save
• Put a script tag similar to this <script type='module' src='node_modules/obfuscate-link-wc/www/build/obfuscate-link.esm.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

In an app

• Run npm install obfuscate-link-wc --save
• Add an import to the npm packages import { ObfuscateLink } from 'obfuscate-link-wc';customElements.define('obfuscate-link', ObfuscateLink);
• Then you can use the element anywhere in your template, JSX, html etc

Disclaimer

Obfuscation can still be decoded by sophisticated bots quite easily but still better than nothing. Using the web component itself is already blocking spammer that look for mailto links.

Development

Run:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Credits

This is a fork of https://github.com/ivoba/obfuscate-wc.

Heavily inspired by https://github.com/coston/react-obfuscate I was migrating from react to plain HTML and JS, so i needed something that worked as web component.

I also enjoyed reading this posts: https://antonvroemans.medium.com/expand-your-spam-mailing-list-with-cloudflares-poor-obfuscation-fdc3cc8f4ccd https://www.corewebvitals.io/pagespeed/say-goodbye-to-cloudflare-email-obfuscation https://derkuba.de/content/posts/1021/stencil-builds-for-using-component-lib/