useLocation

Read the current path, search, and hash, plus a navigation function.

Compatibility

ReactAvailable in this renderer's browser integration.

React SSRAvailable to this renderer's SSR integration; browser event handlers run after hydration.

PreactAvailable in this renderer's browser integration.

Preact SSRAvailable to this renderer's SSR integration; browser event handlers run after hydration.

Import from @kasperrt/smolter/react @kasperrt/smolter/preact

Signature

function useLocation(): readonly [string, Router["navigate"]];

Parameters

No arguments.

Returns

A readonly [location, navigate] tuple. navigate accepts a URL and optional { replace: true }.

Usage

Import this API from one of the entry points listed above. Keep server and build helpers in their dedicated subpaths.

const [location, navigate] = useLocation();

<button onClick={() => navigate("/tasks")}>All tasks</button>
<code>{location}</code>

Behavior and edge cases

The location omits the origin. Navigation runs the destination loader and aborts superseded work. External URLs are rejected by the router; use a normal anchor or browser navigation for another origin.

View implementation ↗

smolter_