Skip to content

Commit

Permalink
Update readme #34
Browse files Browse the repository at this point in the history
  • Loading branch information
Coston Perkins committed Mar 21, 2019
1 parent b96a5e0 commit e4d96b8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Live demo: [react-obfuscate.coston.io](https://react-obfuscate.coston.io)

## How it works

The user passes the contact link as an `email, tel, sms, or facetime` prop. The component obfuscates href data until an onClick event. Links are given their proper URL schemes (mailto, facetime, etc.) The link is rendered in reverse in the dom, but reversed again with css. This making the link useless for spammers, but user friendly on screen.
The user passes the contact link as an `email, tel, sms, or facetime` prop. The component obfuscates href data until a hover, click, or focus event. Links are given their proper URL schemes (mailto, facetime, etc.) The link is rendered in reverse in the dom, but reversed again with css. This making the link useless for spammers, but user friendly on screen.

## Why

Expand Down Expand Up @@ -78,7 +78,7 @@ export default () => (
| facetime | `string` | `<optional>` | `null` | facetime address of the intended recipient |
| headers | `object` | `<optional>` | `null` | subject, cc, bcc, body, etc |
| obfuscate | `boolean` | `<optional>` | `true` | set to false to disable obfuscation |
| linkText | `string` | `<optional>` | `obfuscated` | add custom obfuscated link text, like 'Email Me' |
| linkText | `string` | `<optional>` | `obfuscated` | add custom pre-interaction href attribute placeholder text |
| element | `string` | `<optional>` | `'a'` | custom element to render instead of an `a` tag |
| onClick | `function` | `<optional>` | `null` | called prior to setting location (e.g. for analytics tracking) |

Expand Down

0 comments on commit e4d96b8

Please sign in to comment.