Infinite Ajax Scroll provides a wide range of events which we can use to hook into its functionality and customize where needed.

Working with events

You can bind and unbind to events with the on, once and off methods.

let ias = new InfiniteAjaxScroll('.container', options);
​
function handler(event) {
  console.log('New items have been appended', event);
}
​
ias.on('appended', handler);
ias.off('appended', handler);
ias.once('appended', handler);

Reference

ready

This event is triggered when the DOM is ready. Right after this event Infinite Ajax Scroll will bind (unless the bind option is set to false).

binded

This event is triggered when Infinite Ajax Scroll binds to the scroll and resize events of the scroll container. This mostly happens right after the DOM is ready, but this can be configured with the bind option.

unbinded

Triggered when Infinite Ajax Scroll removed its listeners from the scroll and resize events.

Infinite Ajax Scroll will only unbind when we call the unbind method.

scrolled

Triggered when the user scrolls inside the scroll container.

The delta values can be used to determine the scroll direction. A positive value means scrolling down (deltaY) or to the right (deltaX). A negative value means the opposite direction.

resized

Triggered when the user resizes the scroll container.

hit

Triggered when the user has hit the scroll threshold for the next page due to scrolling or resizing.

next

Triggered right after the hit event. Indicating that the next page will be loaded.

pageIndex is zero indexed. This means the index starts at 0 on the first page.

For example to notify the user about loading the next page, you can do:

ias.on('next', function(event) {
  alert(`Page ${event.pageIndex+1} is loading...`);
​
  event.promise.then(function() {
    alert(`Page ${event.pageIndex+1} is loaded and added to the page.`);
  });
});

load

This event is triggered before the next page is requested from the server.

You can use this event to modify any of the above properties.

For example to disable the cache busting you can do:

ias.on('load', function(event) {
  event.nocache = true; // prevent IAS from adding a timestamp query param to the url
});

loaded

This event is triggered when the next page is requested from the server, right before the items will be appended.

error

This event is triggered when an error occurred while loading the next page.

append

This event is triggered before the items are about to be appended.

See src/append.js for the default append function.

appended

This event is triggered after the items have been appended.

last

Triggered when the last page is appended.

ias.on('last', () => {
  console.log('Users has reached the last page');
})

​Read more on how we can inform the user about reaching the last page​

page

Triggered when the user scrolls past a page break. The event provides information about the page in view.

pageIndex is zero-based. This means the index starts at 0 on the first page.

One use case for this event is to update the browser url and title:

ias.on('page', (event) => {
  // update the title
  document.title = event.title;
​
  // update the url
  let state = history.state;
  history.replaceState(state, event.title, event.url);
})

​View this behaviour in a live demo​

prefill

This event is triggered when Infinite Ajax Scroll starts prefill.

ias.on('prefill', () => {
  // do something before prefill starts
})

prefilled

This event is triggered when prefill is finished.

ias.on('prefilled', () => {
  // do something when prefill finished
})