Skip to content

Upgrading to 0.20.8 ​

Deprecations ​

Hook options ​

Move lifecycle hook properties from router options to router methods. A global hook runs for all matching navigations, so preserve route-specific behavior by checking the route.

ts
// Before
const router = createRouter(routes, {
  onBeforeRouteEnter: callback,
})

// After
const router = createRouter(routes)
router.onBeforeRouteEnter(callback)

Route instance registration methods arrive in 0.20.11; use those when upgrading beyond this release. The old options are removed in 0.21.0.

Registered helper types ​

Replace RegisteredRoutes, RegisteredRoutesName, RegisteredRejectionType, RegisteredRouterPush, RegisteredRouterReplace, and RegisteredRouterReject annotations with types inferred from your router.

ts
// Before
type Navigate = RegisteredRouterPush

// After
type Navigate = typeof router.push

For route and rejection names, derive the type from your definitions or use router-specific types such as RouterRouteName<typeof router>. These helpers are removed in 0.21.0. See Type Safety.

Full release notes.