{"library":"vue3-smooth-scroll","type":"library","category":null,"description":"vue3-smooth-scroll is a lightweight, actively maintained Vue 3 plugin dedicated to facilitating smooth scrolling experiences within web applications. It provides two primary methods for implementation: a declarative directive (`v-smooth-scroll`) that can be applied directly to anchor tags, and a more flexible programmatic API accessible through `this.$smoothScroll` in the Options API or `inject('smoothScroll')` within the Composition API. The plugin's design prioritizes Vue 3 compatibility, including robust Server-Side Rendering (SSR) support, which was recently improved in version 0.8.1 to address `window is not defined` errors. It uses `requestAnimationFrame` for efficient, non-blocking animations, with a graceful fallback for broader compatibility across different browser environments. Key features include Y-axis scrolling, the ability to define specific scroll containers, configurable animation duration, offset, and custom easing functions, providing a high degree of customization for scroll behavior. Its small bundle size (approximately 1.4kB gzipped) makes it a performant choice, offering significantly more advanced control and a programmatic interface compared to the native `scroll-behavior` CSS property, especially for intricate scrolling requirements or dynamic content. Releases appear to be driven by bug fixes and compatibility updates rather than a strict schedule, with 0.8.1 being the current stable version.","language":"javascript","status":"active","version":"0.8.1","tags":["javascript","vue","smooth","scroll","typescript"],"last_verified":"Wed May 27","install":[{"cmd":"npm install vue3-smooth-scroll","imports":["import VueSmoothScroll from 'vue3-smooth-scroll'","const smoothScroll = inject('smoothScroll')","import type { SmoothScrollOptions } from 'vue3-smooth-scroll'"]},{"cmd":"yarn add vue3-smooth-scroll","imports":[]},{"cmd":"pnpm add vue3-smooth-scroll","imports":[]}],"homepage":null,"github":"https://github.com/laineus/vue3-smooth-scroll","docs":null,"changelog":null,"pypi":null,"npm":"https://www.npmjs.com/package/vue3-smooth-scroll","openapi_spec":null,"status_page":null,"smithery":null,"compatibility":{"summary":{"python_range":"18–22","success_rate":0,"avg_install_s":null,"avg_import_s":null,"wheel_type":null},"url":"https://checklist.day/v1/registry/vue3-smooth-scroll/compatibility"}}