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

前端之家收集整理的这篇文章主要介绍了IScroll5 中文API参数说明和调用方法前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

官网:

IScroll最简单的DOM结构:

  • ...
  • ...
  • ...

    初始化iscroll

    初始化设置

    初始化设置使用实例:

    设置列表:

    所属

    核心库

    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的横轴滚动时,如想使用系统立轴滚动并在横轴上生效,请开启。

    false

    options.freeScroll

    主要在上下左右滚动都生效时使用,可以向任意方向滚动。

    false

    options.keyBindings

    绑定按键事件。

    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

    </td&gt; <td valign="top" align="left"&gt; <p>options.indicators</p> </td&gt; <td valign="top" align="left"&gt; <p>指示IScroll该如何滚动,Scrollbars的底层实现方式。</p> </td&gt; <td valign="top" align="left"&gt; </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.indicators.el</p> </td&gt; <td valign="top" align="left"&gt; <p>制定滚动条的容器。容器中的第一个元素即为指示器。</p> <p>例如:</p> <p>indicators: {</p> <p>el: document.getElementById('indicator')</p> <p>}</p> <p>indicators: {</p> <p>el: '#indicator'</p> <p>}</p> </td&gt; <td valign="top" align="left"&gt; </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.indicators.ignoreBoundaries</p> </td&gt; <td valign="top" align="left"&gt; <p>是否忽略容器边界。设为true 可以设置滚动速度</p> <p><a target="_blank" href="http://lab.cubiq.org/iscroll5/demos/parallax/"&gt;parallax demo</a></p> </td&gt; <td valign="top" align="left"&gt; <p>false</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.indicators.listenX</p> <p>options.indicators.listenY</p> </td&gt; <td valign="top" align="left"&gt; <p>指示器监听那个方向的滚动,可以设置为一个方向或2个方向</p> </td&gt; <td valign="top" align="left"&gt; <p>true</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.indicators.speedRatioX</p> <p>options.indicators.speedRatioY</p> </td&gt; <td valign="top" align="left"&gt; <p>指示器相对主滚动条的速度</p> </td&gt; <td valign="top" align="left"&gt; <p>0</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.indicators.fade</p> <p>options.indicators.interactive</p> <p>options.indicators.resize</p> <p>options.indicators.shrink</p> </td&gt; <td valign="top" align="left"&gt; <p>如scrollbars的设置</p> <p><a target="_blank" href="http://lab.cubiq.org/iscroll5/demos/minimap/"&gt;minimap demo</a></p> </td&gt; <td valign="top" align="left"&gt; </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.probeType</p> </td&gt; <td valign="top" align="left"&gt; <p>需要使用iscroll-probe.js才能生效</p> <p>probeType:1 滚动不繁忙的时候触发</p> <p>probeType:2 滚动时每隔一定时间触发</p> <p>probeType:3 每滚动一像素触发一次</p> </td&gt; <td valign="top" align="left"&gt; </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>分割<a href="/tag/yemian/" target="_blank" class="keywords">页面</a>snap</p> </td&gt; <td valign="top" align="left"&gt; <p>options.snap</p> </td&gt; <td valign="top" align="left"&gt; <p><a href="/tag/zidong/" target="_blank" class="keywords">自动</a>分割容器,用于制作走马灯<a href="/tag/xiaoguo/" target="_blank" class="keywords">效果</a>等。</p> <p>Options.snap:true//根据容器尺寸<a href="/tag/zidong/" target="_blank" class="keywords">自动</a>分割</p> <p>Options.snap:el//根据元素分割</p> </td&gt; <td valign="top" align="left"&gt; <p>false</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" rowspan="5" align="left"&gt; <p>缩放</p> <p>zoom</p> </td&gt; <td valign="top" align="left"&gt; <p>options.zoom</p> </td&gt; <td valign="top" align="left"&gt; <p>是否打开缩放</p> <p>最好使用iscroll-zoom.js</p> <p>如放大模糊,可将源容器定义为2倍大小,然后scale(0.5)</p> <p><a target="_blank" href="http://lab.cubiq.org/iscroll5/demos/zoom/"&gt;zoom demo</a></p> </td&gt; <td valign="top" align="left"&gt; <p>false</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.zoomMax</p> </td&gt; <td valign="top" align="left"&gt; <p>最大缩放等级</p> </td&gt; <td valign="top" align="left"&gt; <p>4</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.zoomMin</p> </td&gt; <td valign="top" align="left"&gt; <p>最小缩放等级</p> </td&gt; <td valign="top" align="left"&gt; <p>1</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.startZoom</p> </td&gt; <td valign="top" align="left"&gt; <p>初始缩放等级</p> </td&gt; <td valign="top" align="left"&gt; <p>1</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.wheelAction</p> </td&gt; <td valign="top" align="left"&gt; <p>滚轮动作</p> <p>设为'zoom',可以用滚轮缩放</p> </td&gt; <td valign="top" align="left"&gt; <p>undefined</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" rowspan="7" align="left"&gt; <p>更多设置</p> </td&gt; <td valign="top" align="left"&gt; <p>options.bindToWrapper</p> </td&gt; <td valign="top" align="left"&gt; <p>光标、触摸超出容器时,是否停止滚动</p> </td&gt; <td valign="top" align="left"&gt; <p>false</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.bounceEasing</p> </td&gt; <td valign="top" align="left"&gt; <p>弹力动画效果</p> <p>预置效果:'quadratic','circular','back','bounce','elastic'(最后两个不能通过css3表现)</p> <p>还可以自定义效果</p> <p>bounceEasing: {</p> <p>style: 'cubic-bezier(0,1,1)',//css3时</p> <p>fn: function (k) { return k; }//不使用css3,使用requestAnimationFrame时</p> <p>}</p> </td&gt; <td valign="top" align="left"&gt; <p>'circular'</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.bounceTime</p> </td&gt; <td valign="top" align="left"&gt; <p>弹力动画持续的毫秒数</p> </td&gt; <td valign="top" align="left"&gt; <p>600</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.deceleration</p> </td&gt; <td valign="top" align="left"&gt; <p>滚动动量减速</p> <p>越大越快,建议不大于0.01</p> </td&gt; <td valign="top" align="left"&gt; <p>0.0006</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.mouseWheelSpeed</p> </td&gt; <td valign="top" align="left"&gt; <p>鼠标滚轮速度</p> </td&gt; <td valign="top" align="left"&gt; </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.preventDefaultException</p> </td&gt; <td valign="top" align="left"&gt; <p>列出哪些元素不屏蔽默认事件;</p> </td&gt; <td valign="top" align="left"&gt; <p>{tagName: /^(INPUT|TEXTAREA|BUTTON|SELECT)$/ }</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>options.resizePolling</p> </td&gt; <td valign="top" align="left"&gt; <p>重新调整窗口大小时,重新计算IScroll的时间间隔</p> </td&gt; <td valign="top" align="left"&gt; <p>60</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>键位绑定</p> </td&gt; <td valign="top" align="left"&gt; <p>options.keyBindings</p> </td&gt; <td valign="top" align="left"&gt; <p>监听按键事件控制IScroll</p> <p>例如:</p> <p>keyBindings: {</p> <p>pageUp: 33,</p> <p>pageDown: 34,</p> <p>end: 35,</p> <p>home: 36,</p> <p>left: 37,</p> <p>up: 38,</p> <p>right: 39,</p> <p>down: 40</p> <p>}</p> </td&gt; <td valign="top" align="left"&gt; </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; </td&gt; <td valign="top" align="left"&gt;</td&gt; <td valign="top" align="left"&gt;</td&gt; <td valign="top" align="left"&gt;</td&gt; </tr&gt;

    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);

    </td&gt; <td valign="top" align="left"&gt; <p>scrollBy(x,easing)</p> </td&gt; <td valign="top" align="left"&gt; <p>滚动到相对于当前位置的某处</p> <p>其余同上</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; </td&gt; <td valign="top" align="left"&gt; <p>scrollToElement(el,offsetX,offsetY,easing)</p> </td&gt; <td valign="top" align="left"&gt; <p>滚动到某个元素。el为必须的参数</p> <p>offsetX/offsetY:相对于el元素的位移。设为true即为屏幕中心</p> <p><a target="_blank" href="http://lab.cubiq.org/iscroll5/demos/scroll-to-element/"&gt;scroll to element</a></p> </td&gt; </tr&gt; <tr&gt; <td valign="top" rowspan="2" align="left"&gt; <p>分割<a href="/tag/yemian/" target="_blank" class="keywords">页面</a>snap</p> </td&gt; <td valign="top" align="left"&gt; <p>goToPage(x,easing)</p> </td&gt; <td valign="top" align="left"&gt; <p>根据options.snap分割<a href="/tag/yemian/" target="_blank" class="keywords">页面</a>,<a href="/tag/tiaozhuan/" target="_blank" class="keywords">跳转</a>到横向、纵向某页。XY可以同时生效。</p> <p>结合options.snap使用</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>next()</p> <p>prev()</p> </td&gt; <td valign="top" align="left"&gt; <p><a href="/tag/shangyiye/" target="_blank" class="keywords">上一页</a>,<a href="/tag/xiayiye/" target="_blank" class="keywords">下一页</a></p> <p>结合options.snap使用</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>缩放</p> </td&gt; <td valign="top" align="left"&gt; <p>zoom(scale,x,time)</p> </td&gt; <td valign="top" align="left"&gt; <p>缩放容器</p> <p>Scale:缩放因子</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>刷新</p> </td&gt; <td valign="top" align="left"&gt; <p>refresh()</p> </td&gt; <td valign="top" align="left"&gt; <p>刷新IScroll</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt; <p>销毁</p> </td&gt; <td valign="top" align="left"&gt; <p>destroy()</p> </td&gt; <td valign="top" align="left"&gt; <p>销毁IScroll,节省资源</p> </td&gt; </tr&gt; <tr&gt; <td valign="top" align="left"&gt;</td&gt; <td valign="top" align="left"&gt;</td&gt; <td valign="top" align="left"&gt;</td&gt; </tr&gt;

    IScroll的事件:

    方法名

    说明

    beforeScrollStart

    scrollCancel

    初始化滚动后又取消

    scrollStart

    开始滚动

    scroll

    滚动中

    scrollEnd

    滚动结束

    flick

    轻击屏幕左、右

    zoomStart

    开始缩放

    zoomEnd

    缩放结束

    事件使用实例:

    IScroll的属性

    用户点击屏幕,但是还未初始化滚动前

    myScroll.x/y

    myScroll.directionX/Y

    上一次的滚动方向(-1 下/右,0 保持原状,1 上/左)

    myScroll.currentPage

    当前Snap信息

    myScroll.maxScrollXmyScroll.maxScrollY

    当滚动到底部时的 myScroll.x/y

      </td&gt;
    </tr&gt;

    猜你在找的JavaScript相关文章

    当前位置