Types: RouterOptions

type RouterOptions = WithHooks & object;

Options to initialize a Router instance.

Type declaration

base?

optional base: string;

Base path to be prepended to any URL. Can be used for Vue applications that run in nested folder for domain. For example having base of /foo would assume all routes should start with your.domain.com/foo.

historyMode?

optional historyMode: RouterHistoryMode;

Specifies the history mode for the router, such as "browser", "memory", or "hash".

Default

"auto"

initialUrl?

optional initialUrl: string;

Initial URL for the router to use. Required if using Node environment. Defaults to window.location when using browser.

Default

window.location.toString()

isGlobalRouter?

optional isGlobalRouter: boolean;

When false, createRouterAssets must be used for component and hooks. Assets exported by the library will not work with the created router instance.

Default

true

prefetch?

optional prefetch: PrefetchConfig;

Determines what assets are prefetched when router-link is rendered for a specific route

rejections?

optional rejections: Partial<Record<string, Component>>;

Components assigned to each type of rejection your router supports.