wouter-preact

Features

- Minimum dependencies, only 2.1 KB gzipped vs 18.7KB
React Router.
- Supports both React and Preact! Read
_"Preact support" section_ for more details.
- No top-level component, it is fully optional.
- Mimics React Router's best practices by providing
familiar Route, Link,
Switch and Redirect components.
- Has hook-based API for more granular control over routing (like animations):
useLocation,
useRoute and
useRouter.

developers :sparkling_heart: wouter

> ... I love Wouter. It’s tiny, fully embraces hooks, and has an intuitive and barebones API. I can
> accomplish everything I could with react-router with Wouter, and it just feels **more minimalist
> while not being inconvenient.**
>
> Matt Miller, _An exhaustive React ecosystem for 2020_

Wouter provides a simple API that many developers and library authors appreciate. Some notable
projects that use wouter: Ultra,
React-three-fiber,
Sunmao UI, Million and many more.

Table of Contents

- Getting Started
- Browser Support
- Wouter API
- The list of methods available
- Hooks API
- useRoute: route matching and parameters
- useLocation: working with the history
- Additional navigation parameters
- Customizing the location hook
- useParams: extracting matched parameters
- useSearch: query strings
- useSearchParams: search parameters
- useRouter: accessing the router object
- Component API

-
- Route nesting
-
-
-
-

- FAQ and Code Recipes
- I deploy my app to the subfolder. Can I specify a base path?
- How do I make a default route?
- How do I make a link active for the current route?
- Are strict routes supported?
- Are relative routes and links supported?
- Can I initiate navigation from outside a component?
- Can I use _wouter_ in my TypeScript project?
- How can add animated route transitions?
- How do I add view transitions to my app?
- Preact support?
- Server-side Rendering support (SSR)?
- How do I configure the router to render a specific route in tests?
- 1KB is too much, I can't afford it!
- Acknowledgements

Getting Started

First, add wouter to your project.

``bash
npm i wouter
`

Or, if you're using Preact the use the following command npm i wouter-preact.

Check out this simple demo app below. It doesn't cover hooks and other features such as nested routing, but it's a good starting point for those who are migrating from React Router.

`js
import { Link, Route, Switch } from "wouter";

const App = () => (
<>
Profile

About Us

{/*
Routes below are matched exclusively -
the first matched route gets rendered
*/}




{(params) => <>Hello, {params.name}!}


{/ Default route in a switch /}
404: No such page!


);
`

$3

This library is designed for ES2020+ compatibility. If you need to support older browsers, make sure that you transpile node_modules. Additionally, the minimum supported TypeScript version is 4.1 in order to support route parameter inference.

Wouter API

Wouter comes with three kinds of APIs: low-level standalone location hooks, hooks for routing and pattern matching and more traditional **component-based
API** similar to React Router's one.

You are free to choose whatever works for you: use location hooks when you want to keep your app as small as
possible and don't need pattern matching; use routing hooks when you want to build custom routing components; or if you're building a traditional app
with pages and navigation — components might come in handy.

Check out also FAQ and Code Recipes for more advanced things like active
links, default routes, server-side rendering etc.

$3

Location Hooks

These can be used separately from the main module and have an interface similar to useState. These hooks are standalone and don't include built-in support for nesting, base path, or route matching. However, when passed to , they work seamlessly with all Router features including nesting and base paths.

- import { useBrowserLocation } from "wouter/use-browser-location" —
allows to manipulate current location in the browser's address bar, a tiny wrapper around the History API.
- import { useHashLocation } from "wouter/use-hash-location" — similarly, gets location from the hash part of the address, i.e. the string after a #.
- import { memoryLocation } from "wouter/memory-location" — an in-memory location hook with history support, external navigation and immutable mode for testing. Note the module name because it is a high-order hook. See how memory location can be used in testing.

Routing Hooks

Import from wouter module.

- useRoute — shows whether or not current page matches the
pattern provided.
- useLocation — allows to manipulate current
router's location, by default subscribes to browser location. Note: this isn't the same as useBrowserLocation, read below.
- useParams — returns an object with parameters matched from the closest route.
- useSearch — returns a search string – everything that goes after the ?.
- useRouter — returns a global router object that
holds the configuration. Only use it if you want to customize the routing.

Components

Import from wouter module.

- — conditionally renders a component based on a pattern.
- — wraps , allows to perform a navigation.
- — exclusive routing, only renders the first matched route.
- — when rendered, performs an immediate navigation.
- — an optional top-level
component for advanced routing configuration.

Hooks API

$3

Checks if the current location matches the pattern provided and returns an object with parameters. This is powered by a wonderful regexparam library, so all its pattern syntax is fully supported.

You can use useRoute to perform manual routing or implement custom logic, such as route transitions, etc.

`js
import { useRoute } from "wouter";

