Router

The following cover the API exposed by a Router (check out how to create one).

Router.{RouteName}

The Router has one per route. Takes the route params (if it has some), and returns a built URL.

• params: Required params for the route.

Router.UserDetail({ userId: "123" }); // "/users/123"

Router.useRoute

Takes an array of routes to listen to (a subset of the router), and returns the route and its params if one matches.

• routes (required): RouteName[]

Returns a route match (or undefined if nothing matches):

• name: a route name
• params: its associated params

const route = Router.useRoute(["Home", "UserArea"]);

// then match on the route

Router.getRoute

Takes an array of routes (a subset of the router), and returns the route and its params if one matches.

• routes (required): RouteName[]

Returns a route match (or undefined if nothing matches):

• name: a route name
• params: its associated params

const route = Router.getRoute(["Home", "UserArea"]);

Router.push

Takes a route name and its associated params and navigates to it

• name: a route name
• params: its associated params

Router.push("Home");
Router.push("UserDetail", { userId: "123" });

Router.replace

Takes a route name and its associated params and navigates to it without creating a new entry in the browser history.

• name: a route name
• params: its associated params

Router.replace("Home");
Router.replace("UserDetail", { userId: "123" });

Router.P.{RouteName}

Provides ts-pattern interop.

const Router = createRouter({
  Home: "/",
  UserArea: "/users/*",
  User: "/users/:userId",
});

const App = () => {
  const route = Router.useRoute(["Home", "UserArea", "User"]);

  return match(route)
    .with(Router.P.Home(P._), () => <Home />)
    .with(Router.P.UserArea(P._), () => <UserArea />)
    .with(Router.P.User({ userId: P.select() }), (id) => <User id={id} />)
    .otherwise(() => null);
};