Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 2.4 KB

README.md

File metadata and controls

93 lines (60 loc) · 2.4 KB
Raw

pxi-header.gif

Parallax Interface (PXI)

PXI is a lightweight and flexible library for adding mouse-driven parallax effects to your HTML elements, enhancing UI depth and user engagement in any project.

The whole Project is inspired by the iPad Mouse Hover Effect.

Installation

npm install @redbeed/parallax-interface

Usage

import ParallaxInterface from 'parallax-interface';

ParallaxInterface.init();

// or with custom options
ParallaxInterface.init({
    throttleTime: 16, // Throttle time in milliseconds (60fps)
    hitzoneFactor: 1, // Factor for the hitzone size
    mouseMoveFactor: 0.5, // Factor for the mousemove movement
    animationTime: 500, // Animation time in milliseconds
    calculateSize: false, // If true, the wrapper and the element will have a fixed size (based on the element's size)
});

Or you can add the following script to your project directly.

<script src="https://unpkg.com/@redbeed/parallax-interface/dist/parallax-interface.min.js"></script>

HTML

You need to add data-pax to your main element and data-pe-factor to the elements you want to add the parallax effect to.

<a href="#" data-pax>
    <span data-pe-factor>I am a link</span>
</a>

<!-- or with custom options -->
<a href="#" data-pax data-pe-hitzone="1.2">
    <span data-pe-factor="0.5">I am a link</span>
</a>

CSS

To make the parallax effect work, you should add our small CSS snippet to your project.

import 'parallax-interface/dist/parallax-interface.css';

Or you can add the following CSS to your project directly.

<link rel="stylesheet" href="https://unpkg.com/@redbeed/parallax-interface/dist/parallax-interface.css"/>

Troubleshooting

Inline Block Elements

You need to add display: inline-block to your inline elements like span or a, if you want to add the parallax effect.

Contributing

Everyone is welcome to contribute to this project. Create a pull request or an issue if you find something that could be improved.

Support

If you like this project, please consider supporting it by giving it a star.

redbeed is a web development agency from Germany, with love for open source projects. You can find more information about us on our website redbeed.com.

License

This project is licensed under the MIT License - see the LICENSE file for details.