javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-11-09 16:16:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(components): update method and parameter descriptions (#18075)

Browse Source
This commit is contained in:
Brandy Carney
2019-04-23 12:59:25 -04:00
committed by GitHub
parent bd96491d03
commit 464ec3b70a
56 changed files with 879 additions and 644 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/src/components/router/readme.md
View File

@ -85,10 +85,10 @@ Navigate to the specified URL.
#### Parameters
| Name | Type | Description |
| ----------- | ------------------------------- | ----------- |
| `url` | `string` | |
| `direction` | `"back" \| "forward" \| "root"` | |
| Name | Type | Description |
| ----------- | ------------------------------- | -------------------------------------------------------- |
| `url` | `string` | The url to navigate to. |
| `direction` | `"back" \| "forward" \| "root"` | The direction of the animation. Defaults to `"forward"`. |
#### Returns

3
core/src/components/router/router.tsx
View File

@ -88,6 +88,9 @@ export class Router implements ComponentInterface {
/**
* Navigate to the specified URL.
*
* @param url The url to navigate to.
* @param direction The direction of the animation. Defaults to `"forward"`.
*/
@Method()
push(url: string, direction: RouterDirection = 'forward') {