Skip to content

nateplusplus/pushin

Repository files navigation

pushIn.js

made-with-javascript Maintenance Maintainer GitHub license Node.js CI

PushIn.js is a lightweight parallax effect, built with JavaScript, that simulates an interactive dolly-in or push-in animation on a webpage.

Check out the live demo for a working example.

Compatibility

PushIn.js supports all browsers that are ES5-compliant.

Installation

PushIn is available via NPM or a CDN. Follow the detailed instructions in the documentation site: https://pushinjs.com/installation.

If you're using npm, you can install the package by running:

npm install --save pushin

Alternatively, you can use a CDN:

<script src="https://cdn.jsdelivr.net/npm/pushin@6/dist/umd/pushin.min.js"></script>

Configuration

There are several plugin configurations you can use to customize for your unique project. Refer to https://pushinjs.com/api for a detailed breakdown of all available configurations.

Contributing

Contributors are welcome! Please see CONTRIBUTING.md to learn more about the best ways to contribute to this project.

Development Setup

See DEVELOPERS.md for details on how to set up your development environment to contribute to this project.