Bump to v2.0.5
3 files changed
tree: edede9384e227a838719ca83e875462d63f44ac4
  1. demo/
  2. lib/
  3. source/
  5. README.md


fancyBox is a tool that offers a nice and elegant way to add zooming functionality for images, html content and multi-media on your webpages.

More information and examples: http://www.fancyapps.com/fancybox/

License: http://www.fancyapps.com/fancybox/#license

Copyright (c) 2012 Janis Skarnelis - janis@fancyapps.com

How to use

To get started, download the plugin, unzip it and copy files to your website/application directory. Load files in the section of your HTML document. Make sure you also add the jQuery library.

    <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
    <link rel="stylesheet" href="/fancybox/jquery.fancybox.css" type="text/css" media="screen" />
    <script type="text/javascript" src="/fancybox/jquery.fancybox.pack.js"></script>

Create your links with a title if you want a title to be shown, and add a class:

<a href="large_image.jpg" class="fancybox" title="Sample title"><img src="small_image.jpg" /></a>

If you have a set of related items that you would like to group, additionally include a group name in the rel (or data-fancybox-group) attribute:

<a href="large_1.jpg" class="fancybox" rel="gallery" title="Sample title 1"><img src="small_1.jpg" /></a>
<a href="large_2.jpg" class="fancybox" rel="gallery" title="Sample title 1"><img src="small_2.jpg" /></a>

Initialise the script like this:

    $(document).ready(function() {

May also be passed an optional options object which will extend the default values. Example:

    $(document).ready(function() {
            padding : 5,
            loop : false

Script uses the href attribute of the matched elements to obtain the location of the content and to figure out content type you want to display. You can specify type directly by adding classname (fancybox.image, fancybox.iframe, etc).

<a href="/example.html" class="fancybox fancybox.ajax">Example</a>

<a href="example.html" class="fancybox fancybox.iframe">Example</a>

<a href="#example" class="fancybox">Example</a>

<a href="example.swf" class="fancybox">Example</a>

<a href="example.jpg" class="fancybox">Example</a>

Note, ajax requests are subject to the same origin policy. If fancyBox will not be able to get content type, error message will be displayed (this is different from previsous versions where 'ajax' was used as default type).



Helpers provide a simple mechanism to extend the capabilities of fancyBox. There are two built-in helpers - 'overlay' and 'title'. You can disable them, set custom options or enable other helpers:

    helpers:  {
        overlay : null, /* Disables overlay helper */
        title:  {
            type : 'inside' /* Changes title location */
        thumbs : { /* Enables thumbnail helper */
            width: 50,
            height: 50


Also available are event driven callback methods. The this keyword refers to the current or upcoming object (depends on callback method). Here is how you can change title:

    beforeLoad : function() {
        this.title = 'Image ' + (this.index + 1) + ' of ' + this.group.length + (this.title ? ' - ' + this.title : '');

            "this.element" refers to current element, so you can, for example, use the "alt" attribute of the image to store the title:
            this.title = $(this.element).find('img').attr('alt');

It`s possible to open fancyBox programmatically in various ways:

HTML content:
$.fancybox( '<div><h1>Lorem Lipsum</h1><p>Lorem lipsum</p></div>', {
    title : 'Custom Title'

DOM element:
$.fancybox( $("#inline"), {
    title : 'Custom Title'

Custom object:
    href: 'example.jpg',
    title : 'Custom Title'

Array of objects:
        href: 'example1.jpg',
        title : 'Custom Title 1'
        href: 'example2.jpg',
        title : 'Custom Title 2'
], {
    padding: 0

There are several methods that allow you to interact with and manipulate fancyBox, example:

Close fancybox:

Bug tracker

Have a bug? Please create an issue on GitHub at https://github.com/fancyapps/fancyBox/issues