API Documentation • Docs

---

API Documentation / RouterOptions

Interface: RouterOptions

Options to initialize a Router instance.

Extends

• PathParserOptions

Properties

end?

optional end: boolean

Should the RegExp match until the end by appending a $ to it.

Default Value

true

Inherited from

PathParserOptions.end

---

history

history: RouterHistory

History implementation used by the router. Most web applications should use createWebHistory but it requires the server to be properly configured. You can also use a hash based history with createWebHashHistory that does not require any configuration on the server but isn't handled at all by search engines and does poorly on SEO.

Example

createRouter({
  history: createWebHistory(),
  // other options...
})

---

linkActiveClass?

optional linkActiveClass: string

Default class applied to active RouterLink. If none is provided, router-link-active will be applied.

---

linkExactActiveClass?

optional linkExactActiveClass: string

Default class applied to exact active RouterLink. If none is provided, router-link-exact-active will be applied.

---

parseQuery()?

optional parseQuery: (search) => LocationQuery

Custom implementation to parse a query. See its counterpart, RouterOptions.stringifyQuery.

Internal

Transforms a queryString into a LocationQuery object. Accept both, a version with the leading ? and without Should work as URLSearchParams

Parameters

• search: string

search string to parse

Returns

LocationQuery

a query object

Example

Let's say you want to use the qs package to parse queries, you can provide both parseQuery and stringifyQuery:

import qs from 'qs'

createRouter({
  // other options...
  parseQuery: qs.parse,
  stringifyQuery: qs.stringify,
})

---

routes

routes: readonly RouteRecordRaw[]

Initial list of routes that should be added to the router.

---

scrollBehavior?

optional scrollBehavior: RouterScrollBehavior

Function to control scrolling when navigating between pages. Can return a Promise to delay scrolling. Check ScrollBehavior.

Example

function scrollBehavior(to, from, savedPosition) {
  // `to` and `from` are both route locations
  // `savedPosition` can be null if there isn't one
}

---

sensitive?

optional sensitive: boolean

Makes the RegExp case-sensitive.

Default Value

false

Inherited from

PathParserOptions.sensitive

---

strict?

optional strict: boolean

Whether to disallow a trailing slash or not.

Default Value

false

Inherited from

PathParserOptions.strict

---

stringifyQuery()?

optional stringifyQuery: (query) => string

Custom implementation to stringify a query object. Should not prepend a leading ?. parseQuery counterpart to handle query parsing.

Internal

Stringifies a LocationQueryRaw object. Like URLSearchParams, it doesn't prepend a ?

Parameters

• query: LocationQueryRaw

query object to stringify

Returns

string

string version of the query without the leading ?