Skip to content

lnardon/InteractiveParallax

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Interactive Parallax

A module to create a parallax that interacts with the mouse move.

NPM JavaScript Style Guide

Demo

Live Demo Here

Installation

npm install interactiveparallax

Usage

JavaScript

import useParallax from "animationsequence";

// containerClass = the class name of the container where the parallax will happen.
// targetClass = the class name of the targets to apply the effect.
// alertMobileUser = argument to inform in case the device has no support for the package.(Optional)
useParallax(containerClass: string, targetClass: string, alertMobileUser?: boolean)

HTML Element

<!-- 
  parallax-speed-x = X-axis parallax speed for the target. (Number between -50 and 50)
  parallax-speed-y = Y-axis parallax speed for the target. (Number between -50 and 50)
-->
<div class="target" parallax-speed-x="-7" parallax-speed-y="11"></div>

Example

<!-- HTML -->
<div class="splash">
  <h1 class="title target" parallax-speed="0.3">Interactive Parallax</h1>
  <div class="target" parallax-speed-x="13" parallax-speed-y="-19"></div>
  <div class="target" parallax-speed-x="-21" parallax-speed-y="14"></div>
</div>
// Javascript
useParallax("splash", "target", true);

The full source code of the Live Example can be found in the ./index.html file.