Skip to content

Commit

Permalink
docs: clarify links a litle
Browse files Browse the repository at this point in the history
  • Loading branch information
asmyshlyaev177 committed Nov 6, 2024
1 parent c0773aa commit 13875b5
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ All components that use the same `state` object are automatically synchronized.

## useUrlState hook for Next.js

[Docs](packages/urlstate/next/useUrlState#api)
[Full API Docs](packages/urlstate/next/useUrlState#api)

[React-Router example](#useurlstate-hook-for-react-router)

Expand Down Expand Up @@ -397,7 +397,7 @@ function SettingsComponent() {

API is same as for Next.js version, except can pass options from [NavigateOptions](https://github.com/remix-run/react-router/blob/bc693ed9f39170bda13b9e1b282fb8e9d5925f66/packages/react-router/lib/context.ts#L99) type.

[Docs](packages/urlstate/react-router/useUrlState#api)
[API Docs](packages/urlstate/react-router/useUrlState#api)

### Example

Expand Down Expand Up @@ -486,7 +486,7 @@ const tags = [

Hooks to create your own `useUrlState` hooks with other routers, e.g. react-router or tanstack router.

[Docs](packages/urlstate/useUrlStateBase)
[API Docs](packages/urlstate/useUrlStateBase)

## `useSharedState` hook for React.js

Expand All @@ -503,19 +503,19 @@ function SettingsComponent() {
}
```

[Docs](packages/urlstate/useSharedState/README.md)
[API Docs](packages/urlstate/useSharedState/README.md)

## `useUrlEncode` hook for React.js

[Docs](packages/urlstate/useUrlEncode/README.md)
[API Docs](packages/urlstate/useUrlEncode/README.md)

## `encodeState` and `decodeState` helpers

[Docs](packages/urlstate/encodeState/README.md)
[API Docs](packages/urlstate/encodeState/README.md)

## `encode` and `decode` helpers

[Docs](packages/urlstate/encoder/README.md)
[API Docs](packages/urlstate/encoder/README.md)

# Best Practices

Expand Down

0 comments on commit 13875b5

Please sign in to comment.