diff --git a/apps/documentation/src/routes/documentation/hooks/use-router.mdx b/apps/documentation/src/routes/documentation/hooks/use-router.mdx index 134cd5cf..0d26ac44 100644 --- a/apps/documentation/src/routes/documentation/hooks/use-router.mdx +++ b/apps/documentation/src/routes/documentation/hooks/use-router.mdx @@ -11,4 +11,40 @@ import Breadcrumbs, { Element } from '@/components/breadcrumbs' # useRouter -TODO +The `useRouter` hook provides access to various data about the current route, as well as methods to navigate between pages, as seen in the below example: + +```typescript jsx +import { useRouter } from 'tuono' + +export default function IndexPage() { + const router = useRouter() + + return ( + <> +
pathname: {router.pathname}
+ + > + ) +} +``` + +## `router` object + +- `pathname`: `string` - Returns the current path name +- `query`: `Record