参数文档

当前位置格晒特效查看agilebins的参数具体说明

V1.04

初步了解认识

Agilebins是一个基于jQuery运行的开源特效插件,快速解决网页大部分特效。
使用简单,维护方便。无需懂得js代码编写。轻松制作,导航菜单、幻灯片、焦点图、公告跑马灯、图片
滚动,选项卡内容切换、手风琴折叠效果等。兼容 IE6+ Safari Opera Firefox Chrome 等大部分浏览器。

开始使用Agilebins

1.获取agilebins-v1.0.4下载地址:GitHub|百度网盘 ( zip资源包 )|阿里云盘 ( exe资源包 )|Gitee

2.引用插件点此去查看,插件的基础使用范例详细说明。 或直接下载基础的具体使用范例演示 百度网盘|阿里云盘

3.使用Agilebins遇到任何疑难的问题,可选择QQ群① 158544200或QQ群② 790370978进行反馈咨询。

typeString

效果类型,可选 slide| menu|box

slide为幻灯切换,跑马灯,滚动效果等...

menu为菜单下拉效果。

box为盒子层div元素,当鼠标点击盒子层元素区域以外的HTML元素,则盒子层元素将关闭(隐藏)。

默认slide

directionString

滑动方向,top向上|right向右|bottom向下| left向左。

typeslide时有效。

默认left向左

mainElString

内容列表集合HTML容器元素选择器。如 幻灯图片列表容器ul元素。

<ul>

        <li><img alt="图片1" src="1.jpg"/></li>

        <li><img alt="图片2" src="2.jpg"/></li>

</ul>

scrollElString

滚动列表集合HTML容器元素选择器。如 滚动图片列表容器ul元素。

<ul>

        <li><img alt="图片1" src="1.jpg"/></li>

        <li><img alt="图片2" src="2.jpg"/></li>

</ul>

sPrevString

滚动按钮HTML元素,上一组(页)。一般配合scrollEl参数一同使用。

sNextString

滚动按钮HTML元素,下一组(页)。一般配合scrollEl参数一同使用。

mPrevString

幻灯切换按钮HTML元素,上一个。一般配合mainEl参数一同使用。

mNextString

幻灯切换按钮HTML元素,下一个。一般配合mainEl参数一同使用。

mainStateString

导航列表HTML容器元素。来源为mainEl内容列表集合所产生的个数。如果该HTML元素容器里不包含任何嵌套HTML,则自动填充为mainEl所产生的列表个数,反之则为该容器里自定义嵌套的HTML为导航。

mainStateHtmlString

要填充的HTML子元素标签名,与mainState配合使用,将要填充到mainState容器里。

默认:标签名为li。这时mainState参数,则应为ul

注意:如单标签<br/>除外。

mainCountStateString

统计显示内容个数HTML容器元素。来源为mainEl内容列表集合所产生的个数。

如: 显示为 1/10 形式。

pageStateString

滚动分组页HTML容器元素。来源为scrollEl滚动列表集合所产生的分组页。如果该HTML元素容器里不包含任何嵌套HTML,则自动填充为scrollEl所产生的列表分组页,反之则为该容器里自定义嵌套的HTML为分组页。

pageStateHtmlString

要填充的滚动分组页HTML子元素标签名,与pageState配合使用,将要填充到pageState容器里。

默认:标签名为li。这时pageState参数,则应为ul

注意:如单标签<br/>除外。

pageCountStateString

统计显示滚动分组(页)总数HTML容器元素。来源为scrollEl滚动列表集合所产生的分组(页)总数。

如: 显示为 1/5 形式。

mPrevOffClassString

屏蔽mPrev按钮的HTML标签样式状态class名。当index <= 1,且loop : falseorpnLoop : false时生效。

默认off

mNextOffClassString

屏蔽mNext按钮的HTML标签样式状态class名。当index >= mainEl内容列表集合所产生的总数,且loop : falseorpnLoop : false时生效。

默认off

sPrevOffClassString

屏蔽sPrev按钮的HTML标签样式状态class名。当page <= 1,且loop : falseorpnLoop : false时生效。

默认off

sNextOffClassString

屏蔽sNext按钮的HTML标签样式状态class名。当page >= scrollEl滚动列表集合所产生的分组(页)总数,且loop : falseorpnLoop : false时生效。

默认off

onClassString

当前HTML标签元素亮高样式class名。表示当前选中(指针指向)的mainElindex索引元素。

默认on

offClassString

非当前HTML标签元素默认样式class名。表示非当前选中(指针指向)的mainElindex索引元素。

默认off

eventTypeString

绑定事件类型。如:mouseover|click

默认mouseover

mainCurBoolean

设置是否以当前mainEl,scrollEl容器元素本身为列表集合元素。当前值为false时,则以容器子元素为列表集合。反之,则以容器元素本身为列表集合元素。

手风琴类似切换效果,将值设为true即可。

默认false

loopBoolean

是否需要无限循环。

默认false

注意:当设置为sEffect : marquee时,该参数无效。

pnLoopBoolean

是否需要按钮前后循环。

当值为false时,切换到第一个(组/页)或最后一个(组/页),将不再返回。

默认true

autoPlayBoolean

是否需要自动播放。

默认false

注意: 当值为true时,则必须将pnLoop : true,循环自动播放才能生效。反之,则为一次性自动播放。

visNumInterger

设置scrollEl滚动列表集合,允许显示的数量。

默认1

注意:当设置为sEffect : marquee时,该参数无效。

scrollNumInterger

设置scrollEl滚动列表集合,每组(页)可滑动的数量。

