Skip to content

ErlendEllingsen/pull-to-reload

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

☝️👇 pull-to-reload

npm version MIT Licence

This is a pull to refresh implementation for the web. Designed to work with both mobile and desktop devices. Fits nicely with web-apps or single-page applications (SPA). Configurable to the seventh degree.

🌵Preview

Functionality demo

Demo:

https://erlendellingsen.github.io/pull-to-reload/

Install

NPM (Recommended)

npm install pull-to-reload

Direct (Download)

Add pull-to-reload.js to your project.

🌿Usage

Quick example:

Html

<div id="ptr">
    ...
</div>

<div id="content">
    Lorem ipsum dolor sit amet, consectetur adipisicing elit. Dolores doloribus harum sed odit optio, fuga nam modi quod beatae? Tempore sunt molestiae, soluta quas unde exercitationem, modi accusamus pariatur reiciendis!
</div>

Javascript

$(document).ready(function(){
    var ptr = new PullToReload({ 
        'callback-loading': function(){
            setTimeout(function(){
                ptr.loadingEnd();
            }, 5000);
        }
    });
});

Available options:

this.opts = {
        'refresh-element': 'ptr', //Required
        'content-element': 'content', //Required
        'border-height': 1,
        'height': 80,
        'font-size': '30px',
        'threshold': 20,
        'pre-content': '...',
        'loading-content': 'Loading...',
        'callback-loading': function(){ setTimeout(function(){ self.loadingEnd(); }, 1000); } //Required
    }

📎 Dependencies

None 🔥

🥇 Contributors

  • NathanHeffley (Removed jQuery dependency)
  • mdczaplicki (Minified version)

💪🏽 Contribute

If you'd like to contribute to this project you can do so by creating a fork and send in a pull-request.

Make sure to write detailed comments and state your changes when sending in a PR. Keep the code style equal to the current.

Contributions are very much appreciated 😍!

Topics where help is wanted/needed

  • Code: Making pull-to-reload not block regular scrolling functionality (e.g. in mobile apps).
  • Documentation/Wiki - Detailed how to/setup

License

As most of my other projects, this project is licensed as MIT.