jQuery Integration

Jarallax provides seamless jQuery integration, allowing you to use familiar jQuery syntax for initializing and controlling parallax effects. This integration is perfect for projects already using jQuery or requiring legacy browser support.

Installation

Jarallax’s jQuery plugin is included in the UMD build. Include jQuery before Jarallax:

<!-- jQuery -->
<script src="https://cdn.jsdelivr.net/npm/jquery"></script>

<!-- Jarallax CSS -->
<link href="https://cdn.jsdelivr.net/npm/jarallax@2/dist/jarallax.min.css" rel="stylesheet">

<!-- Jarallax JS -->
<script src="https://cdn.jsdelivr.net/npm/jarallax@2/dist/jarallax.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/jarallax@2/dist/jarallax-video.min.js"></script>

jQuery integration is only available with the UMD build. ESM builds do not include jQuery support.

Basic Usage

Initialize Jarallax using jQuery selectors:

$('.jarallax').jarallax();

With custom options:

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

Complete Example

Here’s a full working example with jQuery:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Jarallax jQuery Example</title>

    <!-- Jarallax CSS -->
    <link href="https://cdn.jsdelivr.net/npm/jarallax@2/dist/jarallax.min.css" rel="stylesheet">

    <style>
      .section {
        height: 60vh;
        display: flex;
        align-items: center;
        justify-content: center;
      }

      .jarallax {
        height: 80vh;
      }
    </style>
  </head>
  <body>
    <div class="section">
      <h1>jQuery Example</h1>
    </div>

    <!-- Image Parallax -->
    <div class="jarallax">
      <img class="jarallax-img" src="https://jarallax.nkdev.info/images/image1.jpg" alt="">
    </div>

    <!-- Video Parallax -->
    <div class="jarallax" data-video-src="https://youtu.be/mru3Q5m4lkY"></div>

    <div class="section"></div>

    <!-- jQuery -->
    <script src="https://cdn.jsdelivr.net/npm/jquery"></script>

    <!-- Jarallax JS -->
    <script src="https://cdn.jsdelivr.net/npm/jarallax@2/dist/jarallax.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/jarallax@2/dist/jarallax-video.min.js"></script>

    <!-- Initialize Jarallax -->
    <script>
      $('.jarallax').jarallax();
    </script>
  </body>
</html>

jQuery Selectors

Use jQuery’s powerful selectors to target specific elements:

// Initialize all elements with .jarallax class
$('.jarallax').jarallax({
  speed: 0.5
});

Configuration Options

Pass options as an object to customize the parallax effect:

$('.jarallax').jarallax({
  // Parallax type: scroll, scale, opacity, scroll-opacity, scale-opacity
  type: 'scroll',
  
  // Parallax speed from -1.0 to 2.0
  speed: 0.5,
  
  // Custom image source
  imgSrc: 'path/to/image.jpg',
  
  // Image element selector
  imgElement: '.jarallax-img',
  
  // Image size (background-size or object-fit values)
  imgSize: 'cover',
  
  // Image position (background-position or object-position values)
  imgPosition: '50% 50%',
  
  // Image repeat
  imgRepeat: 'no-repeat',
  
  // Keep img tag in place
  keepImg: false,
  
  // z-index
  zIndex: -100,
  
  // Disable on mobile devices
  disableParallax: /iPad|iPhone|iPod|Android/,
  
  // Video options
  videoSrc: null,
  videoStartTime: 0,
  videoEndTime: 0,
  videoLoop: true,
  videoPlayOnlyVisible: true,
  videoLazyLoading: true,
  
  // Event callbacks
  onScroll: null,
  onInit: null,
  onDestroy: null,
  onCoverImage: null
});

Methods

Call methods on existing Jarallax instances using jQuery:

Destroy
isVisible
onResize
onScroll

Remove parallax effect and restore original state:

$('.jarallax').jarallax('destroy');

Check if parallax element is visible in viewport:

const isVisible = $('.jarallax').jarallax('isVisible');
console.log(isVisible);

Manually trigger resize calculation:

