Skip to content

Latest commit

 

History

History
139 lines (90 loc) · 3.37 KB

README.md

File metadata and controls

139 lines (90 loc) · 3.37 KB
Raw

@zestia/ember-simple-infinite-scroller

Ember Observer

This Ember addon provides a simple component that fires an action whenever it is scrolled to the bottom. Allowing you to load more data.

Installation

ember install @zestia/ember-simple-infinite-scroller

Add the following to ~/.npmrc to pull @zestia scoped packages from Github instead of NPM.

@zestia:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=<YOUR_GH_TOKEN>

Demo

https://zestia.github.io/ember-simple-infinite-scroller

Example

<InfiniteScroller
  @onLoadMore={{this.loadMore}}
  @percentDown={{100}}
  as |scroller|
>
  {{#each things as |thing|}}
    ...
  {{/each}}
  {{if scroller.isLoading 'Please wait...'}}
</InfiniteScroller>

Features

  • Very simple! ✔︎
  • Bidirectional ✔︎
  • Not coupled to Ember Data ✔︎
  • Supports use with FastBoot ✔︎

Notes

  • This addon intentionally does not come with any styles.

InfiniteScroller

Arguments

@onLoadMore

Required. Fired when the the element has been scrolled to the specified @percent.

@element

Optional. By default the scroll position of the component's own DOM element is monitored. You can use this argument to change the element, to monitor the document for example.

@percentDown

Optional. The distance that has to be scrolled down before the load more action is fired. 100% means the bottom.

@percentUp

Optional. The distance that has to be scrolled up before the load more action is fired. 0% means the top.

@debounce

Optional. Milliseconds delay for when to check if more needs to be loaded. Defaults to every 100ms

API

isLoading

Whether the promise for more data has resolved yet

direction

The direction scrolled that caused onLoadMore to fire

isScrollable

Whether the element is overflowing or not. If it's not, then the user will not be able to scroll to load more. In such a case, you can use this boolean to provide a button to manually load more.

loadMore

Call this to manually load more

Testing

A test helper is provided to help scrolling your element

Example 
import { scrollToPercentage } from '@zestia/ember-simple-infinite-scroller/test-support/helpers';

test('loading more', async function () {
  await visit('/');
  await scrollToPercentage('.infinite-scroller', 100);
  // ...
});

Performance

Please read: TryGhost/Ghost#7934

You may need to add the below code to app/app.js

View 
customEvents = {
  touchstart: null,
  touchmove: null,
  touchend: null,
  touchcancel: null
};