https://github.com/friendsofecmascript/scrollproxy

https://github.com/friendsofecmascript/scrollproxy

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/friendsofecmascript/scrollproxy
• Owner: FriendsOfECMAScript
• License: mit
• Created: 2016-10-17T07:49:50.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-09T09:24:17.000Z (about 8 years ago)
• Last Synced: 2025-05-26T14:00:41.612Z (8 months ago)
• Language: JavaScript
• Size: 1.41 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
#FoesScrollProxy

> 

[![npm version](https://img.shields.io/npm/v/foes-scrollproxy.svg?style=flat-square)](https://www.npmjs.com/package/foes-scrollproxy)

[![Build Status](http://img.shields.io/travis/FriendsOfECMAScript/ScrollProxy/master.svg?style=flat-square)](https://travis-ci.org/FriendsOfECMAScript/ScrollProxy)

[![NPM Status](http://img.shields.io/npm/dm/foes-scrollproxy.svg?style=flat-square)](https://www.npmjs.org/package/foes-scrollproxy)

[![devDependency Status](https://img.shields.io/david/FriendsOfECMAScript/ScrollProxy.svg?style=flat-square)](https://david-dm.org/FriendsOfECMAScript/ScrollProxy#info=dependencies)

##Installation

The recommended and the most suitable way to install is through *NPM*.

```shell

$ npm install --save foes-scrollproxy

```

Also, you can install through *Bower*.

```shell

$ bower install --save foes-scrollproxy

```

After installation process, you have to include the js files in your html.

```html

```

Also, it supports ES2015 modules so, you can easily import the library in your js instead loading the UMD version in the DOM.

```js

import 'foes-scrollproxy';

import {ScrollImageParallaxObserver} from 'foes-scrollproxy';

```

The following code is a fully initialization example code:

```js

```

##Credits

This library is created by:

>

**@mktoast** - [mikeltuesta@gmail.com](mailto:mikeltuesta@gmail.com)

##Licensing Options

[![License](https://img.shields.io/badge/License-MIT-yellowgreen.svg?style=flat-square)](https://github.com/FriendsOfECMAScript/ScrollProxy/blob/master/LICENSE)