Skip to content

A web component built using Polymer.js which provides smooth scrolling utilities at 60fps using the iScrolljs library.

License

Notifications You must be signed in to change notification settings

YannickDot/x-iscroll

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

<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

  1. Import Web Components' polyfill:

    <script src="bower_components/platform/platform.js"></script>
  2. Import Custom Element and iscroll:

    <link rel="import" href="bower_components/x-iscroll/dist/x-iscroll.html">
  3. 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

About

A web component built using Polymer.js which provides smooth scrolling utilities at 60fps using the iScrolljs library.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages