JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 534
  • Score
    100M100P100Q99109F
  • License MIT

Dependency-free JavaScript library to detect when element enters into view

Package Exports

  • enter-view

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (enter-view) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

enter-view.js

Dependency-free JavaScript library to detect when element enters into view. See demo.

Usage

enterView({
    selector: '.class-name',
    trigger: function(el) {
        el.classList.add('entered');
    }
});
enterView({
    selector: '.class-name',
    trigger: function(el) {
        el.classList.add('entered');
    },
    offset: 0.5, // trigger at middle of viewport
    once: false, // trigger every time
});

Options

selector: [string or array of elements] required

Takes a class, id, or array of dom elements.

trigger: [function] required

Callback function that returns the element that was triggered.

offset: [number] optional (defaults to 0)

A value from 0 to 1 of how far from the bottom of the viewport to offset the trigger by. 0 = top of element crosses bottom of viewport (enters screen from bottom), 1 = top of element crosses top of viewport (exits screen top).

once: [boolean] optional (defaults to true)

Whether or not to trigger the callback once or every time.