KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

zepto-onepage-scroll

★ 185 Open GitHub ↗

Zepto One Page Scroll is the javascript version of the infamous jQuery One Page Scroll.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#Zepto One Page Scroll by Pete R.
A Zepto JS plugin that creates an Apple-like one page scroll website (iPhone 5S website)

Created by [Pete R.](http://www.thepetedesign.com), Founder of [Travelistly](http://www.Travelistly.com) and [BucketListly](http://www.bucketlistly.com)

License: [Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/deed.en_US)

## Requirement

- [Zepto JS (1.1.3 or later)](http://zeptojs.com/)
- [Zepto JS FX Module](https://github.com/madrobby/zepto/blob/master/src/fx.js#files)

## Demo
[View demo](http://peachananr.github.io/zepto-onepage-scroll/demo/zepto_onepage_scroll_demo.html)

##Looking for a Pure JS version?
[Pure JS Version](http://peachananr.github.io/purejs-onepage-scroll/demo/purejs_onepage_scroll_demo.html)

##Looking for a jQuery version?
[jQuery Version](http://peachananr.github.io/onepage-scroll/Demo/demo.html)

## Compatibility
Modern browsers such as Chrome, Firefox, and Safari on both desktop and smartphones have been tested. Not tested on IE.

## Basic Usage
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](http://www.apple.com/iphone-5s/) uses the same technique.

To add this to your website, simply include the latest ZeptoJS library together with ZeptoJS FX Module, `zepto.onepage-scroll.js`, `onepage-scroll.css` into your document's `<head>` and call the function as follows:

````html
<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:
 
````javascript
Zepto(".main").onePageScroll({
   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.
});
````
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](https://github.com/eikes) for his swipe events!) when viewing your website on mobile phones.

## Public Methods
You can also trigger page move programmatically as well:

### Zepto.fn.moveUp()
This method allows you to move the page up by one. This action is equivalent to scrolling up/swiping down.

````javascript
  Zepto(".main").moveUp();
````

### Zepto.fn.moveDown()
This method allows you to move the page down by one. This action is equivalent to scrolling down/swiping up.

````javascript
  Zepto(".main").moveDown();
````

### Zepto.fn.moveTo(page_index)
This method allows you to move to the specified page index programatically.

````javascript
  Zepto(".main").moveTo(3);
````

## Callbacks
You can use callbacks to perform actions before or after the page move.

### beforeMove(next_page_index, next_section_element)
This callback gets called before the plugin performs its move.

````javascript
  Zepto(".main").onepage_scroll({
    beforeMove: function(index, next_el) {
      ...
    }
  });
````

### afterMove(next_page_index, next_section_element)
This callback gets called after the move animation was performed.

````javascript
  Zepto(".main").onepage_scroll({
    afterMove: function(index, next_el) {
      ...
    }
  });
````

If you want to see more of my plugins, visit [The Pete Design](http://www.thepetedesign.com/#design), or follow me on [Twitter](http://www.twitter.com/peachananr) and [Github](http://www.github.com/peachananr).

## Other Resources
- [Pure JS Version](http://www.thepetedesign.com/demos/purejs_onepage_scroll_demo.html)
- [jQuery Version](http://www.thepetedesign.com/demos/onepage_scroll_demo.html)
- [OnePageScroll.js: Creating an Apple’s iPhone 5S Website](http://www.onextrapixel.com/2013/09/18/onepagescroll-js-creating-an-apples-iphone-5s-website/)
- [Eike Send's jQuery Swipe Events](https://github.com/eikes/jquery.swipe-events.js)
- [CSS Easing generator by Matthew Lein](http://matthewlein.com/ceaser/)

zepto-onepage-scroll

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README