search

jetmartin / responsive-lazy-loader

A responsive lazy loader. Load image rendition according to CSS display & breakpoint.
Other
23 stars 11 forks source link

readme

responsive-lazy-loader

Notice : This module is deprecated.

I will not maintain this module anymore. If someone want to maintain it, I can share repos ownership.

A responsive lazy loader. Load image rendition according to CSS display & breakpoint.

Main frame

Responsive lazy loader allows you lo load the most appropriate image renditions according to the current breakpoint and to the current display into the CSS grid-system.

It can be used as a simple lazy loader, simply as a responsive lazy loader (taking care of the breakpoint) or as an advanced lazy loader taking care of breakpoint and display.

How it works

The lazy loader recognizes the current display (size in a grid system for example) and breakpoint (mediaquery) and replaces a token in the image URL.

It works with any HTML/CSS structure/framework as bootstrap or foundation and any image provider as Flickr or CMS using image preset (rendition, styles, ...) as Adobe CQ or Drupal.

The plugin is only 4Ko (minified).

View a demo.

How to use

HTML

Replace your img tags by the following :

<img class="img-responsive" data-src="http://www.domain.tld/img-[[display]].jpg" src="https://github.com/jetmartin/responsive-lazy-loader/raw/master/js/pixel.gif" alt="image">
<noscript><img class="image-asset" src="http://www.domain.tld/img-defaults.jpg" alt="image"></noscript>

CSS

The image size must be at 100% for the image to be "responsive", it means that the image will be adjusted to the parent element. You must set up your breakpoint to never upscale an image and to load the image closest to the maximum display width.

For example, if your site is 1200px on desktop you have to load an image as close as possible to 1200px but on a phone, if your max-width is 320 pixels, you have to load an image as close as possible to 320 but not too small.

For a nice display, you need to use a "loader" background for the images and/or outline. It could be something like :

.img-responsive{
    width:100%;
    outline:#aaa;
    background:#ccc url(../img/loader.gif) center center no-repeat;
}

Add the noscript fallback :

<noscript><style type="text/css" media="all">img[data-src] { display: none; }</style></noscript>

Always use the "desktop" as default value because almost all modern device browsers support mediaqueries detections. This is not the case for old desktop browsers, such as old IE, so the current mediaquery will always be the "defaults" one. Even in an old browser, the display will be recognized and the appropriate image will load anyway.

Tip

The height auto is not displayed the same way on all the browsers. To prevent the image height to change on an image load (text moving effect in some browsers), the image height has to be managed in CSS according to the site layout.

If all the images do not necessary have the same ratio (as 16/9 or 4/3), you can use the onImageShow callback function for custom actions.

How to configure

You can add arguments on the function call or override the defaults.

$("img[data-src]").responsivelazyloader({
    mediaQueries : {  // The mediaqueries used by the lazyloder.
      'phone'   : "(max-width: 767px)",
      'tablet'  : "(min-width: 768px) and (max-width: 991px)",
      'desktop' : "(min-width: 992px)"
    },
    displays : {  // The displays to combine grid system & mediaqueries
        'defaults' : {
            'display' : {
                'desktop'  : 'b',   //1024
                'tablet'   : 'z',   //640
                'phone'    : 'm',   //320
                'defaults' : 'b'    //1024
            }
        }
    }
});

Or

// Owerrde defaults
$.fn.responsivelazyloader.defaults.mediaQueries = {  // The mediaqueries used by the lazyloder.
        'phone'    : "(max-width: 767px)",
        'tablet'   : "(min-width: 768px) and (max-width: 991px)",
        'desktop'  : "(min-width: 992px)"
    };
$.fn.responsivelazyloader.defaults.displays = { // The displays to combine grid system & mediaqueries
        'defaults' : {
            'display' : {
                'desktop'  : 'b',   //1024
                'tablet'   : 'z',   //640
                'phone'    : 'm',   //320
                'defaults' : 'b'    //1024
            }
        }
    };
$("img[data-src]").responsivelazyloader();

How to use Breakpoints (mediaQueries)

In order to be consistant with CSS declaration, the latest valid mediquery will be used. You can use simple mediaqueries or more complex ones using orientation or pixel-ratio. To start in a simple way with the plugin, copy/past the mediaqueries in the same order from your steelsheets.

Use Multiple displays

Do not use multiple instances of the plugin, use the displays. You can declare diffrent configuration for some images in the same page using the displays config element. The first valid display will be used for each image. You can specify multiples "displays" using a "gridClass" (on the image itself or a parent element). The "parent" parameter is now optional. If you ecalre a "parent" element, it must have the "gridClass". "parent" is a jQuery element declaration as ".myParentClass" or "section.myParentClass". "gridClass" is a class name as "myDisplayClass". Always use a "defaults" display and a "defaults" on each display to prevent issues and to make display detection usable with old browsers.

