Skip to content

Update docs #3592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2016
Merged

Update docs #3592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 14 additions & 20 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,6 @@ function createElement(Component, props) {
}
```

##### `stringifyQuery(queryObject)` (deprecated)
A function used to convert an object from [`<Link>`](#link)s or calls to
[`transitionTo`](#transitiontopathname-query-state) to a URL query string.

##### `parseQueryString(queryString)` (deprecated)
A function used to convert a query string into an object that gets passed to route component props.

##### `onError(error)`
While the router is matching, errors may bubble up, here is your opportunity to catch and deal with them. Typically these will come from async features like [`route.getComponents`](#getcomponentsnextstate-callback), [`route.getIndexRoute`](#getindexroutepartialnextstate-callback), and [`route.getChildRoutes`](#getchildroutespartialnextstate-callback).

Expand All @@ -95,6 +88,10 @@ This is primarily for integrating with other libraries that need to participate

Ensure that you render a `<RouterContext>` at the end of the line, passing all the props passed to `render`.

##### `stringifyQuery(queryObject)` (deprecated)

##### `parseQueryString(queryString)` (deprecated)


#### Examples
Please see the [`examples/`](/examples) directory of the repository for extensive examples of using `<Router>`.
Expand All @@ -108,7 +105,7 @@ A `<Link>` can know when the route it links to is active and automatically apply

#### Props
##### `to`
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:
A [location descriptor](https://github.com/ReactJSTraining/history/blob/master/docs/Glossary.md#locationdescriptor). Usually this is a string or an object, with the following semantics:

* If it's a string it represents the absolute path to link to, e.g. `/users/123` (relative paths are not supported).
* If it's an object it can have four keys:
Expand All @@ -117,16 +114,7 @@ A [location descriptor](https://github.com/mjackson/history/blob/master/docs/Glo
* `hash`: A hash to put in the URL, e.g. `#a-hash`.
* `state`: State to persist to the `location`.

##### `query` **([deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**
An object of key:value pairs to be stringified.

##### `hash` **([deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**
A hash to put in the URL, e.g. `#a-hash`.

_Note: React Router currently does not manage scroll position, and will not scroll to the element corresponding to the hash._

##### `state` **([deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**
State to persist to the `location`.
_Note: React Router currently does not manage scroll position, and will not scroll to the element corresponding to `hash`._

##### `activeClassName`
The className a `<Link>` receives when its route is active. No active class by default.
Expand All @@ -143,6 +131,12 @@ If `true`, the `<Link>` will only be active when the current route exactly match
##### *others*
You can also pass props you'd like to be on the `<a>` such as a `title`, `id`, `className`, etc.

##### `query` **([deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**

##### `hash` **([deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**

##### `state` **([deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**

#### Example
Given a route like `<Route path="/users/:userId" />`:

Expand Down Expand Up @@ -613,9 +607,9 @@ For more details, please see the [histories guide](/docs/guides/Histories.md).
`useRouterHistory` is a `history` enhancer that configures a given `createHistory` factory to work with React Router. This allows using custom histories in addition to the bundled singleton histories.

It also pre-enhances the history with the
[useQueries](https://github.com/mjackson/history/blob/master/docs/QuerySupport.md)
[useQueries](https://github.com/ReactJSTraining/history/blob/master/docs/QuerySupport.md)
and
[useBasename](https://github.com/mjackson/history/blob/master/docs/BasenameSupport.md)
[useBasename](https://github.com/ReactJSTraining/history/blob/master/docs/BasenameSupport.md)
enhancers from `history`

#### Example
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/Histories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,11 @@ render(

If you'd like to further customize the history options or use other
enhancers from
[history](https://github.com/mjackson/history/) you can use
[history](https://github.com/ReactJSTraining/history/) you can use
`useRouterHistory`.

Be aware that `useRouterHistory` already pre-enhances your history
factory with the [useQueries](https://github.com/mjackson/history/blob/master/docs/QuerySupport.md) and [useBasename](https://github.com/mjackson/history/blob/master/docs/BasenameSupport.md) enhancers from `history`.
factory with the [useQueries](https://github.com/ReactJSTraining/history/blob/master/docs/QuerySupport.md) and [useBasename](https://github.com/ReactJSTraining/history/blob/master/docs/BasenameSupport.md) enhancers from `history`.

### Examples:

Expand Down