fancybox3 · Documentation

- Introduction
- Setup
- How to Use
- Media types
  - Images
  - Video
  - Iframe
  - Inline
  - Ajax
- Options
- Api
- Modules
- FAQ

## Introduction

Get started with fancybox, probably the world’s most popular lightbox script.

### Dependencies

jQuery 3+ is preferred, but fancybox works with jQuery 1.9.1+ and jQuery 2+

### Compatibility

fancybox includes support for touch gestures and even supports pinch gestures for zooming. It is perfectly suited for both mobile and desktop browsers.

fancybox has been tested in following browsers/devices:

- Chrome
- Firefox
- IE10/11
- Edge
- iOS Safari
- Android 7.0 Tablet

## Setup

You can install fancybox by linking `.css` and `.js` files to your html file. Make sure you also load the jQuery library. Below is a basic HTML template to use as an example:

    <!DOCTYPE html>
    <html>
    <head>
    	<meta charset="utf-8">
    	<title>My page</title>

    	<!-- CSS -->
    	<link rel="stylesheet" type="text/css" href="jquery.fancybox.min.css">
    </head>
    <body>

    	<!-- Your HTML content goes here -->

    	<!-- JS -->
    	<script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
    	<script src="jquery.fancybox.min.js"></script>
    </body>
    </html>

### Download fancybox

Download the latest version of fancybox on GitHub.
Or just link directly to fancybox files on cdnjs - https://cdnjs.com/libraries/fancybox.

### Package Managers

fancybox is also available on npm and Bower.

    # NPM
    npm install @fancyapps/fancybox --save

    # Bower
    bower install fancybox --save

#### Important

- Make sure you add the jQuery library before the fancybox JS file
- If you already have jQuery on your page, you shouldn't include it second time
- Do not include both fancybox.js and fancybox.min.js files
- Some functionality (ajax, iframes, etc) will not work when you're opening local file directly on your browser, the code must be running on a web server

## How to Use

### Initialize with data attributes

The most basic way to use fancybox is by adding the `data-fancybox` attribute to your element. This will automatically bind click event that will start fancybox. Use `href` or `data-src` attribute to specify source of your content. Example:

    <a href="image.jpg" data-fancybox data-caption="Caption for single image">
    	<img src="thumbnail.jpg" alt="" />
    </a>

View demo on CodePen

If you have a group of items, you can use the same attribute `data-fancybox` value for each of them to create a gallery. Each group should have a unique value. Example:

    <a href="image_1.jpg" data-fancybox="gallery" data-caption="Caption #1">
    	<img src="thumbnail_1.jpg" alt="" />
    </a>

    <a href="image_2.jpg" data-fancybox="gallery" data-caption="Caption #2">
    	<img src="thumbnail_2.jpg" alt="" />
    </a>

View demo on CodePen

If you choose this method, default settings will be applied. See options section for examples how to customize by changing defaults, using `data-options` attribute or by initializing with JavaScript.

Info Sometimes you have multiple links pointing to the same source and that creates duplicates in the gallery. To avoid that, simply use `data-fancybox-trigger` attribute with the same value used for `data-fancybox` attribute for your other links. Optionally, use `data-fancybox-index` attribute to specify index of starting element:

    <a data-fancybox-trigger="gallery" href="javascript:;">
        <img src="thumbnail_1.jpg" alt="" />
    </a>

View demo on CodePen

### Initialize with JavaScript

Select your elements with a jQuery selector (you can use any valid selector) and call the `fancybox` method:

    $('[data-fancybox="gallery"]').fancybox({
    	// Options will go here
    });

View demo on CodePen

Info Sometimes you might need to bind fancybox to dynamically added elements. Use `selector` option to attach click event listener for elements that exist now or in the future. All selected items will be automatically grouped in the gallery. Example:

    $().fancybox({
        selector : '.imglist a:visible'
    });

View demo on CodePen

### Use with Javascript

You can also open and close fancybox programmatically. Here are a couple of examples, visit API section for more information and demos.

Display simple message:

    $.fancybox.open('<div class="message"><h2>Hello!</h2><p>You are awesome!</p></div>');

View demo on CodePen

Display iframed page:

    $.fancybox.open({
    	src  : 'link-to-your-page.html',
    	type : 'iframe',
    	opts : {
    		afterShow : function( instance, current ) {
    			console.info( 'done!' );
    		}
    	}
    });

View demo on CodePen

#### Important

fancybox attempts to automatically detect the type of content based on the given url. If it cannot be detected, the type can also be set manually using `data-type` attribute (or `type` option). Example:

    <a href="images.php?id=123" data-type="image" data-caption="Caption">
    	Show image
    </a>

## Media types

fancybox is designed to display images, video, iframes and any HTML content. For your convenience, there is a built in support for inline content and ajax.

### Images

The standard way of using fancybox is with a number of thumbnail images that link to larger images:

    <a href="image.jpg" data-fancybox="images" data-caption="My caption">
    	<img src="thumbnail.jpg" alt="" />
    </a>

View demo on CodePen

By default, fancybox fully preloads an image before displaying it. You can choose to display the image right away. It will render and show the full size image while the data is being received. To do so, some attributes are necessary:

- `data-width` - the real width of the image
- `data-height` - the real height of the image

    <a href="image.jpg" data-fancybox="images" data-width="2048" data-height="1365">
        <img src="thumbnail.jpg" />
    </a>

View demo on CodePen

You can also use these `width` and `height` properties to control size of the image. This can be used to make images look sharper on retina displays. Example:

    $('[data-fancybox="images"]').fancybox({
        afterLoad : function(instance, current) {
            var pixelRatio = window.devicePixelRatio || 1;

            if ( pixelRatio > 1.5 ) {
                current.width  = current.width  / pixelRatio;
                current.height = current.height / pixelRatio;
            }
        }
    });

View demo on CodePen

fancybox supports "srcset" so it can display different images based on viewport width. You can use this to improve download times for mobile users and over time save bandwidth. Example:

    <a href="medium.jpg" data-fancybox="images" data-srcset="large.jpg 1600w, medium.jpg 1200w, small.jpg 640w">
    	<img src="thumbnail.jpg" />
    </a>

View demo on CodePen

It is also possible to protect images from downloading by right-click. While this does not protect from truly determined users, it should discourage the vast majority from ripping off your files. Optionally, put the watermark over image.

    $('[data-fancybox]').fancybox({
    	protect: true
    });

View demo on CodePen

### Video

YouTube and Vimeo videos can be used with fancybox by just providing the page URL. Link to MP4 video directly or use trigger element to display hidden `<video>` element.

Use `data-width` and `data-height` attributes to customize video dimensions and `data-ratio` for the aspect ratio.

    <a data-fancybox href="https://www.youtube.com/watch?v=_sI_Ps7JSEk">
        YouTube video
    </a>

    <a data-fancybox href="https://vimeo.com/191947042">
        Vimeo video
    </a>

    <a data-fancybox data-width="640" data-height="360" href="video.mp4">
        Direct link to MP4 video
    </a>

    <a data-fancybox href="#myVideo">
        HTML5 video element
    </a>

    <video width="640" height="320" controls id="myVideo" style="display:none;">
        <source src="https://www.html5rocks.com/en/tutorials/video/basics/Chrome_ImF.mp4" type="video/mp4">
        <source src="https://www.html5rocks.com/en/tutorials/video/basics/Chrome_ImF.webm" type="video/webm">
        <source src="https://www.html5rocks.com/en/tutorials/video/basics/Chrome_ImF.ogv" type="video/ogg">
        Your browser doesn't support HTML5 video tag.
    </video>

View demo on CodePen

Controlling YouTube & Vimeo video via URL parameters:

    <a data-fancybox href="https://www.youtube.com/watch?v=_sI_Ps7JSEk&amp;autoplay=1&amp;rel=0&amp;controls=0&amp;showinfo=0">
        YouTube video - hide controls and info
    </a>

    <a data-fancybox href="https://vimeo.com/191947042?color=f00">
        Vimeo video - custom color
    </a>

View demo on CodePen

Via JavaScript:

    $('[data-fancybox]').fancybox({
        youtube : {
            controls : 0,
            showinfo : 0
        },
        vimeo : {
            color : 'f00'
        }
    });

View demo on CodePen

### Iframe

If you need to display content from another page, add `data-fancybox` and `data-type="iframe"` attributes to your link. This would create `<iframe>` element that allows to embed an entire web document inside the modal.

    <a data-fancybox data-type="iframe" data-src="http://codepen.io/fancyapps/full/jyEGGG/" href="javascript:;">
    	Webpage
    </a>

    <a data-fancybox data-type="iframe" data-src="https://mozilla.github.io/pdf.js/web/viewer.html" href="javascript:;">
        Sample PDF file
    </a>

View demo on CodePen

If you have not disabled iframe preloading (using `preload` option), the script will atempt to calculate content dimensions and will adjust width/height of `<iframe>` to fit with content in it. Keep in mind, that due to same origin policy, there are some limitations.

This example will disable iframe preloading and will display small close button next to iframe instead of the toolbar:

    $('[data-fancybox]').fancybox({
    	toolbar  : false,
    	smallBtn : true,
    	iframe : {
    		preload : false
    	}
    })

View demo on CodePen

Iframe dimensions can be controlled by CSS:

    .fancybox-slide--iframe .fancybox-content {
        width  : 800px;
        height : 600px;
        max-width  : 80%;
        max-height : 80%;
        margin: 0;
    }

These CSS rules can be overridden by JS, if needed:

    $("[data-fancybox]").fancybox({
        iframe : {
            css : {
                width : '600px'
            }
        }
    });

How to access and control fancybox in parent window from inside an iframe:

    // Close current fancybox instance
    parent.jQuery.fancybox.getInstance().close();

    // Adjust iframe height according to the contents
    parent.jQuery.fancybox.getInstance().update();

