createVueRouterAdapter @vuqs/core/adapters/vue-router

Builds a QueryAdapter backed by vue-router. vue-router is an optional peer dependency, pulled in only if you import this subpath.

Usage

import { createVueRouterAdapter } from '@vuqs/core/adapters/vue-router'

const adapter = createVueRouterAdapter({ defaultOptions: { history: 'replace' } })

Type

function createVueRouterAdapter(options?: VueRouterAdapterOptions): QueryAdapter

Parameters

• options?: VueRouterAdapterOptions
  • router?: Router: the router instance. Defaults to useRouter(), so call inside setup unless you pass it (required in a plugin or main.ts).
  • defaultOptions?: QueryAdapterDefaultOptions: adapter-level navigation defaults.

Return value

• adapter: QueryAdapter
  • Returned without being provided. Pass it to installQueryAdapter or provideQueryAdapter. It reads router.currentRoute.value.query and writes with router.replace, switching to router.push when history is 'push'.
  • navigate resolves for successful and duplicate navigations. Router errors, aborted navigations, and cancelled navigations reject its promise.

Behavior

Nested keys

Nested objects require matching parseQuery/stringifyQuery, for example with qs. Top-level repeated-key arrays work with the default vue-router parser. See Nested keys.

scroll

The adapter applies each write's scroll by wrapping the router's scrollBehavior on its first write. Links, application navigation and back/forward keep your scrollBehavior. See Navigation & options.

VueRouterAdapterOptions

interface VueRouterAdapterOptions {
  router?: Router
  defaultOptions?: QueryAdapterDefaultOptions
}

Related guide

Adapters.