Skip to content

Commit 0802d19

Browse files
authored
README updates for phone and url
Tweaks to documentation based on responses to joshswan#56
1 parent 4100d2a commit 0802d19

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ See the [Custom Matchers](#custom-matchers) section below for more information.
184184

185185
| Type | Required | Default | Description |
186186
| ----------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
187-
| boolean or string | No | `true` | Whether to link phone numbers. Possible values: `false` (disabled), `true` (`tel:{number}`), `"sms"` or `"text"` (`sms:{number}`). |
187+
| 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}`). |
188188

189189
_Note:_ Currently, only US numbers are supported.
190190

@@ -319,6 +319,8 @@ type UrlConfig = {
319319
};
320320
```
321321

322+
Setting `url={true}` is equivalent to `url={schemeMatches: true, wwwMatches: true, tldMatches: true}`.
323+
322324
```js
323325
<Autolink text={text} url={false} />
324326
<Autolink text={text} url={{ tldMatches: false }} />

0 commit comments

Comments
 (0)