### Inline

fancybox can be used to display any HTML element on the page. First, create a hidden element with unique ID:

    <div style="display: none;" id="hidden-content">
    	<h2>Hello</h2>
    	<p>You are awesome.</p>
    </div>

Then simply create a link having `data-src` attribute that matches ID of the element you want to open (preceded by a hash mark (#); in this example - `#hidden-content`):

    <a data-fancybox data-src="#hidden-content" href="javascript:;">
    	Trigger the fancybox
    </a>

View demo on CodePen

The script will append small close button (if you have not disabled by `smallBtn:false`) and will not apply any styles except for centering. Therefore you can easily set custom dimensions using CSS.

Info If necessary, you can make your element (and similarly any other html content) scrollable by adding additional wrapping element and some CSS - view demo on CodePen.

### Ajax

To load your content via AJAX, you need to add a `data-type="ajax"` attribute to your link:

    <a data-fancybox data-type="ajax" data-src="my_page.com/path/to/ajax/" href="javascript:;">
    	AJAX content
    </a>

View demo on CodePen

Additionally it is possible to define a selector with the `data-filter` attribute to show only a part of the response. The selector can be any string, that is a valid jQuery selector:

    <a data-fancybox data-type="ajax" data-src="my_page.com/path/to/ajax/" data-filter="#two" href="javascript:;">
    	AJAX content
    </a>

View demo on CodePen

## Options

Quick reference for all default options as defined in the source:

    var defaults = {
      // Close existing modals
      // Set this to false if you do not need to stack multiple instances
      closeExisting: false,

      // Enable infinite gallery navigation
      loop: false,

      // Horizontal space between slides
      gutter: 50,

      // Enable keyboard navigation
      keyboard: true,

      // Should allow caption to overlap the content
      preventCaptionOverlap: true,

      // Should display navigation arrows at the screen edges
      arrows: true,

      // Should display counter at the top left corner
      infobar: true,

      // Should display close button (using `btnTpl.smallBtn` template) over the content
      // Can be true, false, "auto"
      // If "auto" - will be automatically enabled for "html", "inline" or "ajax" items
      smallBtn: "auto",

      // Should display toolbar (buttons at the top)
      // Can be true, false, "auto"
      // If "auto" - will be automatically hidden if "smallBtn" is enabled
      toolbar: "auto",

      // What buttons should appear in the top right corner.
      // Buttons will be created using templates from `btnTpl` option
      // and they will be placed into toolbar (class="fancybox-toolbar"` element)
      buttons: [
        "zoom",
        //"share",
        "slideShow",
        //"fullScreen",
        //"download",
        "thumbs",
        "close"
      ],

      // Detect "idle" time in seconds
      idleTime: 3,

      // Disable right-click and use simple image protection for images
      protect: false,

      // Shortcut to make content "modal" - disable keyboard navigtion, hide buttons, etc
      modal: false,

      image: {
        // Wait for images to load before displaying
        //   true  - wait for image to load and then display;
        //   false - display thumbnail and load the full-sized image over top,
        //           requires predefined image dimensions (`data-width` and `data-height` attributes)
        preload: false
      },

      ajax: {
        // Object containing settings for ajax request
        settings: {
          // This helps to indicate that request comes from the modal
          // Feel free to change naming
          data: {
            fancybox: true
          }
        }
      },

      iframe: {
        // Iframe template
        tpl:
          '<iframe id="fancybox-frame{rnd}" name="fancybox-frame{rnd}" class="fancybox-iframe" allowfullscreen allow="autoplay; fullscreen" src=""></iframe>',

        // Preload iframe before displaying it
        // This allows to calculate iframe content width and height
        // (note: Due to "Same Origin Policy", you can't get cross domain data).
        preload: true,

        // Custom CSS styling for iframe wrapping element
        // You can use this to set custom iframe dimensions
        css: {},

        // Iframe tag attributes
        attr: {
          scrolling: "auto"
        }
      },

      // For HTML5 video only
      video: {
        tpl:
          '<video class="fancybox-video" controls controlsList="nodownload" poster="{{poster}}">' +
          '<source src="{{src}}" type="{{format}}" />' +
          'Sorry, your browser doesn\'t support embedded videos, <a href="{{src}}">download</a> and watch with your favorite video player!' +
          "</video>",
        format: "", // custom video format
        autoStart: true
      },

      // Default content type if cannot be detected automatically
      defaultType: "image",

      // Open/close animation type
      // Possible values:
      //   false            - disable
      //   "zoom"           - zoom images from/to thumbnail
      //   "fade"
      //   "zoom-in-out"
      //
      animationEffect: "zoom",

      // Duration in ms for open/close animation
      animationDuration: 366,

      // Should image change opacity while zooming
      // If opacity is "auto", then opacity will be changed if image and thumbnail have different aspect ratios
      zoomOpacity: "auto",

      // Transition effect between slides
      //
      // Possible values:
      //   false            - disable
      //   "fade'
      //   "slide'
      //   "circular'
      //   "tube'
      //   "zoom-in-out'
      //   "rotate'
      //
      transitionEffect: "fade",

      // Duration in ms for transition animation
      transitionDuration: 366,

      // Custom CSS class for slide element
      slideClass: "",

      // Custom CSS class for layout
      baseClass: "",

      // Base template for layout
      baseTpl:
        '<div class="fancybox-container" role="dialog" tabindex="-1">' +
        '<div class="fancybox-bg"></div>' +
        '<div class="fancybox-inner">' +
        '<div class="fancybox-infobar"><span data-fancybox-index></span>&nbsp;/&nbsp;<span data-fancybox-count></span></div>' +
        '<div class="fancybox-toolbar">{{buttons}}</div>' +
        '<div class="fancybox-navigation">{{arrows}}</div>' +
        '<div class="fancybox-stage"></div>' +
        '<div class="fancybox-caption"><div class=""fancybox-caption__body"></div></div>' +
        '</div>'; +
        '</div>',

      // Loading indicator template
      spinnerTpl: '<div class="fancybox-loading"></div>',

      // Error message template
      errorTpl: '<div class="fancybox-error"><p>{{ERROR}}</p></div>',

      btnTpl: {
        download:
          '<a download data-fancybox-download class="fancybox-button fancybox-button--download" title="{{DOWNLOAD}}" href="javascript:;">' +
          '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.62 17.09V19H5.38v-1.91zm-2.97-6.96L17 11.45l-5 4.87-5-4.87 1.36-1.32 2.68 2.64V5h1.92v7.77z"/></svg>' +
          "</a>",

        zoom:
          '<button data-fancybox-zoom class="fancybox-button fancybox-button--zoom" title="{{ZOOM}}">' +
          '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.7 17.3l-3-3a5.9 5.9 0 0 0-.6-7.6 5.9 5.9 0 0 0-8.4 0 5.9 5.9 0 0 0 0 8.4 5.9 5.9 0 0 0 7.7.7l3 3a1 1 0 0 0 1.3 0c.4-.5.4-1 0-1.5zM8.1 13.8a4 4 0 0 1 0-5.7 4 4 0 0 1 5.7 0 4 4 0 0 1 0 5.7 4 4 0 0 1-5.7 0z"/></svg>' +
          "</button>",

        close:
          '<button data-fancybox-close class="fancybox-button fancybox-button--close" title="{{CLOSE}}">' +
          '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 10.6L6.6 5.2 5.2 6.6l5.4 5.4-5.4 5.4 1.4 1.4 5.4-5.4 5.4 5.4 1.4-1.4-5.4-5.4 5.4-5.4-1.4-1.4-5.4 5.4z"/></svg>' +
          "</button>",

        // Arrows
        arrowLeft:
          '<button data-fancybox-prev class="fancybox-button fancybox-button--arrow_left" title="{{PREV}}">' +
          '<div><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.28 15.7l-1.34 1.37L5 12l4.94-5.07 1.34 1.38-2.68 2.72H19v1.94H8.6z"/></svg></div>' +
          "</button>",

        arrowRight:
          '<button data-fancybox-next class="fancybox-button fancybox-button--arrow_right" title="{{NEXT}}">' +
          '<div><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.4 12.97l-2.68 2.72 1.34 1.38L19 12l-4.94-5.07-1.34 1.38 2.68 2.72H5v1.94z"/></svg></div>' +
          "</button>",

        // This small close button will be appended to your html/inline/ajax content by default,
        // if "smallBtn" option is not set to false
        smallBtn:
          '<button type="button" data-fancybox-close class="fancybox-button fancybox-close-small" title="{{CLOSE}}">' +
          '<svg xmlns="http://www.w3.org/2000/svg" version="1" viewBox="0 0 24 24"><path d="M13 12l5-5-1-1-5 5-5-5-1 1 5 5-5 5 1 1 5-5 5 5 1-1z"/></svg>' +
          "</button>"
      },

      // Container is injected into this element
      parentEl: "body",

      // Hide browser vertical scrollbars; use at your own risk
      hideScrollbar: true,

      // Focus handling
      // ==============

      // Try to focus on the first focusable element after opening
      autoFocus: true,

      // Put focus back to active element after closing
      backFocus: true,

      // Do not let user to focus on element outside modal content
      trapFocus: true,

      // Module specific options
      // =======================

      fullScreen: {
        autoStart: false
      },

      // Set `touch: false` to disable panning/swiping
      touch: {
        vertical: true, // Allow to drag content vertically
        momentum: true // Continue movement after releasing mouse/touch when panning
      },

      // Hash value when initializing manually,
      // set `false` to disable hash change
      hash: null,

      // Customize or add new media types
      // Example:
      /*
        media : {
          youtube : {
            params : {
              autoplay : 0
            }
          }
        }
      */
      media: {},

      slideShow: {
        autoStart: false,
        speed: 3000
      },

      thumbs: {
        autoStart: false, // Display thumbnails on opening
        hideOnClose: true, // Hide thumbnail grid when closing animation starts
        parentEl: ".fancybox-container", // Container is injected into this element
        axis: "y" // Vertical (y) or horizontal (x) scrolling
      },

      // Use mousewheel to navigate gallery
      // If 'auto' - enabled for images only
      wheel: "auto",

      // Callbacks
      //==========

      // See Documentation/API/Events for more information
      // Example:
      /*
        afterShow: function( instance, current ) {
          console.info( 'Clicked element:' );
          console.info( current.opts.$orig );
        }
      */

      onInit: $.noop, // When instance has been initialized

      beforeLoad: $.noop, // Before the content of a slide is being loaded
      afterLoad: $.noop, // When the content of a slide is done loading

      beforeShow: $.noop, // Before open animation starts
      afterShow: $.noop, // When content is done loading and animating

      beforeClose: $.noop, // Before the instance attempts to close. Return false to cancel the close.
      afterClose: $.noop, // After instance has been closed

      onActivate: $.noop, // When instance is brought to front
      onDeactivate: $.noop, // When other instance has been activated

      // Interaction
      // ===========

      // Use options below to customize taken action when user clicks or double clicks on the fancyBox area,
      // each option can be string or method that returns value.
      //
      // Possible values:
      //   "close"           - close instance
      //   "next"            - move to next gallery item
      //   "nextOrClose"     - move to next gallery item or close if gallery has only one item
      //   "toggleControls"  - show/hide controls
      //   "zoom"            - zoom image (if loaded)
      //   false             - do nothing

      // Clicked on the content
      clickContent: function(current, event) {
        return current.type === "image" ? "zoom" : false;
      },

      // Clicked on the slide
      clickSlide: "close",

      // Clicked on the background (backdrop) element;
      // if you have not changed the layout, then most likely you need to use `clickSlide` option
      clickOutside: "close",

      // Same as previous two, but for double click
      dblclickContent: false,
      dblclickSlide: false,
      dblclickOutside: false,

      // Custom options when mobile device is detected
      // =============================================

      mobile: {
        preventCaptionOverlap: false,
        idleTime: false,
        clickContent: function(current, event) {
          return current.type === "image" ? "toggleControls" : false;
        },
        clickSlide: function(current, event) {
          return current.type === "image" ? "toggleControls" : "close";
        },
        dblclickContent: function(current, event) {
          return current.type === "image" ? "zoom" : false;
        },
        dblclickSlide: function(current, event) {
          return current.type === "image" ? "zoom" : false;
        }
      },

      // Internationalization
      // ====================

      lang: "en",
      i18n: {
        en: {
          CLOSE: "Close",
          NEXT: "Next",
          PREV: "Previous",
          ERROR: "The requested content cannot be loaded. <br/> Please try again later.",
          PLAY_START: "Start slideshow",
          PLAY_STOP: "Pause slideshow",
          FULL_SCREEN: "Full screen",
          THUMBS: "Thumbnails",
          DOWNLOAD: "Download",
          SHARE: "Share",
          ZOOM: "Zoom"
        },
        de: {
          CLOSE: "Schliessen",
          NEXT: "Weiter",
          PREV: "Zurück",
          ERROR: "Die angeforderten Daten konnten nicht geladen werden. <br/> Bitte versuchen Sie es später nochmal.",
          PLAY_START: "Diaschau starten",
          PLAY_STOP: "Diaschau beenden",
          FULL_SCREEN: "Vollbild",
          THUMBS: "Vorschaubilder",
          DOWNLOAD: "Herunterladen",
          SHARE: "Teilen",
          ZOOM: "Maßstab"
        }
      }
    };

Set instance options by passing a valid object to `fancybox()` method:

    $('[data-fancybox="gallery"]').fancybox({
    	thumbs : {
    		autoStart : true
    	}
    });

Plugin options / defaults are exposed in `$.fancybox.defaults` namespace so you can easily adjust them globally:

    $.fancybox.defaults.animationEffect = "fade";

Custom options for each element individually can be set by adding a `data-options` attribute to the element. This attribute should contain the properly formatted JSON object (remember, strings should be wrapped in double quotes).

It is also possible to quickly set any option using parameterized name of the selected option, for example, `animationEffect` would be `data-animation-effect`:

    <a data-fancybox data-options='{"caption" : "My caption", "src" : "https://codepen.io/about/", "type" : "iframe"}' href="javascript:;" class="btn btn-primary">
        Example #1
    </a>

    <a data-fancybox data-animation-effect="false" href="https://source.unsplash.com/0JYgd2QuMfw/1500x1000" class="btn btn-primary">
        Example #2
    </a>

View demo on CodePen

## API

The fancybox API offers a couple of methods to control fancybox. This gives you the ability to extend the plugin and to integrate it with other web application components.

### Core methods

Core methods are methods which affect/handle instances:

    // Start new fancybox instance
    $.fancybox.open( items, opts, index );

    // Get refrence to currently active fancybox instance
    $.fancybox.getInstance();

    // Close currently active fancybox instance (pass `true` to close all instances)
    $.fancybox.close();

    // Close all instances and unbind all events
    $.fancybox.destroy();

### Starting fancybox

When creating group objects manually, each item should follow this pattern:

    {
    	src  : '' // Source of the content
    	type : '' // Content type: image|inline|ajax|iframe|html (optional)
    	opts : {} // Object containing item options (optional)
    }

Example of opening image gallery programmatically:

    $.fancybox.open([
    	{
    		src  : '1_b.jpg',
    		opts : {
    			caption : 'First caption',
    			thumb   : '1_s.jpg'
    		}
    	},
    	{
    		src  : '2_b.jpg',
    		opts : {
    			caption : 'Second caption',
    			thumb   : '2_s.jpg'
    		}
    	}
    ], {
    	loop : false
    });

View demo on CodePen

It is also possible to pass only one object. Example of opening inline content:

    $.fancybox.open({
    	src  : '#hidden-content',
    	type : 'inline',
    	opts : {
    		afterShow : function( instance, current ) {
    			console.info( 'done!' );
    		}
    	}
    });

View demo on CodePen

If you wish to quickly display some html content (for example, a message), then you can use a simpler syntax. Do not forget to use a wrapping element around your content.

    $.fancybox.open('<div class="message"><h2>Hello!</h2><p>You are awesome!</p></div>');

View demo on CodePen

Group items can be collection of jQuery objects, too. This can be used, for example, to display group of inline elements:

    $('#test').on('click', function() {
      $.fancybox.open( $('.inline-gallery'), {
        touch: false
      });
    });

View demo on CodePen

### Instance methods

In order to use these methods, you need an instance of the plugin's object. There are 3 common ways to get the reference.

1) Using API method to get currently active instance:

    var instance = $.fancybox.getInstance();

2) While starting fancybox programmatically:

    var instance = $.fancybox.open(
    	// Your content and options
    );

