Skip to content

Commit

Permalink
Corrected misleading routeParams docs comment.
Browse files Browse the repository at this point in the history
The actual type of this.props.params.portfolioId will be a string as opposed to a number.
  • Loading branch information
thegaryroberts authored Sep 13, 2016
1 parent 17ad13f commit ad88702
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,7 @@ The dynamic segments of the URL.
The route that rendered this component.

#### `routeParams`
A subset of `this.props.params` that were directly specified in this component's route. For example, if the route's path is `users/:userId` and the URL is `/users/123/portfolios/345` then `this.props.routeParams` will be `{userId: '123'}`, and `this.props.params` will be `{userId: '123', portfolioId: 345}`.
A subset of `this.props.params` that were directly specified in this component's route. For example, if the route's path is `users/:userId` and the URL is `/users/123/portfolios/345` then `this.props.routeParams` will be `{userId: '123'}`, and `this.props.params` will be `{userId: '123', portfolioId: '345'}`.

#### `children`
The matched child route element to be rendered. If the route has [named components](/docs/API.md#named-components) then this will be undefined, and the components will instead be available as direct properties on `this.props`.
Expand Down

0 comments on commit ad88702

Please sign in to comment.