Skip to content

Commit

Permalink
Divide common and uncommon options
Browse files Browse the repository at this point in the history
  • Loading branch information
Coston Perkins committed Apr 17, 2019
1 parent 22cff56 commit b4ba8d7
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions readme.md
Expand Up @@ -70,20 +70,26 @@ export default () => (
</p>
```

## Options

| Prop | Type | Argument | Default | Description |
| --------- | ----------- | ------------ | ------------ | -------------------------------------------------------------- |
| email | `string` | `<optional>` | `null` | email address of the intended recipient |
| tel | `string` | `<optional>` | `null` | telephone number of the intended recipient |
| sms | `string` | `<optional>` | `null` | sms number of the intended recipient |
| facetime | `string` | `<optional>` | `null` | facetime address of the intended recipient |
| href | `string` | `<optional>` | `null` | Obfuscate any other URL type |
| 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 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) |
## Common Options

| Prop | Type | Argument | Default | Description |
| -------- | -------- | ---------- | ------- | -------------------------------------------- |
| email | `string` | `optional` | `null` | email address of the intended recipient |
| headers | `object` | `optional` | `null` | subject, cc, bcc, body, etc |
| tel | `string` | `optional` | `null` | telephone number of the intended recipient |
| sms | `string` | `optional` | `null` | sms number of the intended recipient |
| facetime | `string` | `optional` | `null` | facetime address of the intended recipient |
| href | `string` | `optional` | `null` | Obfuscate any other URL type (e.g. WhatsApp) |

## Uncommon Options

| Prop | Type | Argument | Default | Description |
| --------- | ---------- | ---------- | ------------ | -------------------------------------------------------------- |
| linkText | `string` | `optional` | `obfuscated` | add custom pre-interaction href attribute placeholder text |
| obfuscate | `boolean` | `optional` | `true` | set to false to disable obfuscation |
| element | `string` | `optional` | `'a'` | use if you want to override the default `a` tag |
| onClick | `function` | `optional` | `null` | called prior to setting location (e.g. for analytics tracking) |


## Development

Expand Down

0 comments on commit b4ba8d7

Please sign in to comment.