vpi-observer

    1.6.0 • Public • Published

    Viewport Observer

    This is a simple script trying to implement IntersectionObserver API to detect DOM element intersecting viewport.

    Basic Usage

    import VpiObserver from 'vpi-observer'
     
    /* Constructor with default options */
    const vpio = new VpiObserver({
        /* IntersectionObserver API Default Config base on Mozilla Developer Network exemple. (optional) */
        config: {
            rootMargin: '50px 0',
            threshold: 0.01
        },
        /* Custom callback (required) */
        onIntersect: function(element){},
        /* Define wether or not use a scroll based fallback (optional) */
        scrollPolyfill: true,
        /* Use your own selector. There is no default class here (required) */
        targets: '.vpio-target',
        /* Verbose login on intersection, or not (optional) */
        verbose: false
    })

    Development Server

    To run a simple development server : npm run test.

    Based on budo and babelify (es6 compatible).

    Licences

    Copyright 2017 - Thomas Démocrite

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i vpi-observer

    DownloadsWeekly Downloads

    0

    Version

    1.6.0

    License

    MIT

    Last publish

    Collaborators

    • _thmsdmcrt