IScroll5 中文API参数说明和调用方法


Posted in Javascript onMay 21, 2016

官网:http://iscrolljs.com/

IScroll最简单的DOM结构:

<div id="wrapper"> 
 <ul> 
 <li>...</li> 
 <li>...</li> 
 ... 
 </ul> 
</div>

初始化iscroll

var myScroll = new IScroll('#wrapper',options);

初始化设置

初始化设置使用实例:

var myScroll = new IScroll('#wrapper', { 
 mouseWheel: true, 
 scrollbars: true 
});

设置列表:

所属 属性名 说明 默认值
核心库 croe options.useTransform 是否使用CSS3的Transform属性 true
options.useTransition 是否使用CSS3的Transition属性,否则使用requestAnimationFram代替 true
options.HWCompositing 是否启用硬件加速 true
options.bounce 是否启用弹力动画效果,关掉可以加速 true
基础特性 Basic features options.click 是否启用click事件。建议关闭此选项并启用自定义的tap事件(options.tap) false
options.disableMouse 是否关闭鼠标事件探测。如知道运行在哪个平台,可以开启它来加速。 false
options.disablePointer 是否关闭指针事件探测。如知道运行在哪个平台,可以开启它来加速。 false
options.disableTouch 是否关闭触摸事件探测。如知道运行在哪个平台,可以开启它来加速。 false
options.eventPassthrough 使用IScroll的横轴滚动时,如想使用系统立轴滚动并在横轴上生效,请开启。 event passthrough demo false
options.freeScroll 主要在上下左右滚动都生效时使用,可以向任意方向滚动。 2D scroll demo false
options.keyBindings 绑定按键事件。 Key bindings false
options.invertWheelDirection 反向鼠标滚轮。 false
options.momentum 是否开启动量动画,关闭可以提升效率。 true
options.mouseWheel 是否监听鼠标滚轮事件。 false
options.preventDefault 是否屏蔽默认事件。 true
options.scrollbars 是否显示默认滚动条 false
options.scrollX options.scrollY 可以设置是否显示横向或纵向滚动条 scrollX false scrollY true
options.tap 是否启用自定义的tap事件 可以自定义tap事件名 false
滚动条 Scrollbars options.scrollbars 是否显示默认滚动条 false
options.fadeScrollbars 是否渐隐滚动条,关掉可以加速 true
options.interactiveScrollbars 用户是否可以拖动滚动条 false
options.resizeScrollbars 是否固定滚动条大小,建议自定义滚动条时可开启。 false
options.shrinkScrollbars 滚动超出滚动边界时,是否收缩滚动条。 ‘clip':裁剪超出的滚动条 ‘scale':按比例的收缩滚动条(占用CPU资源) false:不收缩, false
options.indicators 指示IScroll该如何滚动,Scrollbars的底层实现方式。
options.indicators.el 制定滚动条的容器。容器中的第一个元素即为指示器。 例如: indicators: { el: document.getElementById('indicator') } indicators: { el: '#indicator' }
options.indicators.ignoreBoundaries 是否忽略容器边界。设为true 可以设置滚动速度 parallax demo false
options.indicators.listenX options.indicators.listenY 指示器监听那个方向的滚动,可以设置为一个方向或2个方向 true
options.indicators.speedRatioX options.indicators.speedRatioY 指示器相对主滚动条的速度 0
options.indicators.fade options.indicators.interactive options.indicators.resize options.indicators.shrink 如scrollbars的设置 minimap demo
options.probeType 需要使用iscroll-probe.js才能生效 probeType:1 滚动不繁忙的时候触发 probeType:2 滚动时每隔一定时间触发 probeType:3 每滚动一像素触发一次
分割页面snap options.snap 自动分割容器,用于制作走马灯效果等。 Options.snap:true//根据容器尺寸自动分割 Options.snap:el//根据元素分割 false
缩放 zoom options.zoom 是否打开缩放 最好使用iscroll-zoom.js 如放大模糊,可将源容器定义为2倍大小,然后scale(0.5) zoom demo false
options.zoomMax 最大缩放等级 4
options.zoomMin 最小缩放等级 1
options.startZoom 初始缩放等级 1
options.wheelAction 滚轮动作 设为'zoom',可以用滚轮缩放 undefined
更多设置 options.bindToWrapper 光标、触摸超出容器时,是否停止滚动 false
options.bounceEasing 弹力动画效果 预置效果:'quadratic', 'circular', 'back', 'bounce', 'elastic'(最后两个不能通过css3表现) 还可以自定义效果 bounceEasing: { style: 'cubic-bezier(0,0,1,1)',//css3时 fn: function (k) { return k; }//不使用css3,使用requestAnimationFrame时 } 'circular'
options.bounceTime 弹力动画持续的毫秒数 600
options.deceleration 滚动动量减速 越大越快,建议不大于0.01 0.0006
options.mouseWheelSpeed 鼠标滚轮速度
options.preventDefaultException 列出哪些元素不屏蔽默认事件; {tagName: /^(INPUT|TEXTAREA|BUTTON|SELECT)$/ }
options.resizePolling 重新调整窗口大小时,重新计算IScroll的时间间隔 60
键位绑定 options.keyBindings 监听按键事件控制IScroll 例如: keyBindings: { pageUp: 33, pageDown: 34, end: 35, home: 36, left: 37, up: 38, right: 39, down: 40 }

IScroll5的API:

所属 方法名 说明
滚动 scrollTo(x, y, time, easing) 滚动到:x,y,事件,easing方式 x:int y:int time:int Easing: quadratic | circular | back | bounce | elastic 见IScroll.utils.ease 对象 例: myScroll.scrollTo(0, -100, 1000, IScroll.utils.ease.elastic);
scrollBy(x, y, time, easing) 滚动到相对于当前位置的某处 其余同上
scrollToElement(el, time, offsetX, offsetY, easing) 滚动到某个元素。el为必须的参数 offsetX/offsetY:相对于el元素的位移。设为true即为屏幕中心 scroll to element
分割页面snap goToPage(x, y, time, easing) 根据options.snap分割页面,跳转到横向、纵向某页。XY可以同时生效。 结合options.snap使用
next() prev() 上一页,下一页 结合options.snap使用
缩放 zoom(scale, x, y, time) 缩放容器 Scale:缩放因子
刷新 refresh() 刷新IScroll
销毁 destroy() 销毁IScroll,节省资源

IScroll的事件:

beforeScrollStart 用户点击屏幕,但是还未初始化滚动前
scrollCancel 初始化滚动后又取消
scrollStart 开始滚动
scroll 滚动中
scrollEnd 滚动结束
flick 轻击屏幕左、右
zoomStart 开始缩放
zoomEnd 缩放结束

事件使用实例:

myScroll = new IScroll('#wrapper'); 
myScroll.on('scrollEnd', doSomething);

IScroll的属性:

myScroll.x/y 当前位置
myScroll.directionX/Y 上一次的滚动方向(-1 下/右, 0 保持原状, 1 上/左)
myScroll.currentPage 当前Snap信息
myScroll.maxScrollXmyScroll.maxScrollY 当滚动到底部时的 myScroll.x/y
Javascript 相关文章推荐
改版了网上的一个js操作userdata
Apr 27 Javascript
跨浏览器开发经验总结(四) 怎么写入剪贴板
May 13 Javascript
深入理解JavaScript系列(22):S.O.L.I.D五大原则之依赖倒置原则DIP详解
Mar 05 Javascript
js实现简单秒表走动的时钟特效
Mar 25 Javascript
详谈$.data()的用法和作用
Feb 13 Javascript
js中的触发事件对象event.srcElement与event.target详解
Mar 15 Javascript
ionic grid(栅格)九宫格制作详解
Jun 30 Javascript
详解vue填坑之解决部分浏览器不支持pushState方法
Jul 12 Javascript
在JS循环中使用async/await的方法
Oct 12 Javascript
微信小程序开发之tabbar图标和颜色的实现
Oct 17 Javascript
react 不用插件实现数字滚动的效果示例
Apr 14 Javascript
vue项目实现多语言切换的思路
Sep 17 Javascript
JavaScript的ExtJS框架中表格的编写教程
May 21 #Javascript
基于HTML5上使用iScroll实现下拉刷新,上拉加载更多
May 21 #Javascript
jQuery插件pagination实现无刷新分页
May 21 #Javascript
JavaScript中对JSON对象的基本操作示例
May 21 #Javascript
iscroll碰到Select无法选择下拉刷新的解决办法
May 21 #Javascript
jQuery EasyUI Pagination实现分页的常用方法
May 21 #Javascript
总结JavaScript设计模式编程中的享元模式使用
May 21 #Javascript
You might like
PHP include任意文件或URL介绍
2014/04/29 PHP
php常用表单验证类用法实例
2015/06/18 PHP
解决yii2左侧菜单子级无法高亮问题的方法
2016/05/08 PHP
PHP实现的多维数组去重操作示例
2018/07/21 PHP
postman的安装与使用方法(模拟Get和Post请求)
2018/08/06 PHP
JQuery 实现的页面滚动时浮动窗口控件
2009/07/10 Javascript
一些相见恨晚的 JavaScript 技巧
2010/04/25 Javascript
jquery下实现overlay遮罩层代码
2010/08/25 Javascript
ASP.NET jQuery 实例8 (动态添加内容到DropDownList)
2012/02/03 Javascript
javascript如何动态加载表格与动态添加表格行
2013/11/27 Javascript
jquery实现显示已选用户
2014/07/21 Javascript
jquery动态改变div宽度和高度
2015/02/09 Javascript
javascript框架设计之框架分类及主要功能
2015/06/23 Javascript
JavaScript实现给按钮加上双重动作的方法
2015/08/14 Javascript
JavaScript创建对象_动力节点Java学院整理
2017/06/27 Javascript
JS+H5 Canvas实现时钟效果
2018/07/20 Javascript
mpvue微信小程序多列选择器用法之省份城市选择的实现
2019/03/07 Javascript
element-ui 文件上传修改文件名的方法示例
2019/11/05 Javascript
vue实现用户长时间不操作自动退出登录功能的实现代码
2020/07/23 Javascript
[00:32]2018DOTA2亚洲邀请赛VG出场
2018/04/03 DOTA
Python实现短网址ShortUrl的Hash运算实例讲解
2015/08/10 Python
Python3中的真除和Floor除法用法分析
2016/03/16 Python
Python变量和字符串详解
2017/04/29 Python
python中类和实例如何绑定属性与方法示例详解
2017/08/18 Python
python 使用poster模块进行http方式的文件传输到服务器的方法
2019/01/15 Python
Django异步任务之Celery的基本使用
2019/03/23 Python
Django admin model 汉化显示文字的实现方法
2019/08/12 Python
python修改linux中文件(文件夹)的权限属性操作
2020/03/05 Python
如何把外网python虚拟环境迁移到内网
2020/05/18 Python
师范学院美术系毕业生自我鉴定
2014/01/29 职场文书
法律进学校实施方案
2014/03/15 职场文书
聘用意向书范本
2014/04/01 职场文书
小班下学期评语
2014/05/04 职场文书
2014年房地产个人工作总结
2014/12/20 职场文书
MySQL中VARCHAR与CHAR格式数据的区别
2021/05/26 MySQL
python使用torch随机初始化参数
2022/03/22 Python