2.1 下載fancyBox

可以在GIthub下載最新的版本。

或者直接引用 cdnjs —cdnjs.com/libraries/f…。

2.2 包管理工具

fancyBox 還可以通多 npm 和 Bower安裝。

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

5. 嵌入

支持的網站可以展示在 fancyBox 中，只需要提供頁面的地址即可：

<a data-fancybox >
  YouTube video
</a>

<a data-fancybox >
  Vimeo video
</a>

<a data-fancybox >
	Google Map
</a>

<a data-fancybox  data-caption="<span title=&quot;Edited&quot;>balloon rides at dawn ??<br>was such a magical experience floating over napa valley as the golden light hit the hills.<br><a href=&quot;https://www.instagram.com/jamesrelfdyer/&quot;>@jamesrelfdyer</a></span>">
	Instagram photo
</a>

5.1 視頻尺寸

通過 CSS 調整視頻的顯示大小：

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

5.2 視頻參數

通過 url 中的參數控制視頻

<a data-fancybox >
  YouTube video - hide controls and info
</a>

<a data-fancybox >
  Vimeo video - custom color
</a>

通過 JavaScript 控制視頻：

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

6. 選項

默認選項值快速參考：

var defaults = {

    // 相冊循環瀏覽
    loop : false,

    // 圖片周圍的margin，如果視口（viewport）寬度小于800px則忽略
    margin : [44, 0],

    // Horizontal space between slides
    gutter : 50,

    // 鍵盤瀏覽
    keyboard : true,

    // 是否在屏幕邊緣顯示箭頭
    arrows : true,

    // 是否顯示infobar (頂部的counter and arrows)
    infobar : true,

    // 是否顯示頂部的toolbar
    toolbar : true,

    // 控制頂部toolbar里顯示的圖表
  	// 通過`btnTpl`選項的模板創建按鈕，并被放置在toolbar(class="fancybox-toolbar"`的元素)中
    buttons : [
        'slideShow',
        'fullScreen',
        'thumbs',
        'share',
        //'download',
        //'zoom',
        'close'
    ],

    // 探測"idle"的時間(秒)
    idleTime : 3,

    // 是否在右上角顯示關閉按鈕
  	// 如果設置為'auto',遇到內容類型為html,inline,ajax時顯示
    // Use template from `btnTpl.smallBtn` for customization
    smallBtn : 'auto',

    // 保護文件，禁止右鍵下載
    protect : false,

    // Shortcut to make content "modal" - 禁止鍵盤瀏覽，隱藏按鈕等
    modal : false,

    image : {
      	// 預加載
      	// 需要預定義圖片的尺寸
      	// 設置為'auto'，自動在預覽圖中縮放
        preload : "auto"

    },

    ajax : {

        // 請求 ajax 的配置
        settings : {
          	// 表明請求是從模態框中發起，名字可改
            data : {
                fancybox : true
            }
        }

    },

    iframe : {

        // Iframe 模板
        tpl : '<iframe id="fancybox-frame{rnd}" name="fancybox-frame{rnd}" class="fancybox-iframe" frameborder="0" vspace="0" hspace="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen allowtransparency="true" src=""></iframe>',

        // 預加載
        // 由于同源策略，不能加載跨域數據
        preload : true,

      	// 自定義包裹 iframe 的元素的 CSS 樣式
      	// 這樣就可以自定義 iframe 的尺寸
        css : {},

        // iframe 標簽屬性
        attr : {
            scrolling : 'auto'
        }

    },

    // 如果內容類型不能自動檢測出來，默認值為'image'
    defaultType : 'image',

    // 打開/關閉動畫類型
    // 可用的值:
    //   false            - disable
    //   "zoom"           - zoom images from/to thumbnail
    //   "fade"
    //   "zoom-in-out"
    //
    animationEffect : "zoom",

    // 打開/關閉動畫使用的時間，ms
    animationDuration : 500,

    // 圖片縮放時是夠改變透明度
  	// 如果透明度為'auto'，那么圖片和縮略圖比例不一致時透明度將會發生改變
    zoomOpacity : "auto",

    // 滑塊動畫
    //
    // 可用的值:
    //   false            - disable
    //   "fade'
    //   "slide'
    //   "circular'
    //   "tube'
    //   "zoom-in-out'
    //   "rotate'
    //
    transitionEffect : "fade",

    // 動畫持續時間，ms
    transitionDuration : 366,

    // 自定義的滑塊的 class 值
    slideClass : '',

    // 自定義的布局的 class 值
    baseClass : '',

    // 布局的模板
    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-wrap"><div class="fancybox-caption"></div></div>' +
            '</div>' +
        '</div>',

    // 加載中時的模板
    spinnerTpl : '<div class="fancybox-loading"></div>',

    // 錯誤時的模板
    errorTpl : '<div class="fancybox-error"><p>{{ERROR}}<p></div>',

    btnTpl : {

        download : '<a download data-fancybox-download class="fancybox-button fancybox-button--download" title="{{DOWNLOAD}}">' +
                    '<svg viewBox="0 0 40 40">' +
                        '<path d="M20,23 L20,8 L20,23 L13,16 L20,23 L27,16 L20,23 M26,28 L13,28 L27,28 L14,28" />' +
                    '</svg>' +
                '</a>',

        zoom : '<button data-fancybox-zoom class="fancybox-button fancybox-button--zoom" title="{{ZOOM}}">' +
                    '<svg viewBox="0 0 40 40">' +
                        '<path d="M 18,17 m-8,0 a 8,8 0 1,0 16,0 a 8,8 0 1,0 -16,0 M25,23 L31,29 L25,23" />' +
                    '</svg>' +
                '</button>',

        close : '<button data-fancybox-close class="fancybox-button fancybox-button--close" title="{{CLOSE}}">' +
                    '<svg viewBox="0 0 40 40">' +
                        '<path d="M10,10 L30,30 M30,10 L10,30" />' +
                    '</svg>' +
                '</button>',

      	// 如果'smallBtn'沒有設置為 false，默認關閉按鈕將會被放置在你的 html/inline/ajax 內容中
        smallBtn   : '<button data-fancybox-close class="fancybox-close-small" title="{{CLOSE}}"></button>',

        // 箭頭
        arrowLeft : '<button data-fancybox-prev class="fancybox-button fancybox-button--arrow_left" title="{{PREV}}">' +
                        '<svg viewBox="0 0 40 40">' +
                          '<path d="M10,20 L30,20 L10,20 L18,28 L10,20 L18,12 L10,20"></path>' +
                        '</svg>' +
                      '</button>',

        arrowRight : '<button data-fancybox-next class="fancybox-button fancybox-button--arrow_right" title="{{NEXT}}">' +
                      '<svg viewBox="0 0 40 40">' +
                        '<path d="M30,20 L10,20 L30,20 L22,28 L30,20 L22,12 L30,20"></path>' +
                      '</svg>' +
                    '</button>'
    },

    // 模態框放置在哪個節點中
    parentEl : 'body',


    // 焦點處理
    // ==============

    // 打開后焦點在第一個支持焦點的元素上
    autoFocus : false,

    // 關閉后焦點回到 active 的元素上
    backFocus : true,

    // 不讓用戶焦點放在模態框外的內容中
    trapFocus : true,


    // 模態框配置
    // =======================

    fullScreen : {
        autoStart : false,
    },

    // 設置 `touch: false` 來禁止拖拽/手指滑動
    touch : {
        vertical : true,  // 允許垂直方向拖拽
        momentum : true   // Continue movement after releasing mouse/touch when panning
    },

    // 手動初始化時的 hash 值,
    // 設為 `false` 不改變 hash 
    hash : null,

    // 自定義或者添加媒體類型
    // 例如:
    /*
    media : {
        youtube : {
            params : {
                autoplay : 0
            }
        }
    }
    */
    media : {},

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

    thumbs : {
        autoStart   : false,                  // 打開的時候展示縮略圖
        hideOnClose : true,                   // 關閉動畫開始時隱藏縮略圖輪廓
        parentEl    : '.fancybox-container',  // Container is injected into this element
        axis        : 'y'                     // 垂直 (y) or 水平 (x) 滾動
    },

    // 使用鼠標滾輪來瀏覽相冊
    // 設為 'auto' - 只對圖片啟用
    wheel : 'auto',

    // 毀掉函數
    //==========

    // 更多信息請查看 API
    // 例如:
    /*
        afterShow: function( instance, current ) {
             console.info( 'Clicked element:' );
             console.info( current.opts.$orig );
        }
    */

    onInit       : $.noop,  // 實例初始化完成

    beforeLoad   : $.noop,  // 側欄的內容正在被加載
    afterLoad    : $.noop,  // 側欄的內容加載完成后

    beforeShow   : $.noop,  // 打開動畫開始前
    afterShow    : $.noop,  // 內容加載完成，進行動畫的時候

    beforeClose  : $.noop,  // 實例準備關閉的時候，返回 false 值取消關閉
    afterClose   : $.noop,  // 實例關閉后

    onActivate   : $.noop,  // 實例激活的時候
    onDeactivate : $.noop,  // 其他實例被激活的時候


    // 交互
    // ===========

    // 使用一下選項自定義用戶單擊雙擊等事件
    // 每個選項可以是字符串，或者有返回值的方法
    //
    // 可用的值:
    //   "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

    // 內容被點擊
    clickContent : function( current, event ) {
        return current.type === 'image' ? 'zoom' : false;
    },

    // 側邊欄被點擊
    clickSlide : 'close',

    // 點擊模態框外的北京時
    clickOutside : 'close',

    // 同之前的兩個一樣，只是是雙擊的時候
    dblclickContent : false,
    dblclickSlide   : false,
    dblclickOutside : false,


    // 移動端事件
    // =============================================

    mobile : {
        idleTime : false,
        margin   : 0,

        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;
        }
    },


    // 國際化
    // ============

    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'
        }
    }

};

