provideBrowserHistoryAdapter @vuqs/core/adapters/browser-history

Creates a browser History API adapter and provides it to descendant components.

Usage

import { provideBrowserHistoryAdapter } from '@vuqs/core/adapters/browser-history'

provideBrowserHistoryAdapter({ defaultOptions: { history: 'replace' } })

Type

function provideBrowserHistoryAdapter(options?: BrowserHistoryAdapterOptions): BrowserHistoryAdapter

Parameters

• options?: BrowserHistoryAdapterOptions
  • The same options as createBrowserHistoryAdapter.

Return value

• adapter: BrowserHistoryAdapter
  • The created adapter, already provided. Call from a component setup in the browser.
  • Disposed automatically when the component's effect scope stops.

Related guide

Adapters.