pagePiling.js - Create an original scrolling site

pagePiling.js - Pile your sections one over another and access them scrolling or by URL!

Compatibility

pagePiling.js is fully functional on all modern browsers, as well as some old ones such as Internet Explorer 8, 9, Opera 12, etc. It works with browsers with CSS3 support and with the ones which don't have it, making it ideal for old browsers compatibility.

It is also designed to work on toudh devices such as mobile phones or tablets.

• denizli escort
• denizli escort
• didim escort
• düzce escort
• edirne escort
• edirne escort
• edremit escort

Source: github.com

1. INCLUDE CSS AND JS FILES

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

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script type="text/javascript" src="jquery.pagepiling.js"></script>

2. HTML

Each section will be defined with a div containing the section class. The active section by default will be the first section, which is taken as the home page.

<div id="pagepiling">
    <div class="section">Some section</div>
    <div class="section">Some section</div>
    <div class="section">Some section</div>
    <div class="section">Some section</div>
</div>

3. JAVASCRIPT

$(document).ready(function() {
    $('#pagepiling').pagepiling();
});

4. OPTIONS

A more complex initialization with all options set could look like this:

$(document).ready(function() {
    $('#pagepiling').pagePiling({
        menu: null,
        verticalCentered: true,
        sectionsColor: [],
        anchors: [],
        scrollingSpeed: 700,
        easing: 'swing',
        loopBottom: false,
        loopTop: false,
        css3: true,
        navigation: {
            'textColor': '#000',
            'bulletsColor': '#000',
            'position': 'right',
            'tooltips': ['section1', 'section2', 'section3', 'section4']
        },
        normalScrollElements: null,
        normalScrollElementTouchThreshold: 5,
        touchSensitivity: 5,
        keyboardScrolling: true,
        sectionSelector: '.section',
        animateAnchor: false,

        //events
        onLeave: function(index, nextIndex, direction){},
        afterLoad: function(anchorLink, index){},
        afterRender: function(){},
    });
});

• verticalCentered: (default true) Vertically centering of the content within sections.

• scrollingSpeed: (default 700) Speed in milliseconds for the scrolling transitions.

• sectionsColor:(default none) Define the CSS background-color property for each section: Example:

$('#pagepiling').pagePiling({
    sectionsColor: ['#f2f2f2', '#4BBFC3', '#7BAABE', 'whitesmoke', '#000'],
});

