RouterState type

The RouterState type represents shape of the internal state of the router. The Router's internal state is useful, if you need to access certain internals of the router, such as any pending matches, is the router in its loading state, etc.

type RouterState = {
  status: 'pending' | 'idle'
  isLoading: boolean
  isTransitioning: boolean
  matches: Array<RouteMatch>
  pendingMatches: Array<RouteMatch>
  location: ParsedLocation
  resolvedLocation: ParsedLocation
}

type RouterState = {
  status: 'pending' | 'idle'
  isLoading: boolean
  isTransitioning: boolean
  matches: Array<RouteMatch>
  pendingMatches: Array<RouteMatch>
  location: ParsedLocation
  resolvedLocation: ParsedLocation
}

The RouterState type contains all of the properties that are available on the router state.

• Type: 'pending' | 'idle'
• The current status of the router. If the router is pending, it means that it is currently loading a route or the router is still transitioning to the new route.

• Type: boolean
• true if the router is currently loading a route or waiting for a route to finish loading.

• Type: boolean
• true if the router is currently transitioning to a new route.

• Type: Array<RouteMatch>
• An array of all of the route matches that have been resolved and are currently active.

• Type: Array<RouteMatch>
• An array of all of the route matches that are currently pending.

• Type: ParsedLocation
• The latest location that the router has parsed from the browser history. This location may not be resolved and loaded yet.

• Type: ParsedLocation
• The location that the router has resolved and loaded.