Plugins

Plugins are a way to extend the router with additional functionality. They are used to add routes and rejections to the router.

import { createRejection, createRoute, createRouterPlugin } from '@kitbag/router'

const routes = [
  createRoute({ name: 'home', path: '/' }),
] as const

const rejections = [
  createRejection({ type: 'RequiresAuth' }),
] as const

const plugin = createRouterPlugin({
  routes,
  rejections,
})

Installing

Pass plugins as the third argument to createRouter. Their routes, rejections, and hooks become available on that router.

import { createRouter } from '@kitbag/router'

const router = createRouter([], {}, [plugin])

The first argument can contain your application's own routes, and the second contains the usual router options.

Hooks

Plugins can also define global Hooks.

plugin.onBeforeRouteEnter(() => {
  console.log('before route enter')
})