Documentation

Router overview

The role of @plumile/router and the main concepts it exposes.

@plumile/router is a type-safe React router. It focuses on explicit route configuration, typed navigation, Suspense-compatible route resources, query and filter integration, and instrumentation.

Main concepts

  • A route describes a path, optional children, route rendering, and optional preparation logic.
  • A router instance owns the routing context and cleanup lifecycle.
  • RoutingContext provides router state to React.
  • RouterRenderer renders the active route and fallback UI.
  • Link and navigation hooks keep navigation inside the typed router contract.

When to use it

Use the router when an application needs route definitions to be explicit, typed, and connected to URL state or preload behavior. Use @plumile/filter-query with it when the route search string carries structured filter state.