3) From within the callback - first argument is always a reference to current instance:

    $('[data-fancybox="gallery"]').fancybox({
    	afterShow : function( instance, current ) {
    		console.info( instance );
    	}
    });

Once you have a reference to fancybox instance the following methods are available:

    // Go to next gallery item
    instance.next( duration );

    // Go to previous gallery item
    instance.previous( duration );

    // Switch to selected gallery item
    instance.jumpTo( index, duration );

    // Check if current image dimensions are smaller than actual
    instance.isScaledDown();

    // Scale image to the actual size of the image
    instance.scaleToActual( x, y, duration );

    // Check if image dimensions exceed parent element
    instance.canPan();

    // Scale image to fit inside parent element
    instance.scaleToFit( duration );

    // Update position and content of all slides
    instance.update();

    // Update slide position and scale content to fit
    instance.updateSlide( slide );

    // Update infobar values, navigation button states and reveal caption
    instance.updateControls( force );

    // Load custom content into the slide
    instance.setContent( slide, content );

    // Show loading icon inside the slide
    instance.showLoading( slide );

    // Remove loading icon from the slide
    instance.hideLoading( slide );

    // Try to find and focus on the first focusable element
    instance.focus();

    // Activates current instance, brings it to the front
    instance.activate();

    // Close instance
    instance.close();

