# vue-router-better-scroller

> [![NPM version](https://img.shields.io/npm/v/vue-router-better-scroller?color=a1b858&label=)](https://www.npmjs.com/package/vue-router-better-scroller)

Latest version **0.0.0** (published 2023-06-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-router-better-scroller
pnpm add vue-router-better-scroller
yarn add vue-router-better-scroller
bun add vue-router-better-scroller
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2023-06-07 |
| First published | 2023-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 335 |
| Author | Anthony Fu |
| Maintainers | antfu |

## Links

- npm: https://www.npmjs.com/package/vue-router-better-scroller
- Repository: https://github.com/antfu/vue-router-better-scroller
- Homepage: https://github.com/antfu/vue-router-better-scroller#readme
- Issues: https://github.com/antfu/vue-router-better-scroller/issues
- Funding: https://github.com/sponsors/antfu
- npm.io page: https://npm.io/package/vue-router-better-scroller

## Recent versions

- 0.0.0 (latest) — 2023-06-07

## README

# vue-router-better-scroller

[![NPM version](https://img.shields.io/npm/v/vue-router-better-scroller?color=a1b858&label=)](https://www.npmjs.com/package/vue-router-better-scroller)

Enhanced [scroll behavior](https://router.vuejs.org/guide/advanced/scroll-behavior.html) for [Vue Router v4](https://router.vuejs.org/).

## Motivation

Vue Router currently only preserves the scrolling state on the `window` object. Sometimes, in your apps you might have a different scrollable element (e.g. `body`, `#app`) or even multiple ones. To gain a better user experience, we typically want to preserve the scroll state of them when going back and forth.

This plugin is introduced to experiment with a better way to handle such cases. With a lot of help from [@posva](https://github.com/posva) 🙏.

## Install

```bash
npm i vue-router-better-scroller
```

In your main entry:
  
```ts
import { createRouter } from 'vue-router'
import { createRouterScroller } from 'vue-router-better-scroller'
import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)
const router = createRouter({
  history: createWebHistory(),
  routes
})

app.use(router)
app.use(createRouterScroller({
  selectors: {
    'window': true,
    'body': true,
    '.scrollable': true
  },
}))

app.mount('#app')
```

## Options

// TODO

## Sponsors

<p align="center">
  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
  </a>
</p>

## License

[MIT](./LICENSE) License © 2022 [Anthony Fu](https://github.com/antfu)

---
_Source: https://npm.io/package/vue-router-better-scroller · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._