Skip to content

Commit c676f88

Browse files
Fix docs (#257)
* docs: fix RouterActions markdown table * docs: fix broken RouterActions links --------- Co-authored-by: Mustafa Mansour <mmansour@atlassian.com>
1 parent dfa3507 commit c676f88

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/api/components.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -253,15 +253,15 @@ export const Avatar = () => (
253253

254254
## RouterActions
255255

256-
Actions that communicate with the router's routing functionality are exposed safely via the `RouterActions` component and [`useRouterActions`](#userouteractions) hook.
256+
Actions that communicate with the router's routing functionality are exposed safely via the `RouterActions` component and [`useRouterActions`](./hooks.md#userouteractions) hook.
257257

258258
By using either of these you will gain access to the following actions
259259

260260
| prop | type | arguments | description |
261-
| --------------- | ---------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
262-
| `push` | `function` | `path: Href | Location, state?: any` | Calls `history.push` with the supplied args |
261+
| --------------- | ---------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
262+
| `push` | `function` | `path: Href \| Location, state?: any` | Calls `history.push` with the supplied args |
263263
| `pushTo` | `function` | `route: Route, attributes?: { params?: {}, query?: {} }` | Calls `history.push` generating the path from supplied route and attributes |
264-
| `replace` | `function` | `path: Href | Location, state?: any` | Calls `history.replace` with the supplied args |
264+
| `replace` | `function` | `path: Href \| Location, state?: any` | Calls `history.replace` with the supplied args |
265265
| `replaceTo` | `function` | `route: Route, attributes?: { params?: {}, query?: {} }` | Calls `history.replace` generating the path from supplied route and attributes |
266266
| `goBack` | `function` | | Goes to the previous route in history |
267267
| `goForward` | `function` | | Goes to the next route in history |

docs/api/hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ export const MyRouteComponent = () => {
127127
128128
## useRouterActions
129129
130-
You can access [Router Actions](#routeractions) using this hook.
130+
You can access [Router Actions](./components.md#routeractions) using this hook.
131131
132132
```js
133133
export const RouterActionsHookExample = () => {

0 commit comments

Comments
 (0)