You can also do something like this:

    $.fancybox.getInstance().jumpTo(1);

or simply:

    $.fancybox.getInstance('jumpTo', 1);

### Events

fancybox fires several events:

    beforeLoad   : Before the content of a slide is being loaded
    afterLoad    : When the content of a slide is done loading

    beforeShow   : Before open animation starts
    afterShow    : When content is done loading and animating

    beforeClose  : Before the instance attempts to close. Return false to cancel the close.
    afterClose   : After instance has been closed

    onInit       : When instance has been initialized
    onActivate   : When instance is brought to front
    onDeactivate : When other instance has been activated

Event callbacks can be set as function properties of the options object passed to fancybox initialization function:

    <script type="text/javascript">
    	$("[data-fancybox]").fancybox({
    		afterShow: function( instance, slide ) {

    			// Tip: Each event passes useful information within the event object:

    			// Object containing references to interface elements
    			// (background, buttons, caption, etc)
    			// console.info( instance.$refs );

    			// Current slide options
    			// console.info( slide.opts );

    			// Clicked element
    			// console.info( slide.opts.$orig );

    			// Reference to DOM element of the slide
    			// console.info( slide.$slide );

    		}
    	});
    </script>

Each callback receives two parameters - current fancybox instance and current gallery object, if exists.

