https://github.com/ryanhefner/parallaxed

😎 Easily apply parallax effects to page elements as you scroll.
https://github.com/ryanhefner/parallaxed

npm-package parallax parallax-plugin parallax-scrolling

Last synced: about 1 month ago
JSON representation

😎 Easily apply parallax effects to page elements as you scroll.

• Host: GitHub
• URL: https://github.com/ryanhefner/parallaxed
• Owner: ryanhefner
• License: mit
• Created: 2018-05-25T15:37:58.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-05-30T18:57:37.000Z (over 6 years ago)
• Last Synced: 2024-10-05T18:16:46.234Z (about 2 months ago)
• Topics: npm-package, parallax, parallax-plugin, parallax-scrolling
• Language: JavaScript
• Homepage:
• Size: 53.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 😎 parallaxed

Easily apply parallax effects to page elements as you scroll.

## How to install

Via [npm](https://npmjs.com/package/parallaxed)

```sh

npm install --save parallaxed

```

Via [Yarn](https://yarn.fyi/parallaxed)

```sh

yarn add parallaxed

```

## How to use

### Options

* `selectors {string || Array}` - Selectors used to generate the html elements that will be reported on.

* `onEnter {function}` - Handler called when an element enters the viewport.

* `onExit {function}` - Handler called when an element exits the viewport.

* `onProgress {function}` - Handler called when as an element progresses through the viewport.

### Example

[Simple Example](examples/simple.html)

## License

[MIT](LICENSE) © [Ryan Hefner](https://www.ryanhefner.com)