https://github.com/nateplusplus/pushin

Attach a "dolly" or "push in" effect to a div element when user scrolls.
https://github.com/nateplusplus/pushin

javascript parallax parallax-effect parallax-scrolling typescript

Last synced: 4 days ago
JSON representation

Attach a "dolly" or "push in" effect to a div element when user scrolls.

• Host: GitHub
• URL: https://github.com/nateplusplus/pushin
• Owner: nateplusplus
• License: mit
• Created: 2015-05-28T03:27:14.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-12-20T19:11:02.000Z (about 1 year ago)
• Last Synced: 2025-02-09T20:09:50.682Z (11 days ago)
• Topics: javascript, parallax, parallax-effect, parallax-scrolling, typescript
• Language: TypeScript
• Homepage: https://pushinjs.com/
• Size: 9.21 MB
• Stars: 513
• Watchers: 3
• Forks: 26
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# pushIn.js

[![made-with-javascript](https://img.shields.io/badge/Made%20with-TypeScript-1f425f.svg)](https://www.typescriptlang.org/)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/nateplusplus/pushin/graphs/commit-activity)

![Maintainer](https://img.shields.io/badge/maintainer-nateplusplus-blue)

[![GitHub license](https://img.shields.io/github/license/nateplusplus/pushin.svg)](https://github.com/nateplusplus/pushin/blob/main/LICENSE)

[![Node.js CI](https://github.com/nateplusplus/pushin/actions/workflows/node.js.yml/badge.svg)](https://github.com/nateplusplus/pushin/actions/workflows/node.js.yml)

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](http://pushinjs.com/) for a working example.

## Compatibility

PushIn.js supports all browsers that are [ES5-compliant](http://kangax.github.io/compat-table/es5/).

## 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:

```shell

npm install --save pushin

```

Alternatively, you can use a CDN:

```

```

## Configuration

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

## Contributing

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

## Development Setup

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