Skip to content

Commit

Permalink
fix wording
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanto committed Oct 17, 2024
1 parent 3cb1cfc commit f56e5c9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 5 deletions.
3 changes: 0 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# useOptimisticRoute

The `useOptimisticRoute` hook lets client components to peek into the future state of the router. This hook is used to check if the router is transitioning, and if so what page is being loaded.
The `useOptimisticRoute` hook lets client components peek into the future state of the router. This hook is used to check if the router is transitioning, and if so what page is being loaded.

## Usage

Expand Down Expand Up @@ -74,7 +74,7 @@ In the example above, the `Settings` link will pulse when the user clicks the li

## Settled state

When the router is not transitioning, the `path` and `searchParams` properties will reflect the current path and search params.
When the router is not transitioning, the `path` and `searchParams` properties will reflect the current path and search params of the router.

```tsx
// src/pages/client-component.tsx
Expand Down

0 comments on commit f56e5c9

Please sign in to comment.