useNavigate
The useNavigate hook imperatively navigates between routes.
Example code
Anchor link to section titled "Example code"
The useNavigate hook takes the following arguments:
| Argument | Description |
|---|---|
| replace? | Whether to update the state object or URL of the current history entry. Defaults to false. |
| reloadDocument? | Whether to reload the whole document on navigation. |
| clientState? | The custom client state with the navigation. |
Return value
Anchor link to section titled "Return value"The useNavigate hook returns the following values:
| Name | Description |
|---|---|
| path | The path you want to navigate to. |
| options | The options for the configuration object: replace, reloadDocument, clientState. For more information the options, refer to the Link component. |
Considerations
Anchor link to section titled "Considerations"- Consider using the
useNavigatehook only where appropriate. Generally, you should use theLinkcomponent instead, because it provides standard browser accessibility functionality, likecmd+clickand right-click to open. - The
useNavigatehook is only available in client components.