Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

useRouter.tsx

15 lines511 Bytes

1import * as Solid from 'solid-js'
2import warning from 'tiny-warning'
3import { getRouterContext } from './routerContext'
4import type { AnyRouter, RegisteredRouter } from '@tanstack/router-core'
5​
6export function useRouter<TRouter extends AnyRouter = RegisteredRouter>(opts?: {
7 warn?: boolean
8}): TRouter {
9 const value = Solid.useContext(getRouterContext() as any)
10 warning(
11 !((opts?.warn ?? true) && !value),
12 'useRouter must be used inside a <RouterProvider> component!',
13 )
14 return value as any