通過傳入?fancybox?方法一個對象來設置一個實例：

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

可以通過?$.fancybox.defaults?命名空間修改 fancyBox 的默認選項：

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

對于單獨的元素可以通過?data-options?屬性進行自定義。這個屬性值要求JSON格式的對象：

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

7. API

API 提供了一系列的方法來控制 fancyBox。這些方法幫助你擴展插件，整合到其他的 web 應用中。

7.1 核心方法

操作實例的核心方法：

// 只關閉當前 active 狀態或者所有的 fancyBox 實例
$.fancybox.close( true );

// 打開 fancyBox
$.fancybox.open( items, opts, index );

通過 jQuery 將相冊中的元素變為 jQuery 對象或者包含純對象的數組，進行更多操作如創建定義點擊事件。

var $links = $('.fancybox');

$links.on('click', function() {

	$.fancybox.open( $links, {
		// 自定義內容
	}, $links.index( this ) );

	return false;
});

手動創建一組對象時，組內元素應該遵循以下規則：

{
  	src  : '' // 資源
	type : '' // 類型: image|inline|ajax|iframe|html (optional)
	opts : {} // 選項 (optional)
}

下面是一個通過 JavaScrip t打開相冊的例子：

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

fancyBox 允許只傳一個對象。打開行內元素的例子：