<section>
  <article class="sidebar">{...}</article>
  <aside class="sidebar">{...}</aside>
</section>
$.fn.responsivelazyloader.defaults.displays = { // The displays to combine grid system &amp; mediaqueries
        'articleWithSidebar' : {
            'parent' : 'article.sidebar',
            'gridClass' : 'sidebar',
            'display' : {
                'phone'    : 'm',   //320
                'defaults' : 'z'    //640
            }
        },
        'sidebar' : {
            'gridClass' : 'sidebar',
            'display' : {
                'defaults' : 'm'    //320
            }
        },
        'defaults' : {
            'display' : {
                'desktop'  : 'b',   //1024
                'tablet'   : 'z',   //640
                'phone'    : 'm',   //320
                'defaults' : 'b'    //1024
            }
        }
    };

Override image url for display and/or breakpoint

The image url can be overriden for a specific display and/or breakpoint using some additionals attributs.

  1. "data-src-{display}-{mediaquerie}" will override image url for a combinaison of display & breakpoint.
  2. "data-src-{display}" will override image url for a display.
  3. "data-src-{mediaquerie}" will override image url for a breakpoint (mediaquerie).

Where "{display}" and "{mediaquerie}" are teh display and mediaquerie names in settings array.

Important notice about the "Token" on the image urls.

  1. If you use it, the images will be loaded according to the configuration of the lazyloader.
  2. If you do not use it, the same image will be loaded for each displays/breakpoints.

If your CMS/Framwork do not allows you to use non valid images urls (using token), you can use this way to use the lazyloader. In this case, to prevent bugs, set a "data-src-defaults" attribut.

The following exemple is for a breakpoint name "phone" and a display name "sidebar". The image loaded on display "sidebar" will be a specif one using the responsive token. The images loaded for the breakpoint "phone" do not use the responsie token.

<img
  class="img-responsive"
  data-src-sidebar-phone="http://www.domain.tld/an-image.jpg"
  data-src-sidebar="http://www.domain.tld/another-image-[[display]].jpg"
  data-src-phone="http://www.domain.tld/a-third-image.jpg"
  data-src="http://www.domain.tld/image-[[display]].jpg"
  src="https://github.com/jetmartin/responsive-lazy-loader/raw/master/js/pixel.gif"
  alt="image">
<noscript><img class="image-asset" src="http://www.domain.tld/image-defaults.jpg" alt="image"></noscript>

AJAX

The lazyloader can be used with AJAX.

// Init lazyloader
$("img[data-src]").responsivelazyloader();
// Init lazyloder after ajax events.
$(document).ajaxStop(function(){ $("img[data-src]").responsivelazyloader(); });

Settings

All available settings :

  1. distance = Int | distance of the image to the viewable browser screen before it gets loaded
  2. token = string | The token replaced by the current display pattern.
  3. force = Bool | Force loading without distance.
  4. mediaQueries = Object | The mediaquery used by the lazy loader.
  5. displays = Object | The display properties, match the grid class and the mediaqueries
  6. onImageShow = function | Callback when an image has been lazy loaded.
  7. onImageError = function | Callback when an image could not be lazy loaded.
  8. onAllImagesLoad = function | Callback when all the images of the set are loaded.

Custom events :

  1. responsiveImageLoaded -> Trigger on each image load. Custom var :
    • image : The currently loaded image.
  2. onMediaqueryChange -> Trigger when mediaquery has change. Custom var :
    • CurrentMediaQuery : the current mediaquery key according to Settings.mediaQueries.
    • PreviousMediaQuery : The previous mediaquery key according to Settings.mediaQueries.

Debug

To help you setup the lazyloader, you can use the following code :

$(window).on('responsiveImageLoaded', function(event){
    $image = $(event.image[0]);
    $image.next().remove();
    $image.after(
        "<p>Current mediaquerry : " + $image.attr("data-current-mediaq")
        + "<br />Current display : " + $image.attr("data-display") + "</p>"
    );
});

Images do not load

If you are using parallax or single page design, anyway fixe positionning, you will may have some troubles on image visibility detection. In this case you can override the windovWiew function to be able to manage the "visibility" of images according to your specific layout/library.

More

See the responsive lazy loader page on jQuery.com.

You can also use Responsive Lazy Loader on Drupal using our Drupal Module.

For more information, please contact me @j_et_martin.

This module was initialy supported by Valtech.