vue-seamless-scroll
A simple, Seamless scrolling for Vue.js
Content
Browser supportFeaturesInstallationUsageConfigureEventsIndividual special configuration itemsChangelogIssues solutionCaresContribution
Browser support
 IE |  Firefox |  Chrome |  Safari |  iOS |  Android |
|---|---|---|---|---|---|
| IE9+ | β | β | β | β | β |
Features
- base on requestAnimationFrame
- the configuration meets a variety of requirements.
- current support for seamless scrolling, single-step scrolling, and manual switching support for horizontal direction.
- ongoing maintenance
Installation
NPM
npm install vue-seamless-scroll --saveCDN
https://cdn.jsdelivr.net/npm/[email protected]/dist/vue-seamless-scroll.min.js
Usage
ES6
// **main.js** // 1.global install import Vue from 'vue' import scroll from 'vue-seamless-scroll' Vue.use(scroll) //or you can set componentName default componentName is vue-seamless-scroll Vue.use(scroll,{componentName: 'scroll-seamless'}) // 2.single .vue import <script> import vueSeamless from 'vue-seamless-scroll' export default { components: { vueSeamless } } </script>Normal use
Example:
Specific reference test/test.html
<html> <head> ... </head> <body> <div id="app"> <vue-seamless-scroll></vue-seamless-scroll> </div> <script src="vue.js"></script> <script src="vue-seamless-scroll"></script> <script> new Vue({ el: '#app' }) </script> </body> </html>Configure
| key | description | default | val |
|---|---|---|---|
step | the faster the rolling speed is faster | 1 | Number |
limitMoveNum | start seamless scrolling minimum data length | 5 | Number |
hoverStop | mouse hover control is enabled | true | Boolean |
direction | 0 downγ 1 up γ 2 left γ 3 right | 1 | Number |
openTouch | open mobile touch | true | Boolean |
singleHeight | one single stop height(default zero is seamless) => direction 0/1 | 0 | Number |
singleWidth | one single stop width(default zero is seamless) => direction 2/3 | 0 | Number |
waitTime | one single data stop wait time(ms) | 1000 | Number |
switchOffset | the left and right buttons distance from the left and right sides (px) | 30 | Number |
autoPlay | whether or not to automatically play the switch needs to be set to false | true | Boolean |
switchSingleStep | the size of a single step switch (px) | 134 | Number |
switchDelay | the animation time of a single step switch(ms) | 400 | Number |
switchDisabledClass | the className of the switch parent element that cannot be clicked | disabled | String |
isSingleRemUnit | singleHeight and singleWidth Whether to enable the rem metric | false | Boolean |
Events
| name | description | calback params |
|---|---|---|
ScrollEnd | A roll-through callback event | null |
Individual special configuration items
1.The outermost container needs to be set manually
width height overflow:hidden
2.The left and right seamless rolling needs to be set for the main content area (that is, the default slot slots)
css width(otherwise, the actual width cannot be calculated correctly)
3.The step value is not recommended to be too small, otherwise there will be carton effect.
4.You need to set when you need to manually switch left and right to scroll
autoPlay:false,(The loop is not currently supported.)
5.Provides
slot left-switch || right-switchyou can freely define the button styles you want. The outer div is positioned in the middle,the distance from both sides can be adjusted by the switchOffset parameter.
6.When the button reaches the boundary position, it automatically adds a definition to the state button that cannot be clicked.
switchDisabledClass: 'disabled',you can configure it as needed.
Issues solution
Changelog
See the GitHub release history.
Cares
If you want js to scroll seamlessly (without dependencies) you can switch to here.seamscrollγ
Contribution
Welcome to give some Suggestions and optimizations, and look forward to your Pull Request.
License
vue-seamless-scroll is open source and released under the MIT License.
