@gluonjs/router / packages/router/src / RouterOptions

Interface: RouterOptions

Properties

history

readonly history: RouterHistory

routes

readonly routes: readonly RouteRecordRaw[]

scrollBehavior?

readonly optional scrollBehavior?: ScrollBehavior

Example

Configure a memory-backed router and restore a saved scroll position during back/forward navigation:

import { createRouter, type RouterOptions } from '@gluonjs/router';
import { createMemoryHistory } from '@gluonjs/router/memory';

const options = {
  history: createMemoryHistory(['/products']),
  routes: [{ path: '/products' }],
  scrollBehavior(_to, _from, savedPosition) {
    return savedPosition ?? { left: 0, top: 0 };
  },
} satisfies RouterOptions;

const router = createRouter(options);
await router.isReady();
console.log(router.currentRoute.value.fullPath); // '/products'
router.destroy();