YunyChan / SimpleMarquee

一个不依赖任何第三方框架库的简易走马灯组件

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SimpleMarquee license

一个不依赖任何第三方框架库的简易走马灯组件。

快速开始

使用

首先在页面中引入SimpleMarquee.jsJS文件

<script src="SimpleMarquee.js"></script>

然后通过创建SimpleMarquee的实例并传入相应的参数来插入并使用组件

<div id="marquee"></div>
<script src="SimpleMarquee.js"></script>
<script>
    var oData = [{
            name: 'test1',
            age: 15
        }, {
            name: 'test2',
            age: 20
        }, {
            name: 'test3',
            age: 25
        }, {
            name: 'test4',
            age: 30
        }, {
            name: 'test5',
            age: 35
        }
    ];
    var oMarquee = new SimpleMarquee({
        target: document.getElementById('marquee'),
        width: 800,
        data: oData,
        item: function(nIndex, oData){
            return 'Name:' + oData.name + ' & Age:' + oData.age + '.';
        },
        gap: 50,
        speed: 5,
        fps: 40
    });
    oMarquee.run();
</script>

下面是组件的配置参数说明:

  • width - 必须, 走马灯遮罩宽度
  • unit - default: px, 样式单位px/rem
  • data - 必须, 数据源
  • item - 必须, 走马灯每项的模板
  • gap - default: 10px, 走马灯各项间隔宽度
  • maxGap - default: 10px, 走马灯间隔最大宽度
  • minGap - default: 10px, 走马灯间隔最小宽度
  • speed - default: 2px, 走马灯每帧移动距离
  • fps - default: 40, 走马灯移动帧速
  • fromOutside - default: false, 走马灯内容起始位置是否从遮罩的最右边开始

APIs

  • render(DOM) - 渲染组件
    • DOM - 需要插入组件的DOM元素对象
  • run() - 启动走马灯
  • stop() - 暂停走马灯

作者

Yuny Chan

About

一个不依赖任何第三方框架库的简易走马灯组件

License:Apache License 2.0


Languages

Language:JavaScript 84.1%Language:HTML 15.9%