$('.jarallax').jarallax('onResize');

Manually trigger scroll calculation:

$('.jarallax').jarallax('onScroll');

Event Handling

Attach event handlers when initializing or after initialization:

Initialization Events

Pass event handlers as options:

$('.jarallax').jarallax({
  speed: 0.5,
  onInit: function() {
    console.log('Jarallax initialized on', this);
  },
  onDestroy: function() {
    console.log('Jarallax destroyed on', this);
  },
  onCoverImage: function() {
    console.log('Image covered on', this);
  }
});

Scroll Events

Monitor scroll calculations:

$('.jarallax').jarallax({
  onScroll: function(calculations) {
    console.log('Visible percent:', calculations.visiblePercent);
    console.log('From viewport center:', calculations.fromViewportCenter);
    
    // Custom behavior based on scroll position
    if (calculations.visiblePercent > 0.5) {
      $(this).addClass('more-visible');
    } else {
      $(this).removeClass('more-visible');
    }
  }
});

Custom Events

Use jQuery’s event system for additional functionality:

$('.jarallax')
  .jarallax({
    speed: 0.5,
    onInit: function() {
      $(this).trigger('jarallax.ready');
    }
  })
  .on('jarallax.ready', function() {
    console.log('Custom ready event fired');
  });

No Conflict Mode

Prevent namespace collisions when using multiple jQuery plugins:

// Save jarallax to a different namespace
const jarallaxPlugin = $.fn.jarallax.noConflict();

// Assign to new name
$.fn.newJarallax = jarallaxPlugin;

// Use with new name
$('.jarallax').newJarallax({
  speed: 0.5
});

Call noConflict() immediately after loading Jarallax and before any other code that might use $.fn.jarallax.

Video Backgrounds

Jarallax with jQuery supports YouTube, Vimeo, and self-hosted videos:

$('.jarallax').jarallax({
  speed: 0.2,
  videoSrc: 'https://www.youtube.com/watch?v=ab0TSkLe-E0',
  videoLoop: true,
  videoPlayOnlyVisible: true
});

Multiple Parallax Instances

Apply different settings to different elements:

// Slow parallax for hero sections
$('.hero-parallax').jarallax({
  speed: 0.2,
  type: 'scroll'
});

// Fast parallax for decorative elements
$('.fast-parallax').jarallax({
  speed: 0.8,
  type: 'scale'
});

// Opacity effect for backgrounds
$('.fade-parallax').jarallax({
  speed: 0.5,
  type: 'opacity'
});

// Combined effects
$('.fancy-parallax').jarallax({
  speed: 0.6,
  type: 'scroll-opacity'
});

Chaining Methods

Use jQuery chaining for cleaner code:

$('.jarallax')
  .jarallax({
    speed: 0.5,
    onInit: function() {
      console.log('Initialized');
    }
  })
  .addClass('parallax-active')
  .fadeIn(300);

Dynamic Initialization

Initialize parallax on dynamically added elements:

// Function to initialize new parallax elements
function initParallax() {
  $('.jarallax:not(.jarallax-initialized)').jarallax({
    speed: 0.5
  });
}

// Initial initialization
initParallax();

// Reinitialize after adding new content
$('#add-section').on('click', function() {
  const newSection = $('<div class="jarallax"><img class="jarallax-img" src="image.jpg" alt=""></div>');
  $('body').append(newSection);
  initParallax();
});

Advanced Patterns

Conditional Initialization
Responsive Speed
Toggle Parallax
Progress Indicator

Initialize only on desktop devices:

$(document).ready(function() {
  if ($(window).width() > 768) {
    $('.jarallax').jarallax({
      speed: 0.5
    });
  }
});

Adjust speed based on viewport size:

function initResponsiveParallax() {
  const speed = $(window).width() > 768 ? 0.5 : 0.2;
  
  $('.jarallax').jarallax('destroy').jarallax({
    speed: speed
  });
}

$(window).on('resize', initResponsiveParallax);
initResponsiveParallax();

Enable/disable parallax dynamically:

let parallaxEnabled = true;