const Users = () => {
// match is a boolean
const [match, params] = useRoute("/users/:name");

if (match) {
return <>Hello, {params.name}!;
} else {
return null;
}
};
`

A quick cheatsheet of what types of segments are supported:

`js
useRoute("/app/:page");
useRoute("/app/:page/:section");

// optional parameter, matches "/en/home" and "/home"
useRoute("/:locale?/home");

// suffixes
useRoute("/movies/:title.(mp4|mov)");

// wildcards, matches "/app", "/app-1", "/app/home"
useRoute("/app*");

// optional wildcards, matches "/orders", "/orders/"
// and "/orders/completed/list"
useRoute("/orders/*?");

// regex for matching complex patterns,
// matches "/hello:123"
useRoute(/^/:([0-9]+)[/]?$/);
// and with named capture groups
useRoute(/^/:(?[0-9]+)[/]?$/);
`

The second item in the pair params is an object with parameters or null if there was no match. For wildcard segments the parameter name is "*":

`js
// wildcards, matches "/app", "/app-1", "/app/home"
const [match, params] = useRoute("/app*");

if (match) {
// "/home" for "/app/home"
const page = params["*"];
}
`

$3

To get the current path and navigate between pages, call the useLocation hook. Similarly to useState, it returns a value and a setter: the component will re-render when the location changes and by calling navigate you can update this value and perform navigation.

By default, it uses useBrowserLocation under the hood, though you can configure this in a top-level Router component (for example, if you decide at some point to switch to a hash-based routing). useLocation will also return scoped path when used within nested routes or with base path setting.

`js
import { useLocation } from "wouter";