It is also possible to attach event handler for all instances. To prevent interfering with other scripts, these events have been namespaced to `.fb`. These handlers receive 3 parameters - event, current fancybox instance and current gallery object.

Here is an example of binding to the `afterShow` event:

    $(document).on('afterShow.fb', function( e, instance, slide ) {
    	// Your code goes here
    });

If you wish to prevent closing of the modal (for example, after form submit), you can use `beforeClose` callback. Simply return `false`:

    beforeClose : function( instance, current, e ) {
    	if ( $('#my-field').val() == '' ) {
    		return false;
    	}
    }

## Modules

fancybox code is split into several files (modules) that extend core functionality. You can build your own fancybox version by excluding unnecessary modules, if needed. Each one has their own `js` and/or `css` files.

Some modules can be customized and controlled programmatically. List of all possible options:

    fullScreen: {
      autoStart: false
    },

    touch : {
      vertical : true,  // Allow to drag content vertically
      momentum : true   // Continuous movement when panning
    },

    // Hash value when initializing manually,
    // set `false` to disable hash change
    hash : null,

    // Customize or add new media types
    // Example:
    /*
    media : {
      youtube : {
        params : {
          autoplay : 0
        }
      }
    }
    */
    media : {},

    slideShow : {
      autoStart : false,
      speed     : 4000
    },

    thumbs : {
      autoStart   : false,                  // Display thumbnails on opening
      hideOnClose : true,                   // Hide thumbnail grid when closing animation starts
      parentEl    : '.fancybox-container',  // Container is injected into this element
      axis        : 'y'                     // Vertical (y) or horizontal (x) scrolling
    },

    share: {
      url: function(instance, item) {
        return (
          (!instance.currentHash && !(item.type === "inline" || item.type === "html") ? item.origSrc || item.src : false) || window.location
        );
      },
      tpl:
        '<div class="fancybox-share">' +
        "<h1>{{SHARE}}</h1>" +
        "<p>" +
        '<a class="fancybox-share__button fancybox-share__button--fb" href="https://www.facebook.com/sharer/sharer.php?u={{url}}">' +
        '<svg viewBox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><path d="m287 456v-299c0-21 6-35 35-35h38v-63c-7-1-29-3-55-3-54 0-91 33-91 94v306m143-254h-205v72h196" /></svg>' +
        "<span>Facebook</span>" +
        "</a>" +
        '<a class="fancybox-share__button fancybox-share__button--tw" href="https://twitter.com/intent/tweet?url={{url}}&text={{descr}}">' +
        '<svg viewBox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><path d="m456 133c-14 7-31 11-47 13 17-10 30-27 37-46-15 10-34 16-52 20-61-62-157-7-141 75-68-3-129-35-169-85-22 37-11 86 26 109-13 0-26-4-37-9 0 39 28 72 65 80-12 3-25 4-37 2 10 33 41 57 77 57-42 30-77 38-122 34 170 111 378-32 359-208 16-11 30-25 41-42z" /></svg>' +
        "<span>Twitter</span>" +
        "</a>" +
        '<a class="fancybox-share__button fancybox-share__button--pt" href="https://www.pinterest.com/pin/create/button/?url={{url}}&description={{descr}}&media={{media}}">' +
        '<svg viewBox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><path d="m265 56c-109 0-164 78-164 144 0 39 15 74 47 87 5 2 10 0 12-5l4-19c2-6 1-8-3-13-9-11-15-25-15-45 0-58 43-110 113-110 62 0 96 38 96 88 0 67-30 122-73 122-24 0-42-19-36-44 6-29 20-60 20-81 0-19-10-35-31-35-25 0-44 26-44 60 0 21 7 36 7 36l-30 125c-8 37-1 83 0 87 0 3 4 4 5 2 2-3 32-39 42-75l16-64c8 16 31 29 56 29 74 0 124-67 124-157 0-69-58-132-146-132z" fill="#fff"/></svg>' +
        "<span>Pinterest</span>" +
        "</a>" +
        "</p>" +
        '<p><input class="fancybox-share__input" type="text" value="{{url_raw}}" /></p>' +
        "</div>"
    }

