scrollinview v1.0.2

Scroll in View

A tiny library that triggers classes on elements as they scroll into the viewport.

Installation

Scroll in View makes use of Core Events, so be sure to install this as a dependancy if you haven't already.

npm install scrollinview core-events

Usage

import Event from 'core-events'
import scrollinview from 'scrollinview'

const event = new Event()

scrollinview(event)

<div class="content" data-scroll-in-view>
  <!-- Content here -->
</div>

As soon as the element enters the viewport, a js-scroll-in-view class is added allowing a css animation to be triggered — this class can also be customised using an option (see below).

Options

The scrollinview function can optionally take an object as the second argument, that may include the following properties.

className

The class name that Scroll in View uses when an element enters the viewport (defaults to js-scroll-in-view).

scrollinview(event, { className: 'my-custom-class' })