Pull To Refresh

    Pull to refresh is a special component that can be used to initiate the refreshing of a page’s contents.

    Let’s look on how to integrate pull to refresh to page:

    Where:

    • class. This is required to enable pull to refresh
    • **div class="ptr-preloader"** hidden layer with pull to refresh visual elements: preloader and arrow
    • data-ptr-distance="55" additional attribute that allows to set custom pull to refresh trigger distance. By default (if not specified) it is 44px
    • ptr-watch-scrollable - additional class that must be added on nested scrollable elements to prevent pull to refresh on such elements scrolling

    Pull To Refresh Sequence

    When user starts to pull ptr-content down, then ptr-preloader will receive additional **ptr-pull-down** class.

    When user pulls down ptr-content on a distance more than 44px (when ptr-preloader will be fully visible), then ptr-preloader will receive additional **ptr-pull-up** class which changes arrow rotation to notify user about refresh action on release.

    There are few App’s methods that can be used with pull to refresh container:

    app.ptr.create(el)- initialise PTR on specified HTML element container.

    • el - HTMLElement or string (with CSS selector) - PTR element (ptr-content). Required.

    Method returns created PTR instance

    Use this method only in case you have added ptr content after page init or if you want to enable it later. Otherwise if there is “ptr-content” element on page init it will be created automatically

    app.ptr.destroy(el)- remove PTR event listeners from the specified HTML element

    • el - HTMLElement or string (with CSS Selector). PTR element (ptr-content).

    Method returns PTR instance

    app.ptr.done(el)- reset PTR state on specified PTR content element

    • el - HTMLElement or string (with CSS Selector). PTR element (ptr-content). Required.

    app.ptr.refresh(el)- trigger PTR on specified PTR content element

    • el - HTMLElement or string (with CSS Selector). PTR element (ptr-content). Required.

    Pull To Refresh Methods & Properties

    If we created PTR manually or used app.ptr.get method we will PTR initialized instance with useful methods and properties:

    PTR will fire the following DOM events on popup element and events on app and popup instance:

    App and Pull To Refresh Instance Events

    Example