web5design / twentytwenty

jQuery Plugin to Compare Images

Basic usage

Create a container that holds two images:

<div id="container1">
 <!-- The before image is first -->
 <img src="http://placehold.it/400x200&text=1" />
 <!-- The after image is last -->
 <img src="http://placehold.it/400x200&text=2" />
</div>

Now initialize the plugin on the window load:

$(window).load(function(){
  $("#container1").twentytwenty();
});

Options

$(window).load(function(){
  $(".twentytwenty-container").twentytwenty({default_offset_pct: 0.7});
});

Prevent FOUC

If you want to avoid a FOUC you can append the twentytwenty-container class to your container like so:

<div id="container1" class="twentytwenty-container">
 <!-- The before image is first -->
 <img src="http://placehold.it/400x200&text=1" />
 <!-- The after image is last -->
 <img src="http://placehold.it/400x200&text=2" />
</div>

Multiple instances

If you want to use multiple instances of this plugin on a single page you can target the container class:

$(window).load(function(){
  $(".twentytwenty-container").twentytwenty();
});

Compass Quickstart

Run the following commands to get up and running quickly:

git clone [email protected]:zurb/compareit.git ~/Sites/compareit
cd compareit
bundle install
bundle exec compass compile

All default Sass variables can be found in scss/twentytwenty.scss.

Support

• IE8+
• Firefox (latest)
• Chrome
• Safari
• Android
• iOS (iPhone, iPad)

Dependencies

• jquery
• jquery.event.move

MIT Open Source License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.