useOptionalRouter

The router the calling component renders under, or undefined outside a RouterProvider. Unlike useRouter it does not throw, so a component that can run with or without a router (a form that enhances itself, a hook that reads per-page state) can ask.

Import#

import { useOptionalRouter } from "@shadow-js/router";

Signature#

function useOptionalRouter(): Router | undefined

Returns#

The router, or undefined.

Examples#

const router = useOptionalRouter();
if (router !== undefined) router.navigate("/");