Giter VIP home page Giter VIP logo

hongkong's Introduction

jQuery based plugin for parallax scrolling

Install via Bower

bower i --save hongkong

Usage

Please add hongkong.js right before the closing body tag. Make sure to include the dependency jQuery and a requestAnimationFrame polyfill.

<script src="bower_components/jquery/dist/jquery.js"></script>
<script src="bower_components/raf.js/raf.js"></script>
<script src="bower_components/hongkong/hongkong.js"></script>

Just add an attribute data-parallax-top or data-parallax-bottom to the element you want to be animated in the named direction.

You can add a data-parallax-factor with a value which is an integer to change the factor of which the element should move. Default is 4.

Then call

$.hongkong();

somewhere within your JavaScript.

Options

You can pass options to HongKong to customize it a bit:

  • factor: default factor to use for momentum if no other is set via a data-attribute; default: 4
  • mobile: support parallax effect on mobile; default: false
  • mediaQuery: Media query to match against when disabling parallax on mobile; default: (max-width: 42em)
  • selectorBottom: Selector to use to detect elements that should be scrolled to bottom; default [data-parallax-bottom]
  • selectorTop: Selector to use to detect elements that should be scrolled to top; default [data-parallax-top]

hongkong's People

Contributors

drublic avatar rodebert avatar anselmh avatar exdis avatar

Watchers

James Cloos avatar Johannes Hertenstein avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.