README

Flux.js

Flux.js is a JavaScript package that enables parallax scrolling effect on selected elements. With optimizations to Reduce Jank.

Supported Effects

The following are supported effects

Translate (Y, X)
Rotate
Scale
Opacity
Add custom class

Examples

Example

Getting Started

Install

First step is to install it using yarn or npm

npm install @baianat/flux.js

# or use yarn
yarn add @baianat/flux.js

Include necessary files

<body>
  ...
  <script type="text/javascript" src="dist/js/flux.js"></script>
</body>

Usage

You create new Flux object and pass array of elements, that you want to add effect to it.

  const fluxer = new Flux(
    [{
      // Item 1 option
    }, {
      // Item 2 option
    }],

    // settings
    {
      // breakpoint disables transformations, opacity and class toggling.
      breakpoint: 500, // defaults 0
      // if animation ends when the element gets out out of viewport
      outOfViewport: false, // defaults true
      // viewport ratio when animation should finish value from [0.1, 1]
      finishRatio: 1
    }
  );

Items Options

{
  // Element css selector or DOM element
  element: '#square1',
  // viewport ratio when animation should finish value from [0.1, 1]
  finishRatio: 1
  // Translate object values
  translate: {
    // translate unit, it can be 'px' or '%', defaults is 'px'
    unit: '%'
    // Y offsets, first value is the starting position, second is the ending position in px
    y: [-200, 200],
    // X offsets, first value is the starting position, second is the ending position in px
    x: [0, 10]
  },
  // Rotate values, first value is the starting degree, second is the ending degree
  // Accepts value between -360 : 360.
  rotate: [-45, 45],
  // Scale values, first value is the starting scale, second is the ending scale
  // Accepts fraction values.
  scale: [0.5, 1.4],
  // Opacity values, first value is the starting opacity, second is the ending opacity
  // Accepts value between 0 : 1, fractions are allowed
  opacity: [0, 1],
  // A class to be added when the element is in the viewport
  // It you want to toggle the class state when element in/out of the viewport
  // You can pass an object {'is-active': 'toggle'}
  class: 'is-active',
  // To disable transform and opacity changes.
  // It usually uses when working with class.
  omit: true (deprecated 👎)
}

Methods

flux.update([force])

force <boolean>

Updates elements in viewport position according to the current scroll, using force will update all elements event those that are not visible in the viewport

flux.reload()

Recalculates all elements bounding rectangle and regenerates its data then force update it.

Browser Support

This package is using Intersection Observer API to check if the element in the viewport, since it's not supported in all browsers you will need to add a polyfill to use it.

Usage no npm install needed!