README

slidePage.js

纯原生js编写的H5全屏滚动插件，适配PC和移动端，具有单屏内容滚动、控制动画播放、动态重绘等特色功能

Demo:

Documentation:

Usage
Configuration
Options
Using Animation
Methods

Introduction

slidePage.js 吸取了 slidePage 项目的各种经验，弥补不足，与slidePage不同的是，原生js编写没有任何依赖，优化了接口调用方式，更适合主流的前端框架，现在只是简单的js版本，后续会陆续封装出主流框架的版本。

Featured

slidePage.js 特别适合主流前端框架开发，纯原生无任何依赖，源代码只有12kb，gzip压缩后仅有2.4k, 接口符合插件具有的初始化、销毁、重载的方法，适配PC和移动端，具有单屏内容滚动、控制动画播放、动态重绘等特色功能，具体查看完整示例: fullFeatured

Usage

1、Install slidepage.js

// With npm
npm install slidepage.js

// With bower
bower install slidepage.js

2、Including files

<link rel="stylesheet" type="text/css" href="slidePage.css">

<script type="text/javascript" src="slidePage.js"></script>

3、Required HTML structure

<div class="slidePage-container" id="slidePage-container">
    <div class="page page1">
      <div class="container">
        <h2>page1</h2>
        <p>page1 content</p>
      </div>
    </div>
    <div class="page page2">
      <div class="container">
        <h2>page2</h2>
        <p>page2 content</p>
      </div>
    </div>
</div>

您可以查看完整examples里的html文件结构 fullFeatured.html

4、Initialization

new slidePage()

Configuration

var slidepage = new slidePage({
    slideContainer: '#slidePage-container',
    slideItem: '.slide-item',
    page: 1,
    refresh: true,
    useWheel: true,
    useSwipe: true,
    useAnimation : true,

    // Events
    before: function(origin,direction,target){},
    after: function(origin,direction,target){},
 });

Options

在slidePage.js中，page指的是每一次全屏滚动的一屏，也可以理解为每一屏对应的页码，必须是1以上的整数

slideContainer

指定slidePage要运行的容器选择器，值为querySelector所支持的选择器参数

slideItem

指定slidePage容器里每个page的选择器，值为querySelectorAll所支持的选择器参数

page

首次进入的page页码，值为1时从第一页开始，默认为1

refresh

每次滚动是否重新执行动画，默认true

useWheel

是否开启鼠标滚轮滑动，默认true

useSwipe

是否开启移动端触控滑动，默认true

useAnimation

是否开启动画默认true

Using Animation

为了方便示例用animate.css，动画效果可以自己实现

Include animate.css

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/animate.css@3.5.2/animate.min.css">

HTML structure

<div class="step animated fadeIn" data-delay="1300"></div>;

在想要动画控制的元素上加上step类，并加上css动画类名即可使用动画，data-delay属性控制动画延时播放(默认为100毫秒);

手动触发动画

<div class="lazy animated fadeIn"></div>

在想要手动播放动画的元素上加上lazy类，并加上css动画类名即可使用动画，可以加上data-delay使触发时再延时播放;
通过slidepage.slideFire(page)指定某一页的lazy动画触发播放。

Methods

slidepage.slideNext()

滑动定位到下一屏

slidepage.slidePrev()

滑动定位到上一屏

slidepage.slideTo(page)

传入page页码，滑动定位到对应的page

slidepage.slideFile(page)

触发对应 page 的lazy手动动画

slidepage.destroy()

销毁当前实例，移除所有事件恢复class属性值。

slidepage.update()

当html里的page发生变化时需要执行动态更新，此方法非常适合现在流行的数据驱动型框架，当模型数据驱动改变pege的排列时，执行update可以起到更新的作用，可以先看完整示例源码了解：fullFeatured.html

Usage no npm install needed!