Skip to content

README updates for phone and url #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README updates for phone and url #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ See the [Custom Matchers](#custom-matchers) section below for more information.

| Type | Required | Default | Description |
| ----------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| boolean or string | No | `true` | Whether to link phone numbers. Possible values: `false` (disabled), `true` (`tel:{number}`), `"sms"` or `"text"` (`sms:{number}`). |
| boolean or string | No | `true` | Whether to link phone numbers. Possible values: `false` (disabled), `true` (creates the hyperlink `tel:{number}`), `"sms"` or `"text"` (creates the hyperlink `sms:{number}`). |

_Note:_ Currently, only US numbers are supported.

Expand Down Expand Up @@ -319,6 +319,8 @@ type UrlConfig = {
};
```

Setting `url={true}` is equivalent to `url={schemeMatches: true, wwwMatches: true, tldMatches: true}`.

```js
<Autolink text={text} url={false} />
<Autolink text={text} url={{ tldMatches: false }} />
Expand Down