Skip to content

Commit 14a5d21

Browse files
committed
updated api docs toc
1 parent 2433af6 commit 14a5d21

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/api/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,19 @@ React Router API
1818
- Mixins
1919
- [`ActiveState`](/docs/api/mixins/ActiveState.md)
2020
- [`AsyncState`](/docs/api/mixins/AsyncState.md)
21-
21+
- [`PathState`](/docs/api/mixins/PathState.md)
22+
- [`RouteLookup`](/docs/api/mixins/RouteLookup.md)
23+
- [`Transitions`](/docs/api/mixins/Transitions.md)
2224

2325
Public Modules
2426
--------------
2527

26-
All modules found at the repository root are considered public. You can
27-
require them conveniently with `var Route = require('react-router/Route');` etc.
28+
While there are many modules in this repository, only those found on the
29+
default export are considered public.
2830

29-
Note that we do not support requiring modules from our `modules`
30-
directory. (No notes in the changelog, no changes to the versioning of
31-
the lib, etc.)
31+
```js
32+
var Router = require('react-router');
33+
var Link = Router.Link // yes
34+
var Link = require('react-router/modules/components/Link') // no
35+
```
3236

0 commit comments

Comments
 (0)