##### Couple of examples

Show thumbnails on start:

    $('[data-fancybox="images"]').fancybox({
    	thumbs : {
    		autoStart : true
    	}
    });

View demo on CodePen

Customize share url if displaying hidden video element:

    $('[data-fancybox="test-share-url"]').fancybox({
        buttons : ['share', 'close'],
        hash : false,
        share : {
            url : function( instance, item ) {
                if (item.type === 'inline' && item.contentType === 'video') {
                    return item.$content.find('source:first').attr('src');
                }

                return item.src;
            }
        }
    });

View demo on CodePen

If you would inspect fancybox instance object, you would find that same keys ar captialized - these are references for each module object. Also, you would notice that fancybox uses common naming convention to prefix jQuery objects with `$`.

This is how you, for example, can access thumbnail grid element:

    $.fancybox.getInstance().Thumbs.$grid

This example shows how to call method that toggles thumbnails:

    $.fancybox.getInstance().Thumbs.toggle();

List of available methods:

    Thumbs.focus()
    Thumbs.update();
    Thumbs.hide();
    Thumbs.show();
    Thumbs.toggle();

    FullScreen.request( elem );
    FullScreen.exit();
    FullScreen.toggle( elem );
    FullScreen.isFullscreen();
    FullScreen.enabled();

    SlideShow.start();
    SlideShow.stop();
    SlideShow.toggle();