• anchors: (default []) Defines the anchor links (#example) to be shown on the URL for each section. Using anchors forward and backward navigation will also be possible through the browser. This option also allows users to bookmark a specific section. Be careful! if you use anchors, they can not have the same value as any ID element on the site (or NAME element for IE).

Important It is helpful to understand that the values in the anchors option array correlate directly to the element with the class of .section by it's position in the markup.

• easing: (default swing) Defines the transition effect to use for the vertical and horizontal scrolling. It requires the file vendors/jquery.easings.min.js or jQuery UI for using some of its transitions. Other libraries could be used instead.

• loopTop: (default false) Defines whether scrolling up in the first section should scroll to the last one or not.

• loopBottom: (default false) Defines whether scrolling down in the last section should scroll to the first one or not.

• css3: (default true). Defines wheter to use JavaScript or CSS3 transforms to scroll within sections. Useful to speed up the movement in tablet and mobile devices with browsers supporting CSS3. If this option is set to true and the browser doesn't support CSS3, a jQuery fallback will be used instead.

• normalScrollElements: (default null) If you want to avoid the auto scroll when scrolling over some elements, this is the option you need to use. (useful for maps, scrolling divs etc.) It requires a string with the jQuery selectors for those elements. (For example: normalScrollElements: '#element1, .element2')

• normalScrollElementTouchThreshold : (default 5) Defines the threshold for the number of hops up the html node tree pagePiling will test to see if normalScrollElements is a match to allow scrolling functionality on divs on a touch device. (For example: normalScrollElementTouchThreshold: 3)

• keyboardScrolling: (default true) Defines if the content can be navigated using the keyboard

• touchSensitivity: (default 5) Defines a percentage of the browsers window width/height, and how far a swipe must measure for navigating to the next section.

• animateAnchor: (default true) Defines whether the load of the site when given an anchor (#) will scroll with animation to its destination or will directly load on the given section.

• menu: (default false) A selector can be used to specify the menu to link with the sections. This way the scrolling of the sections will activate the corresponding element in the menu using the class active. This won't generate a menu but will just add the active class to the element in the given menu with the corresponding anchor links. In order to link the elements of the menu with the sections, an HTML 5 data-tag (data-menuanchor) will be needed to use with the same anchor links as used within the sections. Example:

<ul id="myMenu">
    <li data-menuanchor="firstPage" class="active"><a href="#firstPage">First section</a></li>
    <li data-menuanchor="secondPage"><a href="#secondPage">Second section</a></li>
    <li data-menuanchor="thirdPage"><a href="#thirdPage">Third section</a></li>
    <li data-menuanchor="fourthPage"><a href="#fourthPage">Fourth section</a></li>
</ul>

$('#pagepiling').pagePiling({
    anchors: ['firstPage', 'secondPage', 'thirdPage', 'fourthPage', 'lastPage'],
    menu: '#myMenu'
});

Note: the menu element should be placed outside the pagePiling wrapper in order to avoid problem when ussing css3:true. Otherwise it will be appeneded to the body by the plugin itself.

• navigation: (default false) If set to true, it will show a navigation bar made up of small circles.

• sectionSelector: (default .section) Defines the jQuery selector used for the plugin sections. It might need to be changed sometimes to avoid problem with other plugins using the same selectors as pagePiling.js.

5. METHODS

moveSectionUp()

Scrolls one section up:

$.fn.pagePiling.moveSectionUp();

moveSectionDown()

Scrolls one section down:

$.fn.pagePiling.moveSectionDown();

moveTo(section)

Scrolls the page to the given section.

/*Scrolling to the section with the anchor link `firstSection`  */
$.fn.pagePiling.moveTo('firstSection');

//Scrolling to the 3rd section in the site
$.fn.pagePiling.moveTo(3, 0);

//Which is the same as
$.fn.pagePiling.moveTo(3);

setAllowScrolling(boolean)

Adds or remove the possiblity of scrolling through sections by using the mouse wheel/trackpad or touch gestures (which is active by default).

$.fn.pagePiling.setAllowScrolling(false);

setKeyboardScrolling(boolean)

Adds or remove the possiblity of scrolling through sections by using the keyboard arrow keys (which is active by default).

$.fn.pagePiling.setKeyboardScrolling(false);

setScrollingSpeed(milliseconds)

Defines the scrolling speed in milliseconds.

$.fn.pagePiling.setScrollingSpeed(700);

6. CALLBACKS

afterLoad (anchorLink, index)

Callback fired once the sections have been loaded, after the scrolling has ended. Parameters:

• anchorLink: anchorLink corresponding to the section.
• index: index of the section. Starting from 1.

In case of not having anchorLinks defined in the plugin the index parameter would be the only one to use.

Example:

    $('#pagepiling').pagePiling({
        anchors: ['firstPage', 'secondPage', 'thirdPage', 'fourthPage', 'lastPage'],

        afterLoad: function(anchorLink, index){
            //using index
            if(index == '3'){
                alert("Section 3 ended loading");
            }

            //using anchorLink
            if(anchorLink == 'secondPage'){
                alert("Section 2 ended loading");
            }
        }
    });

onLeave (index, nextIndex, direction)

This callback is fired once the user leaves a section, in the transition to the new section.

Parameters:

• index: index of the leaving section. Starting from 1.
• nextIndex: index of the destination section. Starting from 1.
• direction: it will take the values up or down depending on the scrolling direction.

Example:

    $('#pagepiling').pagePiling({
        onLeave: function(index, nextIndex, direction){
            //after leaving section 2
            if(index == '2' && direction =='down'){
                alert("Going to section 3!");
            }

            else if(index == '2' && direction == 'up'){
                alert("Going to section 1!");
            }
        }
    });

afterRender()

This callback is fired just after the structure of the page is generated. This is the callback you want to use to initialize other plugins or fire any code which requires the document to be ready (as this plugin modifies the DOM to create the resulting structure).

Example:

    $('#pagepiling').pagePiling({
        afterRender: function(){
            alert("The resulting DOM stucture is ready");
        }
    });