@cnbritain/merlin-frontend-infinitescroll-js

Infinite scroll library

Usage no npm install needed!

<script type="module">
  import cnbritainMerlinFrontendInfinitescrollJs from 'https://cdn.skypack.dev/@cnbritain/merlin-frontend-infinitescroll-js';
</script>

README

merlin-frontend-infinitescroll-js

Infinite scroll library

JS Documentation

InfiniteScroll

Kind: global class

new InfiniteScroll(config)

Param Type Description
config Object Configuration
config.throttle Number | Null The throttle speed in milliseconds
config.trigger function The trigger function that checks when to load the url
config.url function | String The url to load

infiniteScroll.destroy()

Destroys the infinite scroller

Kind: instance method of InfiniteScroll
Emits: destroy
Access: public

infiniteScroll.disable()

Disables the infinite scroller. This unbinds the scroll listener.

Kind: instance method of InfiniteScroll
Emits: disable
Access: public

infiniteScroll.enable()

Enables the infinite scroller. This binds the scroll listener.

Kind: instance method of InfiniteScroll
Emits: enable
Access: public

infiniteScroll.pause()

Pauses the infinite scroller

Kind: instance method of InfiniteScroll
Emits: pause
Access: public

infiniteScroll.resume()

Resumes the infinite scroller

Kind: instance method of InfiniteScroll
Emits: resume
Access: public

infiniteScroll.update()

Updates the scroll position. This will run the trigger that is set and if that succeeds, it will begin loading the url

Kind: instance method of InfiniteScroll
Access: public

"enable"

Enable event

Kind: event emitted by InfiniteScroll

"destroy"

Destroy event

Kind: event emitted by InfiniteScroll

"disable"

Disable event

Kind: event emitted by InfiniteScroll

"loadComplete"

LoadComplete event

Kind: event emitted by InfiniteScroll
Properties

Name Type Description
data Object The XMLHttpRequest data
originalRequest Object The XMLHttpRequest

"loadError"

LoadError event

Kind: event emitted by InfiniteScroll
Properties

Name Type Description
data Object The XMLHttpRequest data
originalRequest Object The XMLHttpRequest

"loading"

Loading event

Kind: event emitted by InfiniteScroll
Properties

Name Type Description
url String The url that is being loaded

"pause"

Pause event

Kind: event emitted by InfiniteScroll

"resume"

Resume event

Kind: event emitted by InfiniteScroll

Themes

Prerequisites:

  • Node.js — brew install node
  • Grunt - npm install -g grunt-cli
  • Other prereqs? Python? Virtualenv?

Demo:

Install dependencies:

npm install

Build the things:

npm run sass
npm run js
npm run docs

Hint your JS

npm run jshint

Python the pythons:

npm run demo-install

Start the demo server:

python demo.py