If you wish to disable hash module, use this snippet (after including JS file):

    $.fancybox.defaults.hash = false;

## FAQ

### #1 Opening/closing causes fixed element to jump

Simply add `compensate-for-scrollbar` CSS class to your fixed positioned elements. Example of using Bootstrap navbar component:

    <nav class="navbar navbar-inverse navbar-fixed-top compensate-for-scrollbar">
    	<div class="container">
    		..
    	</div>
    </nav>

View demo on CodePen

The script measures width of the scrollbar and creates `compensate-for-scrollbar` CSS class that uses this value for `margin-right` property. Therefore, if your element has `width:100%`, you should positon it using `left` and `right` properties instead. Example:

    .navbar {
    	position: fixed;
    	top: 0;
    	left: 0;
    	right: 0;
    }

### #2 How to customize caption

You can use `caption` option that accepts a function and is called for each group element. Example of appending image download link:

    $( '[data-fancybox="images"]' ).fancybox({
        caption : function( instance, item ) {
            var caption = $(this).data('caption') || '';

            if ( item.type === 'image' ) {
                caption = (caption.length ? caption + '<br />' : '') + '<a href="' + item.src + '">Download image</a>' ;
            }

            return caption;
        }
    });

View demo on CodePen

Add current image index and image count (the total number of images in the gallery) right in the caption:

    $( '[data-fancybox="images"]' ).fancybox({
        infobar : false,
        caption : function( instance, item ) {
            var caption = $(this).data('caption') || '';

            return ( caption.length ? caption + '<br />' : '' ) + 'Image <span data-fancybox-index></span> of <span data-fancybox-count></span>';
        }
    });

View demo on CodePen

Inside `caption` method, `this` refers to the clicked element. Example of using different source for caption:

    $( '[data-fancybox]' ).fancybox({
    	caption : function( instance, item ) {
    		return $(this).find('figcaption').html();
    	}
    });

View demo on CodePen

### #3 How to create custom button in the toolbar

Example of creating reusable button:

    // Create template for the button
    $.fancybox.defaults.btnTpl.fb = '<button data-fancybox-fb class="fancybox-button fancybox-button--fb" title="Facebook">' +
        '<svg viewBox="0 0 24 24">' +
            '<path d="M22.676 0H1.324C.594 0 0 .593 0 1.324v21.352C0 23.408.593 24 1.324 24h11.494v-9.294h-3.13v-3.62h3.13V8.41c0-3.1 1.894-4.785 4.66-4.785 1.324 0 2.463.097 2.795.14v3.24h-1.92c-1.5 0-1.793.722-1.793 1.772v2.31h3.584l-.465 3.63h-3.12V24h6.115c.733 0 1.325-.592 1.325-1.324V1.324C24 .594 23.408 0 22.676 0"/>' +
        '</svg>' +
    '</button>';

    // Make button clickable using event delegation
    $('body').on('click', '[data-fancybox-fb]', function() {
        window.open("https://www.facebook.com/sharer/sharer.php?u="+encodeURIComponent(window.location.href)+"&t="+encodeURIComponent(document.title), '','left=0,top=0,width=600,height=300,menubar=no,toolbar=no,resizable=yes,scrollbars=yes');
    });

    // Customize buttons
    $( '[data-fancybox="images"]' ).fancybox({
        buttons : [
            'fb',
            'close'
        ]
    });

View demo on CodePen

### #4 How to reposition thumbnail grid

There is currenty no JS option to change thumbnail grid position. But fancybox is designed so that you can use CSS to change position or dimension for each block (e.g., content area, caption or thumbnail grid). This gives you freedom to completely change the look and feel of the modal window, if needed. View demo on CodePen

### #5 How to disable touch gestures/swiping

When you want to make your content selectable or clickable, you have two options:

- disable touch gestures completely by setting `touch:false`
- add `data-selectable="true"` attribute to your html element

View demo on CodePen

### #6 Slider/carousel add's cloned duplicate items

If you are combining fancybox with slider/carousel script and that script clones items to enable infinite navigation, then duplicated items will appear in the gallery. To avoid that - 1) initialise fancybox on all items except cloned; 2) add custom click event on cloned items and trigger click event on corresponding "real" item. Here is an example using Slick slider:

    // Init fancybox
    // =============
    var selector = '.slick-slide:not(.slick-cloned)';

    // Skip cloned elements
    $().fancybox({
      selector : selector,
      backFocus : false
    });

    // Attach custom click event on cloned elements,
    // trigger click event on corresponding link
    $(document).on('click', '.slick-cloned', function(e) {
      $(selector)
        .eq( ( $(e.currentTarget).attr("data-slick-index") || 0) % $(selector).length )
        .trigger("click.fb-start", {
          $trigger: $(this)
        });

      return false;
    });

    // Init Slick
    // ==========
    $(".main-slider").slick({
      slidesToShow   : 3,
      infinite : true,
      dots     : false,
      arrows   : false
    });

View demo on CodePen

Back to Top