Skip to content

gvnzhou/PageScroll.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PageScroll

A jQuery plugin that assists scrolling the full page.

Demo

Quick start

include the files

<link rel="stylesheet" href="css/pagescroll.css">
<script src="jquery.min.js"></script>
<script src="PageScroll.min.js"></script>

call the the plugin on a container as your wish

$("#container").PageScroll();

All done!

Options

you can custom the caption by passing options when call the plugin, all available options are listed below.

call the the plugin on a container wish you wish

$("#container").PageScroll({
    option: value,
    option2: value2,
    ...
});
Option default Description
selectors {
sections:".sections",
section : ".section",
page : ".pages",
active : ".active"
,
insection : ".insection"
,
control-prev : ".control-prev"
,
control-next : ".control-next"
}
A selector for the sections.
index 0 Define the start section.
easing 'ease' Define the easing method.
duration 500 Speed in milliseconds for the scrolling transitions.
loop false A boolean to define whether support loop.
pagination true A boolean to define whether support pagination.
keyboard true A boolean to define whether support keyboard.
direction 'vertical' Define the scrolling direction.
callback function(){} A callback that is called after a new section is scrolled to. Arguments include the index of the section and an array of all section elements.

Browser Support

IE Chrome Firefox Opera Safari
IE 7+ ✔ Chrome ✔ Firefox ✔ Opera ✔ Safari ✔

License

Licensed under the MIT License

About

A jQuery plugin that assists scrolling the full page.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published