rightspot / lazyload-rails Goto Github PK

This project integrates the jQuery Lazy Load Plugin for Rails image_tag helpers

From the project page:

Lazy Load is a jQuery plugin written in JavaScript. It delays loading of images in long web pages. Images outside of viewport (visible part of web page) won't be loaded before user scrolls to them. This is opposite of image preloading.

Using Lazy Load on long web pages containing many large images makes the page load faster. Browser will be in ready state after loading visible images. In some cases it can also help to reduce server load.

See example (scroll down to see images load)

• Automatically get Rails image_tag helpers to render lazyload-friendly html img tags.
• Simple, really. That's pretty much it.

<%= image_tag "kittenz.png", alt: "OMG a cat!" %>

Equals:

<img alt="OMG a cat!" data-original="/images/kittenz.png" src="http://www.appelsiini.net/projects/lazyload/img/grey.gif">

Add this line to your application's Gemfile:

gem "lazyload-rails"

Download the jQuery Lazy Load Plugin into your vendor/assets/javascripts directory and include it however you prefer.

And in your JavaScript code do:

$("img").lazyload();

Lazy Load can be customized, see more options

Important: Remember that the Lazy Load Plugin depends on jQuery.

By default, a 1x1 grey gif is used as placeholder (from http://appelsiini.net/projects/lazyload/img/grey.gif). This can be easily customized:

# config/initializers/lazyload.rb
Lazyload::Rails.configure do |config|
  config.placeholder = "/public/img/grey.gif"
end

• Q: How can I use the old image_tag method?
• R: Try with x_image_tag

Lazyload-Rails is released under the MIT License.