vuepress / core / 42596277770

74%

push

github

refactor(client)!: replace deprecated scrollBehavior with ScrollRestoration (#1727) (close #1726)

`vue-router` 5.4 deprecates the router `scrollBehavior` option in favor of the
`ScrollRestoration` plugin and `useScrollRestoration()`.

- bump the `vue-router` catalog to `^5.4.0`
- install `ScrollRestoration` before the router in `createVueApp()`
- drop `scrollBehavior` from `createVueRouter()`

VuePress renders the page layout directly instead of wrapping it in a
`<RouterView>`, so the restoration provided by `onRouteRendered` would run
before the new page is rendered. `useScrollRestoration()` is therefore
registered with `manual: true`, and the scroll is restored after mounting and
after each route change.

BREAKING CHANGE: `router.options.scrollBehavior` is no longer set. Packages
that read or wrap it, e.g. to defer the scroll until their page transition is
done, need to be migrated.

412 of 552 branches covered (74.64%)

Branch coverage included in aggregate %.

800 of 1087 relevant lines covered (73.6%)

48.32 hits per line