$('#toggle-parallax').on('click', function() {
  if (parallaxEnabled) {
    $('.jarallax').jarallax('destroy');
    $(this).text('Enable Parallax');
  } else {
    $('.jarallax').jarallax({ speed: 0.5 });
    $(this).text('Disable Parallax');
  }
  parallaxEnabled = !parallaxEnabled;
});

Show scroll progress for parallax sections:

$('.jarallax').jarallax({
  speed: 0.5,
  onScroll: function(calculations) {
    const progress = Math.round(calculations.visiblePercent * 100);
    $(this).find('.progress-bar').css('width', progress + '%');
  }
});

Working with AJAX

Handle parallax in AJAX-loaded content:

// Load content via AJAX
$.ajax({
  url: '/api/get-content',
  success: function(data) {
    // Add content to page
    $('#content-container').html(data);
    
    // Initialize parallax on new elements
    $('#content-container .jarallax').jarallax({
      speed: 0.5,
      onInit: function() {
        console.log('AJAX parallax initialized');
      }
    });
  }
});

Troubleshooting

jQuery is not defined

Ensure jQuery is loaded before Jarallax:

<!-- Load jQuery first -->
<script src="https://cdn.jsdelivr.net/npm/jquery"></script>

<!-- Then load Jarallax -->
<script src="https://cdn.jsdelivr.net/npm/jarallax@2/dist/jarallax.min.js"></script>

Method not working

Check that Jarallax is initialized before calling methods:

// Initialize first
$('.jarallax').jarallax({ speed: 0.5 });

// Then call methods
$('.jarallax').jarallax('onResize');

Multiple initialization

Prevent double initialization:

// Destroy before reinitializing
$('.jarallax').jarallax('destroy').jarallax({
  speed: 0.5
});

Best Practices

Use document.ready

Always initialize Jarallax after DOM is ready:

$(document).ready(function() {
  $('.jarallax').jarallax({ speed: 0.5 });
});

Clean up on destroy

Remove parallax when elements are removed:

// Before removing elements
$('.jarallax').jarallax('destroy').remove();

Cache selectors

Store jQuery objects for better performance:

const $parallaxElements = $('.jarallax');
$parallaxElements.jarallax({ speed: 0.5 });

Migration from Vanilla JS

If you’re migrating from vanilla JavaScript:

jarallax(document.querySelectorAll('.jarallax'), {
  speed: 0.5
});

jarallax(document.querySelectorAll('.jarallax'), 'destroy');

Next Steps

Vanilla JavaScript

Learn Jarallax without jQuery

React & Next.js

Integrate with modern React applications

API Reference

Explore all available methods and options

Configuration

Advanced configuration options

Get Started

Guides

Examples

jQuery Integration

Installation

Basic Usage

Complete Example

jQuery Selectors

Configuration Options

Methods

Event Handling

No Conflict Mode

Video Backgrounds

Multiple Parallax Instances

Chaining Methods

Dynamic Initialization

Advanced Patterns

Working with AJAX

Troubleshooting

Best Practices

Migration from Vanilla JS

Next Steps

Vanilla JavaScript

React & Next.js

API Reference

Configuration

Build docs developers (and LLMs) love

Get Started

Guides

Examples

​Installation

​Basic Usage

​Complete Example

​jQuery Selectors

​Configuration Options

​Methods

​Event Handling

​No Conflict Mode

​Video Backgrounds

​Multiple Parallax Instances

​Chaining Methods

​Dynamic Initialization

​Advanced Patterns

​Working with AJAX

​Troubleshooting

​Best Practices

​Migration from Vanilla JS

​Next Steps

Vanilla JavaScript

React & Next.js

API Reference

Configuration

Build docs developers (and LLMs) love

Installation

Basic Usage

Complete Example

jQuery Selectors

Configuration Options

Methods

Event Handling

No Conflict Mode

Video Backgrounds

Multiple Parallax Instances

Chaining Methods

Dynamic Initialization

Advanced Patterns

Working with AJAX

Troubleshooting

Best Practices

Migration from Vanilla JS

Next Steps