Docs
CodeRabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Prisma
Strapi
Unkey
Fireship
CodeRabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Prisma
Strapi
Unkey
Fireship
Integrations

RouteMask type

The RouteMask type extends the ToOptions type and has other the necessary properties to create a route mask.

RouteMask properties

The RouteMask type accepts an object with the following properties:

...ToOptions

  • Type: ToOptions
  • Required
  • The options that will be used to configure the route mask

options.routeTree

  • Type: TRouteTree
  • Required
  • The route tree that this route mask will support

options.unmaskOnReload

  • Type: boolean
  • Optional
  • If true, the route mask will be removed when the page is reloaded