Pull To Refresh

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

Pull To Refresh Layout

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

<div class="page">
  <!-- Page content must have additional "ptr-content" class -->
  <div class="page-content ptr-content" data-ptr-distance="55" data-ptr-mousewheel="true">
    <!-- Default pull to refresh preloader-->
    <div class="ptr-preloader">
      <div class="preloader"></div>
      <div class="ptr-arrow"></div>
    </div>
    <!-- usual content below -->
    <div class="list">
      ...
    </div>
    <!-- nested scrollable element -->
    <div class="my-scolling-content ptr-watch-scrollable">
      ...
    </div>
    <!-- another nested scrollable element -->
    <div class="another-scolling-content ptr-ignore">
      ...
    </div>
  </div>
</div>

Where:

• **ptr-content** 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
• data-ptr-mousewheel="true" additional attribute that enables pull to refresh with mousewheel (for desktop apps). Works only for PTR top.
• ptr-watch-scrollable - additional class that must be added on nested scrollable elements to prevent pull to refresh on such elements scrolling
• ptr-ignore - additional class that must be added on nested scrollable elements or other elements that will to prevent pull to refresh on such elements scrolling or touchmove

Pull To Refresh From Bottom

It is also possible to make it work like pull from bottom. In this case we need to move ptr-preloader element to the bottom of page content and add additional ptr-bottom class to pull to refresh content:

<div class="page">
  <!-- ptr-content must have additional "ptr-bottom" class -->
  <div class="page-content ptr-content ptr-bottom">
    <div class="list">
      ...
    </div>
    <!-- Pull to refresh preloader moves to bottom -->
    <div class="ptr-preloader">
      <div class="preloader"></div>
      <div class="ptr-arrow"></div>
    </div>
  </div>
</div>

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.

When user release pull to refresh content when it is in “ptr-pull-up” state, then ptr-preloader will receive additional **ptr-refreshing** class. In “refreshing” state arrow will be hidden and user will see preloader indicator. On this stage you probably need to do Ajax request and refresh page content.

Pull To Refresh App Methods

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). Required.

app.ptr.get(el)- get PTR instance by 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:

// init ptr manually
var ptr = app.ptr.create('.ptr-content');
// or using get to retreive already created instance
var ptr = app.ptr.get('.ptr-content');

Pull To Refresh Events

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

DOM Events

App and Pull To Refresh Instance Events

PTR instance emits events on both self instance and app instance. App instance events has same names prefixed with ptr.

CSS Variables

Below is the list of related CSS variables (CSS custom properties).

.ios {
  --f7-ptr-preloader-size: 20px;
  --f7-ptr-size: 44px;
}
.md {
  --f7-ptr-preloader-size: 22px;
  --f7-ptr-size: 40px;
}
.aurora {
  --f7-ptr-preloader-size: 20px;
  --f7-ptr-size: 38px;
}

Examples

Pull From Top

<div class="page-content ptr-content">
  <div class="ptr-preloader">
    <div class="preloader"></div>
    <div class="ptr-arrow"></div>
  </div>
  <div class="list media-list">
    <ul>
      <li class="item-content">
        <div class="item-media"><img src="https://cdn.framework7.io/placeholder/abstract-88x88-1.jpg" width="44"/></div>
        <div class="item-inner">
          <div class="item-title-row">
            <div class="item-title">Yellow Submarine</div>
          </div>
          <div class="item-subtitle">Beatles</div>
        </div>
      </li>
      <li class="item-content">
        <div class="item-media"><img src="https://cdn.framework7.io/placeholder/abstract-88x88-2.jpg" width="44"/></div>
        <div class="item-inner">
          <div class="item-title-row">
            <div class="item-title">Don't Stop Me Now</div>
          </div>
          <div class="item-subtitle">Queen</div>
        </div>
      </li>
      <li class="item-content">
        <div class="item-media"><img src="https://cdn.framework7.io/placeholder/abstract-88x88-3.jpg" width="44"/></div>
        <div class="item-inner">
          <div class="item-title-row">
            <div class="item-title">Billie Jean</div>
          </div>
          <div class="item-subtitle">Michael Jackson</div>
        </div>
      </li>
    </ul>
  </div>
</div>

var app = new Framework7();
var $$ = Dom7;
// Dummy Content
var songs = ['Yellow Submarine', 'Don\'t Stop Me Now', 'Billie Jean', 'Californication'];
var authors = ['Beatles', 'Queen', 'Michael Jackson', 'Red Hot Chili Peppers'];
// Pull to refresh content
var $ptrContent = $$('.ptr-content');
// Add 'refresh' listener on it
$ptrContent.on('ptr:refresh', function (e) {
  // Emulate 2s loading
  setTimeout(function () {
    var picURL = 'https://cdn.framework7.io/placeholder/abstract-88x88-' + (Math.floor(Math.random() * 10) + 1) + '.jpg';
    var song = songs[Math.floor(Math.random() * songs.length)];
    var author = authors[Math.floor(Math.random() * authors.length)];
    var itemHTML =
      '<li class="item-content">' +
        '<div class="item-media"><img src="' + picURL + '" width="44"/></div>' +
        '<div class="item-inner">' +
          '<div class="item-title-row">' +
            '<div class="item-title">' + song + '</div>' +
          '</div>' +
          '<div class="item-subtitle">' + author + '</div>' +
        '</div>' +
      '</li>';
    // Prepend new list element
    $ptrContent.find('ul').prepend(itemHTML);
    // When loading done, we need to reset it
    app.ptr.done(); // or e.detail();
  }, 2000);
});

Pull From Bottom

<!-- additional "ptr-bottom" class -->
<div class="page-content ptr-content ptr-bottom">
  <div class="list media-list">
    <ul>
      <li class="item-content">
        <div class="item-media"><img src="https://cdn.framework7.io/placeholder/abstract-88x88-1.jpg" width="44"/></div>
        <div class="item-inner">
          <div class="item-title-row">
            <div class="item-title">Yellow Submarine</div>
          </div>
          <div class="item-subtitle">Beatles</div>
        </div>
      </li>
      <li class="item-content">
        <div class="item-media"><img src="https://cdn.framework7.io/placeholder/abstract-88x88-2.jpg" width="44"/></div>
        <div class="item-inner">
          <div class="item-title-row">
            <div class="item-title">Don't Stop Me Now</div>
          </div>
          <div class="item-subtitle">Queen</div>
        </div>
      </li>
      <li class="item-content">
        <div class="item-media"><img src="https://cdn.framework7.io/placeholder/abstract-88x88-3.jpg" width="44"/></div>
        <div class="item-inner">
          <div class="item-title-row">
            <div class="item-title">Billie Jean</div>
          </div>
          <div class="item-subtitle">Michael Jackson</div>
        </div>
      </li>
    </ul>
  </div>
  <!-- ptr-preload is on the bottom -->
  <div class="ptr-preloader">
    <div class="preloader"></div>
    <div class="ptr-arrow"></div>
  </div>
</div>