#One Page Scroll by Pete R. Create an Apple-like one page scroll website (iPhone 5S website) with One Page Scroll plugin Created by Pete R., Founder of BucketListly
License: Attribution-ShareAlike 4.0 International
This is forked from Pete R's One Page Scroll, and provides more functionality and bug fixes.
See: Change Log
jQuery (1.9.0 or later)
note: jQuery 1.9.0 or later is strongly recommended because using jQuery less than 1.8.3(or greater than 2.1.0) and jquery.onepage-scroll.js together turns out to be a hash-based XSS vulnerabiliry.
Try it: http://plnkr.co/edit/U3Tscez35JathRQYlAjz?p=preview
bower install git://github.com/leftstick/onepage-scroll.git#1.4.0 -SModern browsers such as Chrome, Firefox, and Safari on both desktop and smartphones have been tested. Not tested on IE.
One Page Scroll let you transform your website into a one page scroll website that allows users to scroll one page at a time. It is perfect for creating a website in which you want to present something to the viewers. For example, Apple's iPhone 5S website uses the same technique.
To add this to your website, simply include the latest jQuery library together with jquery.onepage-scroll.js, onepage-scroll.css into your document's <head> and call the function as follows:
<body>
...
<div class="main">
<section>...</section>
<section>...</section>
...
</div>
...
</body>Container "Main" must be one level below the body tag in order to make it work full page. Now call the function to activate as follows:
$(".main").onepage_scroll({
sectionContainer: "section", // sectionContainer accepts any kind of selector in case you don't want to use section
easing: "ease", // Easing options accepts the CSS3 easing animation such "ease", "linear", "ease-in",
// "ease-out", "ease-in-out", or even cubic bezier value such as "cubic-bezier(0.175, 0.885, 0.420, 1.310)"
animationTime: 1000, // AnimationTime let you define how long each section takes to animate
pagination: true, // You can either show or hide the pagination. Toggle true for show, false for hide.
updateURL: false, // Toggle this true if you want the URL to be updated automatically when the user scroll to each page.
beforeMove: function(index) {}, // This option accepts a callback function. The function will be called before the page moves.
afterMove: function(index) {}, // This option accepts a callback function. The function will be called after the page moves.
loop: false, // You can have the page loop back to the top/bottom when the user navigates at up/down on the first/last page.
keyboard: true, // You can activate the keyboard controls
responsiveFallback: false, // You can fallback to normal page scroll by defining the width of the browser in which
// you want the responsive fallback to be triggered. For example, set this to 600 and whenever
// the browser's width is less than 600, the fallback will kick in.
responsiveHeightFallback: false, // you can fallback to normal page scroll by defining the height of the browser.
disableMouseMove: false, // You can have the mouse wheel functionality disabled by setting this attribute to true. The default value is false.
moveUpKeys: [33, 38] // This option allow you to specify key code for move up operation. NavigateUp/PageUp by default.
moveDownKeys: [34, 40] // This option allow you to specify key code for move down operation. NavigateDown/PageDown by default.
backtoTopKeys: [36] // This option allow you to specify key code for move to top operation. Home by default.
gotoBottom: [35] // This option allow you to specify key code for move to bottom operation. End by default.
});And that's it. Now, your website should work the same way Apple's iPhone 5S website does. You should be able to swipe up/down as well (thanks to Eike Send for his swipe events!) when viewing your website on mobile phones.
You can also trigger page move programmatically as well:
This method allows you to unload the onepage-scroll functionality. This might be useful when you are developing SPA.
$(".main").destroy_onepage_scroll(options);Note: Only
sectionContaineris required in options.
This method allows you to move the page up by one. This action is equivalent to scrolling up/swiping down.
$(".main").moveUp();This method allows you to move the page down by one. This action is equivalent to scrolling down/swiping up.
$(".main").moveDown();This method allows you to move to the specified page index programatically.
$(".main").moveTo(3);You can use callbacks to perform actions before or after the page move.
This callback gets called before the plugin performs its move.
$(".main").onepage_scroll({
beforeMove: function(index, next_el) {
...
}
});This callback gets called after the move animation was performed.
$(".main").onepage_scroll({
afterMove: function(index, next_el) {
...
}
});If you want to see more of my plugins, visit The Pete Design, or follow me on Twitter and Github.