kansatsu
A wrapper of Intersection Observer API.
Kansatsu is a Japanese word 観察 (かんさつ) in Rōmaji, which means observe.
Getting started
You may need a library polyfills the native IntersectionObserver API in unsupporting browsers. w3c IntersectionObserver polyfill
Install
This project uses node and npm. Go check them out if you don't have them locally installed.
$ npm install --save kansatsu
or if you use yarn.
$ yarn add kansatsu
Then with a module bundler like rollup or webpack, use as you would anything else:
// using ES6 modules // using CommonJS modulesvar Kansatsu =
The UMD build is also available on unpkg:
This exposes the Kansatsu()
function as a global.
Usage
; const man = documentlet kansatsu = Array
Examples & Demos
API
Kansatsu's API is organized as follows:
Kansatsu(options: Object)
Kansatsu will account for the following properties in options:
-
root
forroot
pass to theIntersectionObserver()
API. Default null. -
appear
forthreshold
pass to theIntersectionObserver()
API. Default 0. -
offset
the percent used byrootMargin
. Default 0.// offset 20// rootMargin = '20% 0px' -
rootMargin
forrootMargin
pass to theIntersectionObserver()
API. Default '0%'. -
callback
the callback fot theobserve
action.{if isAppearelclassList}
watch()
The wrap for observe