$.fancybox.open({
	src  : '#hidden-content',
	type : 'inline',
	opts : {
		afterShow : function( instance, current ) {
			console.info( 'done!' );
		}
	}
});
// 譯者注：行內元素如下
<div id="#hidden-content">
  <p>...content</p>
</div>

7.2 實例的方法

你需要定義一個實例來使用實例的方法。

var instance = $.fancybox.open(
	// 內容和選項
);

從當前 active 的實例中獲取信息：

var instance = $.fancybox.getInstance();

回調函數的第一個參數返回實例信息：

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

實例可以調用以下方法：

// 跳到下一個相冊元素
instance.next( duration );

//跳到上一個相冊元素
instance.previous( duration );

// 調到選中的相冊元素
instance.jumpTo( index, duration );

// 檢測當前尺寸是否小于實際尺寸
instance.isScaledDown();

// 縮放到實際尺寸
instance.scaleToActual( x, y, duration );

// 檢測尺寸是否超過父元素
instance.canPan();

// 縮放適應父元素尺寸
instance.scaleToFit( duration );

// 更新滑塊的內容和位置
instance.update();

// 更新側邊欄的位置， 縮放內容來適應
instance.updateSlide( slide );

// 更新 infobar 的值， 導航按鈕的狀態， 和展示標題
instance.updateControls( force );

// 在側邊欄中加載自定義內容
instance.setContent( slide, content );

// 在側邊欄中加載loading效果
instance.showLoading( slide );

// 從側邊欄中去除loading效果
instance.hideLoading( slide );

// 找到和把焦點放在第一個可以放置焦點的元素
instance.focus();

// 激活當前 active 的實例，顯示在最前面
instance.activate();

// 關閉實例
instance.close();

7.3 事件

fancyBox 支持觸發以下事件：

beforeLoad   : 滑塊的內容加載前
afterLoad    : 滑塊內容加載后

beforeShow   : 打開動畫開始前
afterShow    : 內容或者動畫加載完成

beforeClose  : 實例準備關閉前，染回`false`取消關閉
afterClose   : 實例關閉后

onInit       : 實例初始化完成
onActivate   : 實例active狀態
onDeactivate : 其他實例變為active狀態

事件可以作為一個對象的函數屬性，該對象作為參數傳入到 fancyBox 初始化方法中：

<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>

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

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

// 自定義、添加新的媒體類型
// 例如:
/*
media : {
	youtube : {
		params : {
			autoplay : 0
		}
	}
}
*/
media : {},

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

thumbs : {
	autoStart   : false,                  // 打開時顯示縮略圖
	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
}

Example (show thumbnails on start):

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

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

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

可使用的方法列表：

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();

如果你想禁止 hash 模塊，使用下面代碼片段（引用 JS 之后）：