Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yannickdot/x-iscroll
A web component built using Polymer.js which provides smooth scrolling utilities at 60fps using the iScrolljs library.
https://github.com/yannickdot/x-iscroll
Last synced: 28 days ago
JSON representation
A web component built using Polymer.js which provides smooth scrolling utilities at 60fps using the iScrolljs library.
- Host: GitHub
- URL: https://github.com/yannickdot/x-iscroll
- Owner: YannickDot
- License: mit
- Created: 2014-07-03T12:22:29.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-30T14:46:21.000Z (over 8 years ago)
- Last Synced: 2024-10-10T06:39:09.801Z (29 days ago)
- Language: HTML
- Size: 85 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# <x-iscroll>
<x-iscroll> is a web component built using Polymer.js which provides smooth scrolling utilities at 60fps using the [iScrolljs](http://iscrolljs.com/) library.
## DEPRECATED : Please use [<rv-iscroll>](https://github.com/itsravenous/rv-iscroll) by @itsravenous
His version is supporting Polymer 1.0+ 😉
## Demo
> [Check it live](http://yannickdot.github.io/labs/x-iscroll).
## Install
Install with [Bower](http://bower.io):
```sh
$ bower install --save x-iscroll
```
## Usage
1. Import Web Components' polyfill:
```html
```
2. Import Custom Element and iscroll:
```html
```
3. Start using it!
```html
```
## 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](http://opensource.org/licenses/MIT).
## 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](http://cubiq.org/) ([@cubiq](https://twitter.com/cubiq)) for his awesome work. :D