1.5.1 • Published 4 years ago

simple-auto-scroll v1.5.1

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

auto-scroll

一款简单地自动滚动JavaScript插件。

Feature

  • 滚动fps
  • 是否鼠标悬停
  • 支持滚动的过程发请求再次获取数据,可以设置触发请求的条件,默认为滚动1/4即发请求.同时支持滚轮滚动
  • 支持指定滚动多少距离后暂停
  • 支持指定滚动距离后暂停指定时间
  • 支持按照儿子高度自动滚动暂停

Usage

浏览器

<script src="./vendor/auto-scroll.js"></script>
<script>
    new AutoScroll(container, {
        // ...
    })
    // or
    new AutoScroll("#container", {
        // ...
    })
</script>

Webpack

npm i simple-auto-scroll -S
import AutoScroll from "AutoScroll";
// or
// const AutoScroll = require("AutoScroll")

new AutoScroll(container, {
    // ...
})
// or
new AutoScroll("#container", {
    // ...
})

see examples for more details.

Options

namedescriptiontypedefault
fps帧数number60
step每帧行走多少距离(单位:px)number1
hoverStop鼠标悬浮停止滚动booleanfalse
wheel滚轮滚动booleanfalse
suspend指定滚动距离后暂停指定时间booleanfalse
suspendStep表示滚动多少距离后暂停(仅当suspendItem为false有效)number40
suspendItem表示滚动一个子项的高度暂停booleantrue
suspendItemEqual若子项高度均相等,可开启该属性减少查询dom提高性能booleanfalse
suspendTime表示滚动暂停时间(单位:ms)number2000
remote自动发送请求不断获取远程数据。用户需手动停止改状态.用于数据量大循环请求的场景booleanfalse
remoteMethod请求数据方法function(instance, finishRequest)instance:当前实例finishRequest:结束请求,一定要调用!null
remoteCondition发送请求的条件(默认:滚动轴过1/4,发送请求)functionnull
copyScrollContent自定义拷贝方法,显示返回false阻止默认拷贝dom行为functionnull

Api

namedescription参数
getContainer获取容器dom
stopScroll暂停滚动
resumeScroll恢复滚动
isRemote是否发送远程请求获取数据
stopRemote停止发送远程请求
destroy销毁事件