ang2-parallax/README.md

A parallax module built for Angular 2 components.

# ng2-parallax

### What Am I?!
An easy way to implement parallax scrolling for Angular2 components.  (There's also an [Angular 1.x](https://github.com/allenRoyston/ng-parallax "Angular 1.x") directive for those that need it.)
  - No dependencies
  - Responsive
  - Simple
  - Works for mobile!  (Well, iPhones at least - haven't tested on an Android yet)
  - Tiny

### Installation
Include the module in your scripts.<br>
```

import { Component } from '@angular/core';
import { ng2Parallax  } from '<pathTo>/ng2-parallax/parallax.directive';

@Component({
  selector: 'my-component',
  directives: [ng2Parallax],
  template:`
  
  <div style='width: 200; height: 200px'>
    <div parallax speed="5" src="path/to/image.jpg"></div>
  </div>
  
  `
})
export class componentName { }

```

### Version
1.0.0


### Live Demo 
[Check it out](https://ng2-parallax-demo.herokuapp.com/ "ng2 Parallax Demo")


### Dependencies
- None!

### NPM / Bower
<code>
npm install ng-parallax --save-dev
</code>
<br>
<code>
bower install ng-simple-parallax --save
</code>



### Parameters
```
speed = 0 to xx (the higher the number, the slower the effect).  This part requires some tinkering since different image sizes will respond differently.

src = path to image
```

License
----

MIT - go nuts y'all.