Skip to content

Commit 493dbe7

Browse files
Document lack of support for relative links
New users assume Link tags are basically equivalent to A tags. It is a rude awakening to discover relative links do not work.
1 parent 63b89f3 commit 493dbe7

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ A `<Link>` can know when the route it links to is active and automatically apply
109109
##### `to`
110110
A [location descriptor](https://github.com/mjackson/history/blob/master/docs/Glossary.md#locationdescriptor). Usually this is a string or an object, with the following semantics:
111111

112-
* If it's a string it represents the path to link to, e.g. `/users/123`.
112+
* If it's a string it represents the absolute path to link to, e.g. `/users/123` (relative paths are not supported).
113113
* If it's an object it can have four keys:
114114
* `pathname`: A string representing the path to link to.
115115
* `query`: An object of key:value pairs to be stringified.

0 commit comments

Comments
 (0)