Skip to content

Commit 424708a

Browse files
committed
update docs for release
1 parent 0cd20cf commit 424708a

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

docs/api/Router.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,19 @@ Router.AsyncState
2626
Router.PathState
2727
Router.RouteLookup
2828
Router.Transitions
29+
30+
// methods
31+
Router.renderRoutesToString
2932
```
3033

34+
Methods
35+
-------
36+
37+
### `renderRoutesToString(routes, path, callback)`
38+
39+
We will document this more when the data loading story finalizes.
40+
41+
### `renderRoutesToStaticMarkup(routes, path, callback)`
42+
43+
We will document this more when the data loading story finalizes.
44+

docs/api/components/Routes.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Determines the scrolling behavior after route transitions.
2929

3030
One of:
3131

32-
- `'imitateBrowser'` - default, imitates what browsers do in a typical
32+
- `'browser'` - default, imitates what browsers do in a typical
3333
page reload scenario: preserves scroll positions when using the back
3434
button, scrolls up when you come to a new route by clicking a link,
3535
etc.
@@ -39,12 +39,15 @@ One of:
3939
- `'none'` - doesn't do anything (you should probably do something about
4040
that).
4141

42+
### `onError`
43+
44+
Called when a transition throws an error.
45+
4246
#### signature
4347

4448
`function(error)`
4549

46-
Example
47-
-------
50+
#### Example
4851

4952
```jsx
5053
function onError(error) {

0 commit comments

Comments
 (0)