https://github.com/zenoo/jquery-pagescroller

Scroll smoothly & easily
https://github.com/zenoo/jquery-pagescroller

jquery plugin scroll

Last synced: about 1 month ago
JSON representation

Scroll smoothly & easily

• Host: GitHub
• URL: https://github.com/zenoo/jquery-pagescroller
• Owner: Zenoo
• License: mit
• Created: 2017-05-12T07:37:31.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-11-11T02:23:24.000Z (about 2 years ago)
• Last Synced: 2024-05-28T19:41:49.616Z (7 months ago)
• Topics: jquery, plugin, scroll
• Language: JavaScript
• Homepage:
• Size: 118 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pageScroller

Scroll smoothly & easily.

### Doc

* **Installation**

Simply import JQuery & pageScroller into your HTML.

```

	

```

* **How to use**

Select your sections container with a JQuery selector.

```

$('#container').pageScroller();

```

* **Options**

```

{

    travelTime:1000, //travel time

    afterTravelTimeout:1, //length of the pause after each scroll (> 0)

    travelEasing:'swing', //easing type

    startingPage:0, //Index of your starting page (in your container)

    anchors:[], //list of CSS selectors for your custom anchors

    onTrigger : function({nextPage,prevPage}) {}, //Triggers before the scroll starts

    onEnd : function({nextPage,prevPage}) {} //Triggers after the scroll ends

}

```

* **Example**

```

$('#container').pageScroller({

    travelTime:500,

    afterTravelTimeout:50,

    travelEasing:'swing',

    startingPage:0,

    anchors:['.test1','#test2','li.test3>a'],

    onTrigger : function(e) {

        console.log(e);

    },

    onEnd : function(e) {

        console.log(e);

    }

});

```

## Authors

* **Zenoo** - *Initial work* - [Zenoo.fr](http://zenoo.fr)