x-iscroll's Introduction

<x-iscroll>

<x-iscroll> is a web component built using Polymer.js which provides smooth scrolling utilities at 60fps using the iScrolljs library.

DEPRECATED : Please use <rv-iscroll> by @itsravenous

His version is supporting Polymer 1.0+ 😉

Demo

Check it live.

Install

Install with Bower:

$ bower install --save x-iscroll

Usage

Import Web Components' polyfill:

<script src="bower_components/platform/platform.js"></script>

Import Custom Element and iscroll:

<link rel="import" href="bower_components/x-iscroll/dist/x-iscroll.html">

Start using it!
```
<x-iscroll></x-iscroll>
```

Options

Attribute	Options	Default	Description
`zoom`	boolean	`false`	Enables pinch to zoom.
`scrollY`	boolean	`true`	Enables scroll on Y axis.
`scrollX`	boolean	`false`	Enables scroll on X axis.
`freeScroll`	boolean	`false`	Enables free panning when scroll on both axis is enabled.

License

<x-iscroll> is released under the MIT License.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style.

Release history

1.0.0
- Initial release

Thanks

Special thanks to Matteo Spinelli (@cubiq) for his awesome work. :D

x-iscroll's People

Contributors

Stargazers

Watchers

x-iscroll's Issues

Polymer 1.0

I was going to submit a PR upgrading this element to work with Polymer 1.0 (which is not backwards-compatible with previous versions), but due to the Polymer syntax changes it was basically a complete rewrite. I've therefore published my own element rv-iscroll. I've given attribution to your work there; I hope you don't mind :)

Recommend Projects