freddycro/eriko-scroller.js

🕹 A lib to handle events triggered by scrolling.

【eriko-scroller.js】

version: v1.0.11
last updated: 2020.5.26

Availability

npm install --save eriko-scroller.js

Usage

import { ErikoScroller } from 'eriko-scroller.js';

// target element
var es = new ErikoScroller();
es.addObservableScrollEvent([target id], [option], [debugger]);

// remove listener
es.removeObservableScrollEvent();

Parameter

example

const targetId = '#element';
const option = {
  type: 'w',
  top: 1,
  bottom: 1,
  enterEvent: handleEnterEvent,
  leaveEvent: handleLeaveEvent,
  aboveEvent: handleAboveEvent,
  underEvent: handleUnderEvent,
};
const debugger = true;

document

name	type	optional	default
targetId	string	no
option	object	no
debugger	boolean	yes	false

option

name	type	optional	default	options
type	string	no		'w' / 'p'
top	number	yes	0
bottom	number	yes	0
enterEvent	function	yes	null
leaveEvent	function	yes	null
aboveEvent	function	yes	null
underEvent	function	yes	null

type:
'w': [screen mode] - window.innerHeight
'p': [pixel mode] - pixel