Code Monkey home page Code Monkey logo

jarallax's Introduction

Just Another Parallax

jQuery background parallax plugin used for adding a smooth parallax scrolling effect to background images and Youtube/Vimeo videos using CSS3 transforms (translate3d). With a background-position fallback when CSS transforms are not supported.

Tested Browsers

  • IE9+
  • Safari 5.1.7+
  • Opera 12+
  • Latest browsers on Mac and Windows (Chrome, Firefox, Safari, IE, Edge)
  • Latest Chrome on Android
  • Latest Safari on iOs

Demos

Getting Started

Load jQuery(1.7+) and include Jarallax plugin

<!-- Jarallax -->
<script src='https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js'></script>
<script src='jarallax/jarallax.js'></script>

<!-- Include it if you want to use Video parallax -->
<script src='jarallax/jarallax-video.js'></script>

Set up your HTML

Mandatory requirement for plugin works properly - the selected item should be NOT position: static (for ex. relative).

<!-- Image Parallax -->
<div class='jarallax' style='background-image: url(<background_image_url_here>)'>
  Your content here...
</div>

<!-- Video Parallax -->
<div class='jarallax' data-jarallax-video='https://www.youtube.com/watch?v=ab0TSkLe-E0'>
  Your content here...
</div>

Additional styles

This need for correct show background image before Jarallax initialize end.

.jarallax {
  position: relative;
  background-size: cover;
  background-repeat: no-repeat;
  background-position: 50% 50%;
}

Call the plugin

A. Data attribute way

<div data-jarallax='{"speed": 0.2}' class='jarallax' style='background-image: url(<background_image_url_here>)'>
  Your content here...
</div>

B. JavaScript way

$('.jarallax').jarallax({
    speed: 0.2
});

Options

Options can be passed in data attributes or in object when you initialize jarallax from script.

name type default description
type string scroll scroll, scale, opacity, scroll-opacity, scale-opacity
speed float 0.5 Parallax effect speed. Provide numbers from 0.0 to 1.0
imgSrc path null Image path. By default used image from background.
imgWidth number null You can provide the natural width and natural height of an image to speed up loading.
imgHeight number null
enableTransform boolean true Enable transformations for effect if supported. When option is false - used background-position instead.
zIndex number -100 z-index of parallax container.

Events

Evenets used the same way as Options.

name description
onScroll Called when parallax working. Use first argument with calculations. More info see below.
onInit Called after init end.
onDestroy Called after destroy.
onCoverImage Called after cover image.

onScroll event

$('.jarallax').jarallax({
    onScroll: function(calculations) {
        console.log(calculations);
    }
});

Console Result:

{
    // parallax section client rect (top, left, width, height)
    rect            : object,
    
    // see image below for more info
    beforeTop       : float,
    beforeTopEnd    : float,
    afterTop        : float,
    beforeBottom    : float,
    beforeBottomEnd : float,
    afterBottom     : float,

    // percent of visible part of section (from 0 to 1)
    visiblePercent  : float
}

Calculations example: On Scroll Calculations

Images

All demo images from https://www.pexels.com/

License

Copyright (c) 2015 _nK Licensed under the WTFPL license.

jarallax's People

Contributors

nk-o avatar

Watchers

 avatar

Forkers

goldstar0415

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.