默认1

注意:当设置为sEffect : marquee时,该参数无效。

delayTimeInterger

自动播放延迟时间,时间单位为毫秒(如3500)。值越大,则等待的时间越长。

默认3500

注意: 该设置值必须为delayTime >= speed >= 0delayTime >= sSpeed >= 0delayTime >= triggerTime >= 0的值。

triggerTimeInterger

eventType事件触发延迟时间,时间单位为毫秒(如50)。值越大,则等待的时间越长。

默认50

注意: 该设置值必须为delayTime >= triggerTime >= 0的值。

speedInterger

设置mainEl容器列表集合,播放过渡效果延迟时间。时间单位为毫秒(如350)。值越大,则等待的时间越长。

默认350

注意: 该设置值必须为delayTime >= speed >= 0的值。

sSpeedInterger

设置scrollEl容器列表集合,播放过渡效果延迟时间。时间单位为毫秒(如350)。值越大,则等待的时间越长。

默认350

注意: 该设置值必须为delayTime >= speed >= 0的值。

effectString

设置mainEl容器列表集合,播放过度效果类型。默认可选:fadefoldslideDowntoprightbottomleft

查看更多easing缓动效果调试。

默认fade

注意:使用easing其他缓动效果,请引用jQuery(jquery.easing.min.js)缓动效果插件。

sEffectString

循环无缝隙滚动效果。设置滚动scrollEl列表集合。

值为sEffect : marquee

注意:必须设置autoPlay : true才生效。

sStepInterger

循环无缝隙滚动,滚动步长。当设置值sEffect : marquee时有效。值越大滚动跨度越大,反之则跨度越小。

默认1

easingString

缓动效果。查看更多easing缓动效果调试。

默认swing

注意:使用easing其他缓动效果,请引用jQuery(jquery.easing.min.js)缓动效果插件。

indexInterger

索引号,设置显示第 n的一个。来源为mainEl列表集合索引号,从0开始。

默认0

curOffBoolean

设置当前index索引号元素,是否允许隐藏(关闭)。

默认false

playBoolean

播放按钮HTML标签元素。当点击该按钮时,效果开启自动播放。

注意:循环播放时值应为pnLoop : true

pauseBoolean

暂停按钮HTML标签元素。当点击该按钮时,效果暂停播放。

autoPageBoolean

是否开启自动填充分组(页)HTML元素。与pageState配合使用。

默认false

autoMainStateBoolean

是否开启自动填充导航HTML元素。与mainState配合使用。

默认false

defaultShowBoolean

是否开启默认显示。

默认true

returnDefaultBoolean

是否开启返回默认defaultShow状态。当type : boxtype : menu,配合defaultShow使用。

默认false

mouseOverStopBoolean

是否开启当鼠标悬浮在,当前容器层区域内,暂停播放。

默认false

hoverIsBtnBoolean

是否开启当鼠标悬浮在,当前容器层区域内,显示按钮元素。反之鼠标离开,则隐藏按钮元素。配合焦点图幻灯效果比较实用。

默认false

mousewheelIsPNBoolean

是否开启鼠标轮滚事件,用作代替上下按钮。配合全屏切换效果比较实用。

默认false

scrollWithMainString

是否同时开启mainElscrollEl结合使用。当在组图展示效果时,比较实用。

默认true

autoPositionBoolean

是否开启自动定位识别模式。当type : menutype : box时比较实用。

默认false

注意:当值为true时,mainEl容器css样式属性positiontoprightbottmleft值,请忽略。避免与自动定位识别模式css样式冲突。若需要位置偏差,请配合使用addXaddY值。

addXInterger

设置mainEl容器css样式leftright属性值。当type : menutype : box时生效。

默认0

addYInterger

设置mainEl容器css样式topbottm属性值。当type : menutype : box时生效。

默认0

iTriggerString

设置type: menu | box,菜单列表选项事件绑定元素。

iTriggerFuncFunction

属性iTrigger元素,绑定的事件响应回调扩展函数。

  • 函数返回参数变量有:

  • el:iTrigger元素当前选中对象

stopPropagationBoolean

设置type: menu,阻止事件冒泡,当有嵌套三级以上下拉菜单时设为false

默认false

startFuncFunction

执行动画效果之前时的回调扩展函数。

  • 函数返回参数变量有:

  • index:索引编号

  • total:mainEl产生的总数量

  • page:当前分组(页码)

  • pageTotal:分组总(页码)数量

  • mainState:mainState导航集合

  • pageState:pageState分组(页)集合

  • scrollEl:scrollEl列表集合

  • mainEl:mainEl列表集合

completeFuncFunction

执行动画效果完成后的回调扩展函数。

函数返回参数变量有:同startFunc一致。

endFuncFunction

效果结束后的回调扩展函数。当type : menutype : box时有效。

函数返回参数变量有:同startFunc一致。

initFuncFunction

初始化回调扩展函数。

实例化对象之前执行,可使用形参参数:当前容器对象元素。

调用后为什么报错

1. 请检查jQuery.min.jsjquery.agilebins-v1.0.3.min.js文件顺序,及$(容器盒子元素).agilebins({})调用是否正确。

2. 参数值设置是否正确。

3. 可能你引入的其他JavaScript文件与jQuery文件冲突。可以尝试jQuery(容器盒子元素).agilebins({})方式调用。

如何自定义扩展效果

如:

startFunc : function(index, total, page, pageTotal, mainState, pageState, mainEl, scrollEl){
    // 你的扩展实现代码写在这里...
}

返回顶部