Skip to content
LinkedIn's JavaScript viewport tracking library and IntersectionObserver polyfill
Branch: master
Clone or download
asakusuma and lynchbomb Clean up index.ts
Move functions in index.ts into utils.ts
Latest commit 0296c66 Jan 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Remove ventana and expose engine API Nov 8, 2016
scripts Upgrade to yarn and cleanup deps Aug 27, 2018
src Clean up index.ts Jan 7, 2019
test Handle zero-area and display: none cases Jan 7, 2019
.babelrc Upgrade mocha, babel, and typescript Jan 3, 2019
.gitignore Refactor docs script and stop checking in size.txt Dec 16, 2016
.npmignore Initial Spaniel open source commit Sep 29, 2016
.travis.yml Upgrade node Jan 3, 2019
Brocfile.js Upgrade build dependencies Aug 27, 2018
CHANGELOG.md Release 3.2.0 Aug 23, 2017
LICENSE Update copyright to 2017 May 9, 2017
NOTICE Update copyright to 2017 May 9, 2017
README.md typo May 22, 2017
USAGE.md Fix exposed doc when element has zero area Jan 3, 2019
package.json Upgrade mocha, babel, and typescript Jan 3, 2019
rollup.config.js Upgrade and cleanup package.json Dec 7, 2016
testem.json Initial Spaniel open source commit Sep 29, 2016
tsconfig.json Turn on no-unused-locals Aug 25, 2017
tslint.json Prettier support Jan 3, 2019
yarn.lock

README.md

Spaniel Build Status npm version

LinkedIn's JavaScript viewport tracking library and IntersectionObserver polyfill. Track what the user actually sees.

import { IntersectionObserver } from 'spaniel';

new IntersectionObserver((entries) => { console.log('I see you') }, {
  threshold: 0.5
}).observe(document.getElementById('my-element'));

Practical uses included:

  • Determining advertisement impressions
  • Impression discounting feedback for relevance systems
  • Occlusion culling - Don't render an object until user is close to scrolling the object into the viewport

Usage and API Docs

Spaniel provides additional abstractions on top of IntersectionObserver, provides APIs for hooking into the low-level internals, and has some limitations as a non-complete polyfill. Learn more by reading the Usage and API Docs.

Why use Spaniel?

  • Provides the future-proofing of a WCIG API, but with an expanded feature-set built upon said API.
  • Tested and iterated upon in production by LinkedIn since late 2014
  • Highly performant, only relies on requestAnimationFrame
  • Extensive requestAnmiationFrame task/utility API

How is it tested?

Spaniel has both unit tests and a headless test suite. The headless tests are run using Nightmare.

How big is Spaniel?

Checkout size.txt to see the current minified UMD gzipped size.

You can also run npm run stats to measure locally.

Installation

Spaniel is a standard NPM/CommonJS module. You can use a build tool like browserify or webpack to include Spaniel in your application.

If you're using rollup, an ES6 version is built at /exports/es6/spaniel.js (as noted by jsnext:main in package.json).

Alternatively, running npm run build will generate a UMD file at /exports/spaniel.js, and a minified UMD file at /exports/min/spaniel.js. You can use the minified file in production.

Development setup

The Spaniel source code is written in TypeScript.

You will need testem installed globally to run the tests.

npm install -g testem

You will also need to install phantom.js globally.

// Install dependencies
npm install

// Run build
npm run build

// Watch and auto-rebuild
npm run watch

// Serve test app
npm run serve

// Run the tests
npm run test

IntersectionObserver Resources

Copyright

Copyright 2017 LinkedIn Corp. All rights reserved.

You can’t perform that action at this time.