const CurrentLocation = () => {
const [location, navigate] = useLocation();

return (


All the components internally call the useLocation hook.

#### Additional navigation parameters

The setter method of useLocation can also accept an optional object with parameters to control how
the navigation update will happen.

When browser location is used (default), useLocation hook accepts replace flag to tell the hook to modify the current
history entry instead of adding a new one. It is the same as calling replaceState.

`jsx
const [location, navigate] = useLocation();

navigate("/jobs"); // pushState is used
navigate("/home", { replace: true }); // replaceState is used
`

Additionally, you can provide a state option to update history.state while navigating:

`jsx
navigate("/home", { state: { modal: "promo" } });

history.state; // { modal: "promo" }
`

#### Customizing the location hook

By default, wouter uses useLocation hook that reacts to pushState and replaceState
navigation via useBrowserLocation.

To customize this, wrap your app in a Router component:

`js
import { Router, Route } from "wouter";
import { useHashLocation } from "wouter/use-hash-location";

const App = () => (


...

);
`

Because these hooks have return values similar to useState, it is easy and fun to build your own location hooks: useCrossTabLocation, useLocalStorage, useMicroFrontendLocation and whatever routing logic you want to support in the app. Give it a try!

$3

This hook allows you to access the parameters exposed through matching dynamic segments. Internally, we simply wrap your components in a context provider allowing you to access this data anywhere within the Route component.

This allows you to avoid "prop drilling" when dealing with deeply nested components within the route. Note: useParams will only extract parameters from the closest parent route.

`js
import { Route, useParams } from "wouter";

const User = () => {
const params = useParams();

params.id; // "1"

// alternatively, use the index to access the prop
params[0]; // "1"
};

/>
`

It is the same for regex paths. Capture groups can be accessed by their index, or if there is a named capture group, that can be used instead.

`js
import { Route, useParams } from "wouter";

const User = () => {
const params = useParams();

params.id; // "1"
params[0]; // "1"
};

/[/]?$/} component={User}> />
`

$3

Use this hook to get the current search (query) string value. It will cause your component to re-render only when the string itself and not the full location updates. The search string returned does not contain a ? character.

`jsx
import { useSearch } from "wouter";

// returns "tab=settings&id=1"
const searchString = useSearch();
`

For the SSR, use ssrSearch prop passed to the router.

`jsx
{/ SSR! /}
`

Refer to Server-Side Rendering for more info on rendering and hydration.

$3

Returns a URLSearchParams object and a setter function to update search parameters. The setter accepts either a value (object, URLSearchParams, string[][], etc.) or a callback function that receives the current params and must return the new params.

`jsx
import { useSearchParams } from 'wouter';

const [searchParams, setSearchParams] = useSearchParams();

// extract a specific search parameter
const id = searchParams.get('id');

// modify a specific search parameter
setSearchParams((prev) => {
prev.set('tab', 'settings');
return prev;
});

// override all search parameters
setSearchParams({
id: 1234,
tab: 'settings',
});

// by default, setSearchParams() will push a new history entry
// to avoid this, set replace option to true
setSearchParams(
(prev) => {
prev.set('order', 'desc');
return prev;
},
{
replace: true,
},
);

// you can also pass a history state in options
setSearchParams(
(prev) => {
prev.set('foo', 'bar');
return prev;
},
{
state: 'hello',
},
);
`

$3

If you're building advanced integration, for example custom location hook, you might want to get
access to the global router object. Router is a simple object that holds routing options that you configure in the Router component.

`js
import { useRouter } from "wouter";

const Custom = () => {
const router = useRouter();

router.hook; // useBrowserLocation by default
router.base; // "/app"
};

const App = () => (



);
`

Component API

$3

Route represents a piece of the app that is rendered conditionally based on a pattern path. Pattern has the same syntax as the argument you pass to useRoute.

The library provides multiple ways to declare a route's body:

`js
import { Route } from "wouter";

// simple form


// render-prop style

{params => }


// the params prop will be passed down to

`

A route with no path is considered to always match, and it is the same as . When developing your app, use this trick to peek at the route's content without navigation.

`diff
-
+
{/ Strip out the path to make this visible /}

`

#### Route Nesting

Nesting is a core feature of wouter and can be enabled on a route via the nest prop. When this prop is present, the route matches everything that starts with a given pattern and it creates a nested routing context. All child routes will receive location relative to that pattern.

Let's take a look at this example:

`js





`

1. This first route will be active for all paths that start with /app, this is equivalent to having a base path in your app.

2. The second one uses dynamic pattern to match paths like /app/user/1, /app/user/1/anything and so on.

3. Finally, the inner-most route will only work for paths that look like /app/users/1/orders. The match is strict, since that route does not have a nest prop and it works as usual.

If you call useLocation() inside the last route, it will return /orders and not /app/users/1/orders. This creates a nice isolation and it makes it easier to make changes to parent route without worrying that the rest of the app will stop working. If you need to navigate to a top-level page however, you can use a prefix ~ to refer to an absolute path:

`js


Back to Home


`

Note: The nest prop does not alter the regex passed into regex paths.
Instead, the nest prop will only determine if nested routes will match against the rest of path or the same path.
To make a strict path regex, use a regex pattern like /^/[/]?$/ (this matches an optional end slash and the end of the string).
To make a nestable regex, use a regex pattern like /^/(?=$|[/])/ (this matches either the end of the string or a slash for future segments).

$3

Link component renders an element that, when clicked, performs a navigation.

`js
import { Link } from "wouter"

Home

// to is an alias for href
Home

// all standard a props are proxied
Home

// all location hook options are supported

`

Link will always wrap its children in an tag, unless asChild prop is provided. Use this when you need to have a custom component that renders an under the hood.

`jsx
// use this instead




// Remember, UIKitLink must implement an onClick handler
// in order for navigation to work!
`

When you pass a function as a className prop, it will be called with a boolean value indicating whether the link is active for the current route. You can use this to style active links (e.g. for links in navigation menu)

`jsx
(active ? "active" : "")}>Nav
`

Read more about active links here.

$3

There are cases when you want to have an exclusive routing: to make sure that only one route is
rendered at the time, even if the routes have patterns that overlap. That's what Switch does: it
only renders the first matching route.

`js
import { Route, Switch } from "wouter";

{/*
in wouter, any Route with empty path is considered always active.
This can be used to achieve "default" route behaviour within Switch.
Note: the order matters! See examples below.
*/}
This is rendered when nothing above has matched
;
`

When no route in switch matches, the last empty Route will be used as a fallback. See FAQ and Code Recipes section to read about default routes.

$3

When mounted performs a redirect to a path provided. Uses useLocation hook internally to trigger
the navigation inside of a useEffect block.

Redirect can also accept props for customizing how navigation will be performed, for example for setting history state when navigating. These options are specific to the currently used location hook.

`jsx


// arbitrary state object


// use replaceState

`

If you need more advanced logic for navigation, for example, to trigger the redirect inside of an
event handler, consider using
useLocation hook instead:

`js
import { useLocation } from "wouter";

const [location, setLocation] = useLocation();

fetchOrders().then((orders) => {
setOrders(orders);
setLocation("/app/orders");
});
`

$3

Unlike _React Router_, routes in wouter don't have to be wrapped in a top-level component. An
internal router object will be constructed on demand, so you can start writing your app without
polluting it with a cascade of top-level providers. There are cases however, when the routing
behaviour needs to be customized.

These cases include hash-based routing, basepath support, custom matcher function etc.

`jsx
import { useHashLocation } from "wouter/use-hash-location";


{/ Your app goes here /}
;
`

A router is a simple object that holds the routing configuration options. You can always obtain this
object using a useRouter hook. The list of currently
available options:

- hook: () => [location: string, setLocation: fn] — is a React Hook function that subscribes
to location changes. It returns a pair of current location string e.g. /app/users and a
setLocation function for navigation. You can use this hook from any component of your app by
calling useLocation() hook. See Customizing the location hook.

- searchHook: () => [search: string, setSearch: fn] — similar to hook, but for obtaining the current search string.

- base: string — an optional setting that allows to specify a base path, such as /app. All
application routes will be relative to that path. To navigate out to an absolute path, prefix your path with an ~. See the FAQ.

- parser: (path: string, loose?: boolean) => { pattern, keys } — a pattern parsing
function. Produces a RegExp for matching the current location against the user-defined patterns like
/app/users/:id. Has the same interface as the parse function from regexparam. See this example that demonstrates custom parser feature.

- ssrPath: string and ssrSearch: string use these when rendering your app on the server.

- hrefs: (href: boolean) => string — a function for transforming href attribute of an element rendered by Link. It is used to support hash-based routing. By default, href attribute is the same as the href or to prop of a Link. A location hook can also define a hook.hrefs property, in this case the href will be inferred.

- aroundNav: (navigate, to, options) => void — a handler that wraps all navigation calls. Use this to intercept navigation and perform custom logic before and after the navigation occurs. You can modify navigation parameters, add side effects, or prevent navigation entirely. This is particularly useful for implementing view transitions. By default, it simply calls navigate(to, options).

`js
const aroundNav = (navigate, to, options) => {
// do something before navigation
navigate(to, options); // perform navigation
// do something after navigation
};
`

FAQ and Code Recipes

$3

You can! Wrap your app with component and that should do the trick:

`js
import { Router, Route, Link } from "wouter";

const App = () => (

{/ the link's href attribute will be "/app/users" /}
Users

The current path is /app/users!

);
`

Calling useLocation() within a route in an app with base path will return a path scoped to the base. Meaning that when base is "/app" and pathname is "/app/users" the returned string is "/users". Accordingly, calling navigate will automatically append the base to the path argument for you.

When you have multiple nested routers, base paths are inherited and stack up.

`js


Path is /app/cms/users!


`

$3

One of the common patterns in application routing is having a default route that will be shown as a
fallback, in case no other route matches (for example, if you need to render 404 message). In
wouter this can easily be done as a combination of component and a default route:

`js
import { Switch, Route } from "wouter";


...
404, Not Found!
;
`

_Note:_ the order of switch children matters, default route should always come last.

If you want to have access to the matched segment of the path you can use wildcard parameters:

`js

...

{/ will match anything that starts with /users/, e.g. /users/foo, /users/1/edit etc. /}
...

{/ will match everything else /}

{(params) => 404, Sorry the page ${params["*"]} does not exist!}


`

▶ Demo Sandbox

$3

Instead of a regular className string, provide a function to use custom class when this link matches the current route. Note that it will always perform an exact match (i.e. /users will not be active for /users/1).

`jsx
(active ? "active" : "")}>Nav link
`

If you need to control other props, such as aria-current or style, you can write your own wrapper
and detect if the path is active by using the useRoute hook.

`js
const [isActive] = useRoute(props.href);

return (

{props.children}

);
`

▶ Demo Sandbox

$3

If a trailing slash is important for your app's routing, you could specify a custom parser. Parser is a method that takes a pattern string and returns a RegExp and an array of parsed key. It uses the signature of a parse function from regexparam.

Let's write a custom parser based on a popular path-to-regexp package that does support strict routes option.

`js
import { pathToRegexp } from "path-to-regexp";

/**
* Custom parser based on pathToRegexp with strict route option
*/
const strictParser = (path, loose) => {
const keys = [];
const pattern = pathToRegexp(path, keys, { strict: true, end: !loose });

return {
pattern,
// pathToRegexp returns some metadata about the keys,
// we want to strip it to just an array of keys
keys: keys.map((k) => k.name),
};
};

const App = () => (

...
...

);
`

▶ Demo Sandbox

$3

Yes! Any route with nest prop present creates a nesting context. Keep in mind, that the location inside a nested route will be scoped.

`js
const App = () => (


{/ the href is "/app/dashboard/users" /}



{/ Here useLocation() returns "/users"! /}



);
`

▶ Demo Sandbox

$3

Yes, the navigate function is exposed from the "wouter/use-browser-location" module:

`js
import { navigate } from "wouter/use-browser-location";

navigate("/", { replace: true });
`

It's the same function that is used internally.

$3

Yes! Although the project isn't written in TypeScript, the type definition files are bundled with
the package.

$3

Let's take look at how wouter routes can be animated with framer-motion.
Animating enter transitions is easy, but exit transitions require a bit more work. We'll use the AnimatePresence component that will keep the page in the DOM until the exit animation is complete.

Unfortunately, AnimatePresence only animates its direct children, so this won't work:

`jsx
import { motion, AnimatePresence } from "framer-motion";

export const MyComponent = () => (

{/ This will not work! motion.div is not a direct child /}

initial={{ opacity: 0 }}
animate={{ opacity: 1 }}
exit={{ opacity: 0 }}
/>


);
`

The workaround is to match this route manually with useRoute:

`jsx
export const MyComponent = ({ isVisible }) => {
const [isMatch] = useRoute("/");

return (

{isMatch && (
initial={{ opacity: 0 }}
animate={{ opacity: 1 }}
exit={{ opacity: 0 }}
/>
)}

);
};
`

More complex examples involve using useRoutes hook (similar to how React Router does it), but wouter does not ship it out-of-the-box. Please refer to this issue for the workaround.

$3

Wouter works seamlessly with the View Transitions API, but you'll need to manually activate it. This is because view transitions require synchronous DOM rendering and must be wrapped in flushSync from react-dom. Following wouter's philosophy of staying lightweight and avoiding unnecessary dependencies, view transitions aren't built-in. However, there's a simple escape hatch to enable them: the aroundNav prop.

`jsx
import { flushSync } from "react-dom";
import { Router, type AroundNavHandler } from "wouter";

const aroundNav: AroundNavHandler = (navigate, to, options) => {
// Check if View Transitions API is supported
if (!document.startViewTransition) {
navigate(to, options);
return;
}

document.startViewTransition(() => {
flushSync(() => {
navigate(to, options);
});
});
};

const App = () => (

{/ Your routes here /}

);
`

You can also enable transitions selectively using the transition prop, which will be available in the options parameter:

`jsx
// Enable transition for a specific link
About

// Or programmatically
const [location, navigate] = useLocation();
navigate("/about", { transition: true });

// Then check for it in your handler
const aroundNav: AroundNavHandler = (navigate, to, options) => {
if (!document.startViewTransition) {
navigate(to, options);
return;
}

if (options?.transition) {
document.startViewTransition(() => {
flushSync(() => {
navigate(to, options);
});
});
} else {
navigate(to, options);
}
};
`

$3

Preact exports are available through a separate package named wouter-preact (or within the
wouter/preact namespace, however this method isn't recommended as it requires React as a peer
dependency):

`diff
- import { useRoute, Route, Switch } from "wouter";
+ import { useRoute, Route, Switch } from "wouter-preact";
`

You might need to ensure you have the latest version of
Preact X with support for hooks.

▶ Demo Sandbox

$3

In order to render your app on the server, you'll need to wrap your app with top-level Router and
specify ssrPath prop (usually, derived from current request). Optionally, Router accepts ssrSearch parameter if need to have access to a search string on a server.

`js
import { renderToString } from "react-dom/server";
import { Router } from "wouter";

const handleRequest = (req, res) => {
// top-level Router is mandatory in SSR mode
// pass an optional context object to handle redirects on the server
const ssrContext = {};
const prerendered = renderToString(



);

if (ssrContext.redirectTo) {
// encountered redirect
res.redirect(ssrContext.redirectTo);
} else {
// respond with prerendered html
}
};
`

Tip: wouter can pre-fill ssrSearch, if ssrPath contains the ? character. So these are equivalent:

`jsx
;

// is the same as
;
`

On the client, the static markup must be hydrated in order for your app to become interactive. Note
that to avoid having hydration warnings, the JSX rendered on the client must match the one used by
the server, so the Router component must be present.

`js
import { hydrateRoot } from "react-dom/client";

const root = hydrateRoot(
domNode,
// during hydration, ssrPath is set to location.pathname,
// ssrSearch set to location.search accordingly
// so there is no need to explicitly specify them



);
`

▶ Demo

$3

Testing with wouter is no different from testing regular React apps. You often need a way to provide a fixture for the current location to render a specific route. This can be easily done by swapping the normal location hook with memoryLocation. It is an initializer function that returns a hook that you can then specify in a top-level Router.

`jsx
import { render } from "@testing-library/react";
import { memoryLocation } from "wouter/memory-location";

it("renders a user page", () => {
// static option makes it immutable
// even if you call navigate somewhere in the app location won't change
const { hook, searchHook } = memoryLocation({ path: "/user/2", static: true });

const { container } = render(

{(params) => <>User ID: {params.id}}

);

expect(container.innerHTML).toBe("User ID: 2");
});
`

Note: When you pass a hook prop to Router, it will automatically inherit the searchHook from the hook if available (via hook.searchHook). This means you don't need to explicitly pass both hook and searchHook when using memoryLocation - just passing hook is enough for useSearch() to work correctly with query parameters.

`jsx
it("works with query parameters", () => {
const { hook } = memoryLocation({ path: "/products?sort=price&order=asc" });

const { result } = renderHook(() => useSearch(), {
wrapper: ({ children }) => {children},
});

expect(result.current).toBe("sort=price&order=asc");
});
`

The hook can be configured to record navigation history. Additionally, it comes with a navigate function for external navigation.

`jsx
it("performs a redirect", () => {
const { hook, history, navigate } = memoryLocation({
path: "/",
// will store navigation history in history
record: true,
});

const { container } = render(


Index
Orders






);

expect(history).toStrictEqual(["/"]);

navigate("/unknown/route");

expect(container.innerHTML).toBe("Orders");
expect(history).toStrictEqual(["/", "/unknown/route", "/orders"]);
});
`

$3

We've got some great news for you! If you're a minimalist bundle-size nomad and you need a damn
simple routing in your app, you can just use bare location hooks. For example, useBrowserLocation hook which is only 650 bytes gzipped
and manually match the current location with it:

`js
import { useBrowserLocation } from "wouter/use-browser-location";

const UsersRoute = () => {
const [location] = useBrowserLocation();

if (location !== "/users") return null;

// render the route
};
`

Wouter's motto is "Minimalist-friendly".

Contributing

Architecture principles:

- All code is written in JavaScript for full control over size optimization
- TypeScript definitions are maintained separately in types/ directories
- wouter-preact reuses the same source except for react-deps.js (Preact-specific hooks)
- Type definitions are duplicated between packages (not ideal, but works for now)

Development: Tests run directly from source files (no build required). Run npm run test for interactive mode or npm run test -- --run for a single run. Use npm run build` to build the distributable package before publishing.

Acknowledgements

Wouter illustrations and logos were made by Katya Simacheva and
Katya Vakulenko. Thank you to @jeetiss
and all the amazing contributors for
helping with the development.