scroll-scout

scroll-scout

Usage

import scrollScout from 'scroll-scout';

Installation

Install via yarn

yarn add scroll-scout (--dev)

or npm

npm install scroll-scout (--save-dev)

configuration

You can pass in extra options as a configuration object (➕ required, ➖ optional, ✏️ default).

import scrollScout from 'scroll-scout';

➖ property ( type ) ✏️ default 📝 description ❗️ warning ℹ️ info 💡 example

methods

#name

scrollScout

Examples

See example folder or the runkit example.

Builds

If you don't use a package manager, you can access scroll-scout via unpkg (CDN), download the source, or point your package manager to the url.

scroll-scout is compiled as a collection of CommonJS modules & [ES2015 modules](http://www.2ality.com/2014/0 -9/es6-modules-final.html) for bundlers that support the jsnext:main or module field in package.json (Rollup, Webpack 2)

The scroll-scout package includes precompiled production and development UMD builds in the dist folder. They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. You can drop a UMD build as a <script> tag on your page. The UMD builds make scroll-scout available as a window.scrollScout global variable.

License

The code is available under the MIT license.

Contributing

We are open to contributions, see CONTRIBUTING.md for more info.

Misc

This module was created using generator-module-boilerplate.