Skip to content

Commit fddf224

Browse files
committed
migrated link doc
1 parent 08291ba commit fddf224

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

doc/02 Components/Link.md renamed to docs/Link.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,41 @@
1+
## Link
2+
13
The primary way to allow users to navigate around your application.
24
`Link` will render a fully accesible anchor tag with the proper href.
35

46
A `Link` also knows when the route it links to is active and automatically
57
applies its `activeClassName` and/or `activeStyle` when it is.
68

7-
Props
8-
-----
9+
### Props
910

1011
### `to`
1112

1213
The path to link to, e.g., `/users/123`.
1314

14-
### `query`
15+
#### `query`
1516

1617
An object of key:value pairs to be stringified.
1718

18-
### `activeClassName`
19+
#### `state`
20+
21+
State to persist to the `location`.
22+
23+
#### `activeClassName`
1924

2025
The className a `Link` receives when its route is active. Defaults to `active`.
2126

22-
### `activeStyle`
27+
#### `activeStyle`
2328

2429
The styles to apply to the link element when its route is active.
2530

26-
### `onClick`
31+
#### `onClick`
2732

2833
A custom handler for the click event. Works just like a handler on an `<a>`
2934
tag - calling `e.preventDefault()` or returning `false` will prevent the
3035
transition from firing, while `e.stopPropagation()` will prevent the event
3136
from bubbling.
3237

33-
### *others*
38+
#### *others*
3439

3540
You can also pass props you'd like to be on the `<a>` such as a title, id, className, etc.
3641

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@
1313
- [Route](Route.md)
1414
- [Plain Route](Plain Route.md)
1515
- [Redirect](Redirect.md)
16+
- [Link](Link.md)
1617

1718
- [Server Rendering](ServerRendering.md)

0 commit comments

Comments
 (0)